JDBC Driver for NetSuite

Build 21.0.8137

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.


AuthSchemeThe type of authentication to use when connecting to NetSuite.
AccountIdThe company account your username is associated with on NetSuite.
RoleIdThe RoleId is the InternalId of the role that will be used to log in to NetSuite. Leave empty to use the user's default role.
UserThe user of the NetSuite account used to authenticate.
PasswordThe password of the NetSuite user used to authenticate.
VersionThe version of the NetSuite API in usage. Defaults to 2021_2.
IncludeChildTablesA boolean indicating if child tables should be displayed.
NetsuiteMetadataFolderA path to a directory to download metadata files from NetSuite. Set this for best performance.


InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthVersionThe version of OAuth being used.
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessTokenThe access token for connecting using OAuth.
OAuthAccessTokenSecretThe OAuth access token secret for connecting using OAuth.
OAuthSettingsLocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
CallbackURLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
ScopeSpecify scope to obtain the initial access and refresh token with OAuth 2.0.
OAuthVerifierThe verifier code returned from the OAuth authorization URL.
AuthTokenThe authentication token used to request and obtain the OAuth Access Token.
AuthKeyThe authentication secret used to request and obtain the OAuth Access Token.
OAuthRefreshTokenThe OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresInThe lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.


SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.


FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.


ProxyAutoDetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .


LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.


LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
SchemaThe type of schema to use.
RowScanDepthThe number of rows to scan when dynamically determining columns for the table.


AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheDriverThe database driver to be used to cache data.
CacheConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.


AggregateColumnModeIndicating how aggregate columns should be treated.
ApplicationIdAs of version 2020.1, requests to NetSuite require an application ID.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpenThis property specifies whether to connect to the NetSuite when the connection is opened.
CustomFieldPermissionsA comma separated list of custom field permissions. Gives more control than IncludeCustomFieldColumns .
IncludeCustomFieldColumnsA boolean indicating if you would like to include custom field columns.
IncludeCustomListTablesA boolean indicating if you would like to use tables based on custom lists.
IncludeCustomRecordTablesA boolean indicating if you would like to use tables based on custom record types.
IncludeReferenceColumnsA comma separated list representing the columns to include when retrieving data from a field representing a record reference.
MaximumConcurrentSessionsThe maximum number of concurrent sessions available for use in the connection.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
NetsuiteDateFormatThe preffered date format set in NetSuite UI.
NetsuiteLongDateFormatThe preffered long date format set in NetSuite UI.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe number of results to return per page from NetSuite.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to NetSuite from the provider.
ReportDoublesAsDecimalIndicates if doubles should be reported as decimal.
RequestMemorizedTransactionsA boolean indicating if you would like to request memorized transactions when retrieving transactions from NetSuite.
RTKThe runtime key used for licensing.
SupportEnhancedSQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UseAsyncServicesA boolean indicating if you would like to use asynchronous services when inserting, updating, and deleting.
UseConnectionPoolingThis property enables connection pooling.
UseInternalNamesForCustomizationsA boolean indicating if you would like to use internal names for customizations.
UserTimezoneOffsetYour user timezone offset as defined in your NetSuite preferences under Home --> Preferences --> Time Zone. Ex: EST.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.
UseUpsertsA boolean indicating if you would like to perform an upsert when an insert operation is used.
WebServiceHostAn optional override for the web service host such as webservices.na1.netsuite.com.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137