Connection Properties

NuoDB supports 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
autoCommitSPMode=
[ 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.
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.
ConnectionKey=string When the load balancer policy being used is ChainableModBalancer (the default load balancer), the Broker processes the string specified by the ConnectionKey property to choose the Transaction Engine (TE) to route the client connection request to. You do not control which TE the broker chooses. However, as long as the set of TEs that serves the database remains the same (none are added and none are terminated), the same connection key causes the Broker to direct the client connection to the same TE. See Balancing Database Load Across Hosts for more information.
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.
isolation=level The default transaction isolation level for the connection to use. See Supported Transaction Isolation Levels.
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.
LBReq=group

When the value of the balancer host property contains ChainableReqGroupBalancer, this connection property directs connection requests to transaction engines that are in the process group specified. Process groups are defined in the database's template. See Balancing Database Load Across Hosts.

If the chainableReqGroupBalancerPropName host property is set to the name of a process group, that setting overrides the LBReq connection property. See Host Properties (default.properties).

LBTag=value When the value of the balancer host property contains ChainableTagBalancer, this connection property directs all client connection requests to TEs on hosts whose LBTag host tag is set to the value specified by the LBTag connection property. 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.

NodeKey=number When the load balancer policy being used is ChainableModBalancer (the default load balancer), the Broker processes the number specified by the NodeKey property to choose the transaction engine to route the client connection to. You do not control which TE the Broker chooses. However, as long as the set of TEs that serves the database remains the same, the same node key causes the Broker to direct the client connection to the same TE. See Balancing Database Load Across Hosts for more information.
password=pwd The password for the user account used to connect to the database.

rollbackMode=
[ 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.
user=name The user name for connecting to the database.