JDBC Driver for Azure Synapse

Build 25.0.9434

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
CustomizeDateFormatSpecifies the text pattern the provider uses when it parses or writes DATE values.
ApplicationIntentSpecifies whether the connection requests a read-write or read-only session when connecting through an Availability Group listener.
BatchSizeSpecifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 .
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection.
ConnectOnOpenSpecifies whether the provider establishes a connection to Azure Synapse immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary.
EnableTransactionSpecifies whether the provider wraps data-modification statements in SQL transactions.
IncludeSystemSchemasSpecifies whether the provider returns objects that reside in system schemas including guest, sys, INFORMATION_SCHEMA, and any schema whose name begins with db_.
IncludeTableTypesSpecifies whether the provider retrieves the object type (table or view) for each entry it returns during metadata queries.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details.
PoolIdleTimeoutSpecifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool.
PoolMinSizeSpecifies the minimum number of connections to be maintained in the connection pool at all times.
PoolWaitTimeSpecifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned.
QueryPassthroughThis option passes the query to the Azure Synapse server as is.
ReadonlyToggles read-only access to Azure Synapse from the provider.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434