Column Object Members

The query.Column object in SuiteScript provides crucial members for defining query result columns in NetSuite. Understanding these members is essential for developers who want to effectively retrieve and manipulate data through queries.

What Are Column Object Members?

Column object members allow you to customize query definitions significantly. Each member of a query.Column provides different capabilities, enhancing how data is aggregated, displayed, and managed within your scripts.

Column Object Members

The following table summarizes the members available for a query.Column object:

How to Create Columns

To create columns in your queries, you can utilize the following methods:

• Use Query.createColumn(options) to create a column in a standard query definition.
• Use Component.createColumn(options) for columns in join relationships created with Query.autoJoin(options) or Component.autoJoin(options).

It is essential to assign all created columns to the Query.columns property to ensure they are recognized during execution.

Example Syntax

Here’s a basic example of how to define a query and utilize column members:

1var myCustomerQuery = query.create({
2    type: query.Type.CUSTOMER
3});
4var myAggColumn = myCustomerQuery.createColumn({
5    fieldId: 'amount',
6    aggregate: query.Aggregate.AVERAGE
7});
8myCustomerQuery.columns = [myAggColumn];
9var theAggregate = myAggColumn.aggregate;

Important Note

Including at least one query.Column in your query definition is critical to avoid scripting errors. Although it is an optional parameter when using the query.create(options) method, a Column object must be present for each query definition.

Who This Affects

This content is particularly relevant for:

• Developers: Implement and manage queries effectively.
• Administrators: Understand how to customize and extend data retrieval processes in NetSuite.

Key Takeaways

• The query.Column object is vital for querying data in SuiteScript.
• Multiple members provide functionalities for aggregation, aliases, and data context.
• Properly defining columns helps in error prevention and enhances query performance.