N/query

Create and run queries using the SuiteAnalytics Workbook query process.

Oracle reference

1 of 36 methods have Mynt syntax 3%

1 implemented0 in progress0 planned0 under consideration35 open for proposals

Module functions

  1. query.create(options) Creates the query definition. query T where ... Implemented ·
  2. query.createPeriod(options) Creates a query.Period object that represents a period of time. Open for proposals ·
  3. query.createRelativeDate(options) Creates a query.RelativeDate object that represents a date relative to the current date. Open for proposals ·
  4. query.delete(options) Deletes an existing query that was created using the SuiteAnalytics Workbook UI. Open for proposals ·
  5. query.listTables(options) Lists the table view objects that are included in a workbook in SuiteAnalytics Workbook. Open for proposals ·
  6. query.load(options) Loads an existing query that was created using the SuiteAnalytics Workbook UI. Open for proposals ·
  7. query.runSuiteQL(options) Runs an arbitrary SuiteQL query. Open for proposals ·
  8. query.runSuiteQLPaged(options) Runs an arbitrary SuiteQL query as a paged query. Open for proposals ·

Component object

  1. Component.autoJoin(options) Creates a join relationship. Open for proposals ·
  2. Component.createColumn(options) Creates a query result column based on the component. Open for proposals ·
  3. Component.createCondition(options) Creates a condition (filter column) based on the component. Open for proposals ·
  4. Component.createSort(options) Creates a sort based on the component. Open for proposals ·
  5. Component.join(options) Creates a join relationship. Open for proposals ·
  6. Component.joinFrom(options) Creates an explicit directional join relationship from another component to this component (an inverse join). Open for proposals ·
  7. Component.joinTo(options) Creates an explicit directional join relationship to another component from this component (a join). Open for proposals ·

PagedData object

  1. PagedData.iterator() Standard SuiteScript 2.0 object for iterating through results. Open for proposals ·
  2. PagedData.fetch(options) Retrieves a page in the set of pages included in the PagedData object. inside query T Open for proposals ·

Query object

  1. Query.and(conditions) Creates a new condition (a query.Condition object) that corresponds to a logical conjunction (AND) of the arguments passed to the method. inside query T Open for proposals ·
  2. Query.autoJoin(options) Creates a join relationship. Open for proposals ·
  3. Query.createColumn(options) Creates a query result column based on the query.Query object. inside query T Open for proposals ·
  4. Query.createCondition(options) Creates a condition (filter column) based on the query.Query object. inside query T Open for proposals ·
  5. Query.createSort(options) Creates a sort based on the query.Query object. inside query T Open for proposals ·
  6. Query.join(options) Creates a join relationship. Open for proposals ·
  7. Query.joinFrom(options) Creates an explicit directional join relationship from another component to the root component of the search definition (an inverse join). Open for proposals ·
  8. Query.joinTo(options) Creates an explicit directional join relationship to another component from this component (a forward join). Open for proposals ·
  9. Query.not(condition) Creates a new condition (a query.Condition object) that corresponds to a logical negation (NOT) of the argument passed to the method. inside query T Open for proposals ·
  10. Query.or(conditions) Creates a new condition (a query.Condition object) that corresponds to a logical disjunction (OR) of the arguments passed to the method. inside query T Open for proposals ·
  11. Query.run(options) Executes the query and returns the query result set. Open for proposals ·
  12. Query.runPaged(options) Executes the query and returns a set of paged results. inside query T Open for proposals ·
  13. Query.toSuiteQL() Converts this query.Query object to its corresponding SuiteQL representation. Open for proposals ·

Result object

  1. Result.asMap() Returns the query result as an object with the columns mapped to the result values. inside query T Open for proposals ·
  2. Result.getValue(options) Gets the value at a given index in Result.values . Open for proposals ·

ResultSet object

  1. ResultSet.asMappedResults() Returns a query result set as an array of mapped results. Open for proposals ·
  2. ResultSet.iterator() Standard SuiteScript 2.0 object for iterating through results. Open for proposals ·

SuiteQL object

  1. SuiteQL.run() Runs the SuiteQL query and returns the query results. Open for proposals ·
  2. SuiteQL.runPaged(options) Runs the SuiteQL query as a paged query and returns the paged query results. Open for proposals ·