Query.name

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

The name of the query definition.

This property has a value only for existing queries that are loaded using query.load(options). If you create a query using query.create(options) but do not save it, this property is null.

Important:

The N/query module lets you create and run queries using the SuiteAnalytics Workbook query engine. You can use the N/query module to load and delete existing queries, but you cannot save queries. You can save queries using the SuiteAnalytics Workbook interface. For more information, see Navigating SuiteAnalytics Workbook.

Type

string (read-only)

Module

N/query Module

Parent Object

query.Query

Sibling Object Members

Query Object Members

Since

2018.1

Syntax

Important:

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
...
var myLoadedQuery = query.load({ id: 'custworkbook237'
}); var theName = myLoadedQuery.name;
...
// Add additional code

Syntax

Related Topics