module function · N/query

runSuiteQLPaged()

query.runSuiteQLPaged(options)

Runs an arbitrary SuiteQL query as a paged query.

Implementation
Not started
Design
Open for proposals suggest how it should read
Proposals
A
Signature
query.runSuiteQLPaged(options)
Module
N/query
Returns
query.PagedData
Governance
10 units
Script types
Client and server scripts
Version
SuiteScript 2.x, documented for 2.1; since NetSuite 2020.1
call shapefrom Oracle's parameter table
1query.runSuiteQLPaged({2    query:          /* string, required */,3    params:         /* <string | number | >, optional */,4    pageSize:       /* number, optional */,5    customScriptId: /* string, optional */6});
Oracle reference for this method
ParameterTypeRequiredDescription
options.querystringrequiredThe string representation of the SuiteQL query to run.
options.params<string | number | >optionalThe parameters to use in the SuiteQL query.
options.pageSizenumberoptionalThe size of each page in the query results. The default value is 50 results per page. The minimum page size is 5 results per page, and the maximum page size is 1000 results per page.
options.customScriptIdstringoptionalA 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.
B

No Mynt syntax yet.

Nothing in the language compiles to query.runSuiteQLPaged(options) today. How should it read?

C

Competing syntax for runSuiteQLPaged, from GitHub Discussions. Select two or more to compare them side by side.

All discussions

Loading proposals from GitHub…

D

Write the Mynt you wish you could write.

A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.

  • Clarity. Does it say what happens, without ceremony?
  • Consistency. Does it read like load, save and Ref[field]?
  • Expressiveness. Does it cover the cases people actually write?
  • Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?

N/query · query.runSuiteQLPaged(options)

Suggest syntax for runSuiteQLPaged