Suite Codex

Modules

SuiteScript N/query Module

Using N/query Module

SuiteScript N/query module runs SuiteQL queries for analytics.

Introduction to SuiteScript N/query Module

The N/query module is a part of SuiteScript that allows developers to create and run SuiteQL queries. SuiteQL is a SQL-like query language tailored specifically for NetSuite, enabling powerful analytics and data retrieval capabilities. This module is essential for developers looking to perform complex data operations within their NetSuite environments.

Setting Up the N/query Module

To use the N/query module, you need to load it in your SuiteScript file. This is done using the require function in SuiteScript 2.0. Here is how you can set it up:

Creating a Basic SuiteQL Query

Creating a basic SuiteQL query involves using the query.runSuiteQL method. This method allows you to execute a raw SQL query and get the results. Here is a simple example of how to retrieve data from the customer table:

Understanding Query Results

The results of a SuiteQL query can be accessed in different formats. The asMappedResults method returns an array of objects where each object represents a row and each key-value pair represents a column and its value. You can also access results as an array of arrays using the asResults method.

Handling Errors in Queries

When working with the N/query module, it's important to handle errors gracefully. You can use try-catch blocks to handle exceptions that might occur during query execution. Here's an example:

Best Practices for Using N/query Module

  • Optimize Your Queries: Ensure your SQL queries are efficient to avoid performance issues.
  • Use Parameters: Use query parameters to prevent SQL injection and improve query security.
  • Limit Data Retrieval: Use LIMIT and OFFSET clauses to manage the amount of data retrieved.
  • Test Queries: Test your queries thoroughly in a sandbox environment before deploying them live.

Modules

Next
N/http Module