Connection Properties

Physical (and VMware) deployments of NuoDB (being managed by NuoDB AdminAn interface for domain and database management. Introduced in NuoDB 4.0 to supersede NuoAgent, this interface is used to manage an admin domain. Use NuoDB Admin instead of NuoAgent to start and stop APs. When using NuoDB Admin to manage a domain and its databases, use NuoDB Command (nuocmd) instead of the NuoDB Manager (nuodbmgr) Command Line Interface (CLI) tool. See also Admin Process (AP).) support a number of properties you can use to configure driver behavior specific to NuoDB. These properties may be defined in a number of ways including:

Name Value
Allows the driver to fall back to SRP if the TLS connection fails (when used in combination with trustStore ). Required during rolling upgrade of the security protocol.
[ on | off ]
Controls the behavior of auto commit for the execution of DML SQL statements inside a stored procedure only. The default setting is off. See About Implicit and Explicit Transactions.


Enables the client to provide one or more appropriate ciphers for encrypting the network connection to the database. If this property is not specified the default list AES-256-CTR,RC4 is used. The server chooses a preferred cipher from this list. If no matching cipher is found, the connection will be refused. The cipherlist is comma-separated. Cipher names are case-sensitive and must be provided exactly as shown. The full list of available ciphers are AES-256-CTR, RC4, and None.
clientInfo=info Arbitrary information about the connecting client. This is available in the CLIENTINFO column of the SYSTEM.CONNECTIONS and SYSTEM.LOCALCONNECTIONS system tables.
clientProcessID=id The process ID (pid) of the connecting client. The client may set this property only if not already set by the driver. The .NET and Python drivers set this for the client. The client setting of this property does not override the driver setting of this property. The clientProcessId is then available in the CLIENTPROCESSID column of the SYSTEM.CONNECTIONS and SYSTEM.LOCALCONNECTIONS system tables.
direct=boolean This property supports SSH tunneling. Without being specified, direct defaults to false. When direct=true, the client connection is made directly with TE. This enables a connection string to be set up in DbVisualizer (or similar tool) based on the tunnel you have set up to a specific TE. This only works for JDBC and its functionality is deprecated. Use LBTag and the ChainableTagBalancer instead.
idle-timeout=number The maximum time (in seconds) which indicates how long idle connections are left open. Although the IDLE_CONNECTION_TIMEOUT system property is a global setting for timing out idle connections, you can use this connection property to override the system property on a per connection basis. By default, idle-timeout is set to -1, meaning that the global setting is used. If you set a value greater than 0, this property overrides any value set for IDLE_CONNECTION_TIMEOUT. You may also set a value of 0 to specifically disable this property for the connection. Any time a client connection is terminated for being idle for too long, a message will be logged under the net category.

For more information on IDLE_CONNECTION_TIMEOUT, see SQL System Properties.

isolation=level The default transaction isolation level for the connection to use. Isolation levels supported are consistent_read and read_committed. Note that these values are case insensitive. For more information, see CONSISTENT READ and READ COMMITTED.
LBPolicy=valueA From the client application, this property allows selective load balancing across Transaction Engines. For information on using LBPolicy, see Load Balancer Policies.
LBQuery=<selector>(<filter>) From the client application, this property allows selective load balancing across Transaction Engines. For information on using LBQuery, see Load Balancer Policies.
LBRegion=region When the value of the balancer host property contains ChainableRegionBalancer, this connection property directs connection requests to TEs that are in the region specified. See Balancing Database Load Across Hosts for more information.
lobChunkingEnabled=boolean (JDBC only) If set to false, disables BLOB and CLOB streaming to the JDBC client. Default is true.
lobChunkSize=size (JDBC only) Overrides the default chunk size for BLOB and CLOB streaming. The default is 65536 bytes.
memory-limit-bytes The memory limit (per connection) in bytes for all blocking SQL engine operations - hash-grouping, sorting, sorting via priority queue for limit, distinct (via hash-grouping), union, listagg, table functions, and stored procedure returning result set that accumulate data - in main memory.

To run statements with a memory limit different from the system-wide limit, start a new connection with this connection property set to the per-connection limit.

If you do not define a value for memory-limit-bytes, the value set for the DEFAULT_CONNECTION_MEMORY_LIMIT system property is the default setting used.

Note: When the memory limit is exceeded, any query currently being executed is aborted and an error is generated.

password=pwd The password for the user account used to connect to the database.

[ procedure | 
transaction | 
off ]

Controls the behavior of transactions executed inside a stored procedure. The default is off. See About Implicit and Explicit Transactions.
schema=name The default schema that the connection should use when objects (such as tables and views) are not fully qualified.
TimeZone=timezone The default time zone for the connection to use (this is also known as the session time zone). If not specified, the application's default time zone is used.

Path to file which stores certificates from trusted entities.

(Turns on SSL/TLS, turns off SRP)

trustStorePassword=pwd Verifies the integrity of the trustsStore.
JDBC only.
user=name The user name for connecting to the database.
Verifies the DN name of the SSL server against the name presented on the certificate. The default is true.