SuiteQL.run()
Method Description |
Runs the SuiteQL query and returns the query results. You can use this method to run the SuiteQL query and obtain the results as a query.ResultSet object. If you want to run the SuiteQL query as a paged query, use SuiteQL.runPaged(options). Calling this method is equivalent to calling query.runSuiteQL(options) and passing the query.SuiteQL object as a parameter:
Note:
If the SuiteAnalytics Connect feature is enabled in your NetSuite account, there is no limit to the number of results this method can return. If the SuiteAnalytics Connect feature is not enabled, this method can return a maximum of 100,000 results. For more information about SuiteAnalytics Connect, see SuiteAnalytics Connect. For more information and examples of using SuiteQL in the N/query module, see SuiteQL in the N/query Module. For more information about SuiteQL in general, see SuiteQL. |
Returns |
|
Supported Script Types |
Client and server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
10 units |
Module |
|
Parent Object |
|
Sibling Object Members |
|
Since |
2020.1 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
string |
optional |
A unique identifier used for potential performance issues in a query. If your query produces performance issues, the custom script ID identifies where the update will need to occur. This ID can also be used as a precaution to speed up performance fixes, if necessary.
Note:
The Script ID must be unique or the performance enhancements will affect each query with the same customScriptID. |
Syntax
The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/query Module Script Samples.
// Add additional code
...
// myQuery is an existing query.Query object
var mySuiteQLQuery = myQuery.toSuiteQL();
var results = mySuiteQLQuery.run({
customScriptId: 'myCustomScriptId'
});
...
// Add additional code