JDBC Driver for SQL Server

Build 20.0.7587

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.
Application IntentThe application intent connection string property expresses the client application's request to be directed either to a read-write or read-only version of an availability group database. To use read-only routing, a client must use an application intent of read-only in the connection string when connecting to the availability group listener. Without the read-only application intent, connections to the availability group listener are directed to the database on the primary replica.
Application NameThe application name connection string property expresses the client application's name.
Auth SchemeThe scheme used for authentication. Accepted entries are Password, NTLM, Kerberos, AzurePassword, AzureAD, AzureMSI.
Azure TenantThe Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.
Batch SizeThe maximum size of each batch operation to submit.
Callback URLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Connection Life TimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Connect On OpenThis property species whether to connect to the SQL Server when the connection is opened.
DatabaseThe name of the SQL Server database.
DomainThe name of the domain for a Windows (NTLM) security login.
EncryptThis field sets whether SSL is enabled.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Integrated SecurityWhether or not to authenticate with Windows Integrated Security.
Kerberos KDCThe Kerberos Key Distribution Center (KDC) service used to authenticate the user.
Kerberos RealmThe Kerberos Realm used to authenticate the user with.
Kerberos SPNThe Service Principal Name for the Kerberos Domain Controller.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Max Log File CountA string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File SizeA string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max RowsLimits 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.
NTLM VersionThe NTLM version.
OAuth Access TokenThe access token for connecting using OAuth.
OAuth Client IdThe client ID assigned when you register your application with an OAuth authorization server.
OAuth Client SecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuth Expires InThe lifetime in seconds of the OAuth AccessToken.
OAuth Refresh TokenThe OAuth refresh token for the corresponding OAuth access token.
OAuth Settings LocationThe 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://.
OAuth Token TimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.
OAuth VerifierThe verifier code returned from the OAuth authorization URL.
OtherThese hidden properties are used only in specific use cases.
PasswordThe password used to authenticate the user.
Pool Idle TimeoutThe allowed idle time for a connection before it is closed.
Pool Max SizeThe maximum connections in the pool.
Pool Min SizeThe minimum number of connections in the pool.
Pool Wait TimeThe max seconds to wait for an available connection.
PortThe port of the MS SQL Server.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis 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.
Proxy ExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Query PassthroughThis option passes the query to the SQL Server server as is.
ReadonlyYou can use this property to enforce read-only access to SQL Server from the provider.
RTKThe runtime key used for licensing.
ServerThe name of the server running SQL Server.
SSL Client CertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSL Client Cert PasswordThe password for the TLS/SSL client certificate.
SSL Client Cert SubjectThe subject of the TLS/SSL client certificate.
SSL Client Cert TypeThe type of key store containing the TLS/SSL client certificate.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
TimeoutA timeout for the provider.
Use Connection PoolingThis property enables connection pooling.
UserThe SQL Server user account used to authenticate.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587