Oracle NetSuite

This documentation describes the integration of MindsDB with Oracle NetSuite using the REST Record API and SuiteQL. It lets you query NetSuite data in SQL and run SuiteQL directly when you need full control over filtering and joins.

Prerequisites

Before proceeding, ensure the following prerequisites are met:

1. Install MindsDB locally via Docker or Docker Desktop.
2. Enable Token-Based Authentication (TBA) and REST Web Services in NetSuite:
   • Setup > Company > Enable Features > SuiteCloud tab
   • Check “Token-Based Authentication” and “REST Web Services”

Connection

Establish a connection to NetSuite from MindsDB by executing the following SQL command and providing its handler name as an engine.

CREATE DATABASE netsuite_datasource
WITH
    ENGINE = 'netsuite',
    PARAMETERS = {
        "account_id": "123456_SB1",
        "consumer_key": "ck_...",
        "consumer_secret": "cs_...",
        "token_id": "token_...",
        "token_secret": "token_secret_..."
    };

Required connection parameters include the following:

• account_id: NetSuite account/realm ID (e.g. 123456_SB1)
• consumer_key: Integration consumer key
• consumer_secret: Integration consumer secret
• token_id: Access token ID
• token_secret: Access token secret

Optional connection parameters include the following:

• rest_domain: Override REST domain from Company Information (REST Web Services URL)
• record_types: Comma-separated record types to expose as tables (defaults to this list)

Token-Based Authentication setup

To create the required credentials in NetSuite:

1. Create an Integration record: Setup > Integrations > Manage Integrations > New. Enable Token-Based Authentication.
2. Create/choose a role for the integration and grant:
   • Setup > REST Web Services (Full)
   • Setup > User Access Tokens (Full)
   • Record-level permissions you will query (e.g., Transactions > Sales Order, Lists > Customers).
3. Assign that role to the user.
4. Generate an Access Token: Setup > Users/Roles > Access Tokens > New.
5. Copy the Consumer Key/Secret and Token ID/Secret.

Usage

Retrieve data from a record table:

SELECT *
FROM netsuite_datasource.salesOrder
WHERE id = 48;

REST record tables:

• Use WHERE id = ... (or internalId) to fetch a full record directly.
• Other filters are pushed down as q where possible; remaining filters are applied locally.

Run SuiteQL directly using the native query syntax (recommended for complex filters):

SELECT * FROM netsuite_datasource (
    SELECT id, tranid, total
    FROM transaction
    WHERE type = 'SalesOrd'
    FETCH NEXT 5 ROWS ONLY
);

Use the rest_domain parameter if your account uses a REST domain that differs from the default derived from account_id.

Access to both REST record tables and SuiteQL depends on the NetSuite role tied to your access token. If a query fails with 403/permission errors, ensure the role includes REST Web Services, User Access Tokens, and record-specific permissions for the tables you are querying (plus SuiteAnalytics permissions for SuiteQL).