sql server connection properties
This is list of properties that are compatible with SQL server.
They are inside given data source configuration file. For example: sqlserverTest-source_1.conf These properties are saved in this format there:
"properties": {
"ApplicationName": "testApp",
"testQuery": "SELECT 1",
"defaultCatalog": "test",
"url": "jdbc:sqlserver://localhost:1433/databaseName=${database}"
},
⚠️ Note: You can use SHIFT with mouse scroll to scroll horizontally!
| Key | Description | Possible values | Default |
|---|---|---|---|
| databaseName | The name of the database to connect to. | String <=128 char | null |
| serverName | The computer running SQL Server. | String | null |
| portNumber | The TCP port where an instance of SQL Server is listening. | Integer (0 - 65535) | 1433 |
| connectTimeout | The number of milliseconds a connect is allowed to take | Integer | 15 |
| serverSpn | SQL Server SPN in v5.0+ | String | |
| columnEncryptionSetting | The column encryption setting. | String (Enabled, Disabled ) | Disabled |
| serverNameAsACE | Translates the serverName from Unicode to ASCII Compatible Encoding (ACE), as defined by the ToASCII operation of RFC 3490. | Boolean | false |
| sendStringParametersAsUnicode | Determines if the string parameters are sent to the server as Unicode or the database's character set. | Boolean | true |
| multiSubnetFailover | Indicates that the application is connecting to the Availability Group Listener of an Availability Group or Failover Cluster Instance. | String (yes, no, true, false, 1, 0) | false |
| applicationName | The application name for SQL Server profiling and logging tools. | String <=128 char | null |
| lastUpdateCount | Ensures that only the last update count is returned from an SQL statement passed to the server. | Boolean | true |
| disableStatementPooling | Disables the statement pooling feature. | Boolean | true |
| integratedSecurity | Indicates whether Windows authentication will be used to connect to SQL Server. | Boolean | false |
| authenticationScheme | The authentication scheme to be used for integrated authentication. Possible values are JavaKerberos, NativeAuthentication, NTML. | String (avaKerberos, NativeAuthentication, NTML) | NativeAuthentication |
| lockTimeout | The number of milliseconds to wait before the database reports a lock time-out. | Integer (0 = no wait) | -1 (wait indefinitely) |
| loginTimeout | The number of seconds the driver should wait before timing out a failed connection. Default is 30 (version 11.2 and up), 15 (version 10.2 and below). | Integer (0 - 65535) | 30 / 15 ( see desc.) |
| instanceName | The name of the SQL Server instance to connect to. | String <=128 char | null |
| xopenStates | Determines if the driver returns XOPEN-compliant SQL state codes in exceptions. The default is to return SQL 99 state codes. | Boolean | false |
| selectMethod | Enables the application to use server cursors to process forward only, read only result sets. | String (direct, cursor) | direct |
| applicationIntent | Declares the application workload type when connecting to a server. Possible values are ReadOnly and ReadWrite. | String (ReadOnly, ReadWrite) | ReadWrite |
| workstationID | The host name of the workstation. | String <=128 char | |
| failoverPartner | The name of the failover server used in a database mirroring configuration. | String | null |
| packetSize | The network packet size used to communicate with SQL Server. Meaning of: -1 = server's default packet size. 0 = MAX (32767). Important: Using the packetSize property when the encryption is enabled (encrypt=true) isn't recommended. | Integer (-1, 0, 512..32767) | 8000 |
| encrypt | Determines if Secure Sockets Layer (SSL) encryption should be used between the client and the server. The default value is "true" in version 10.2 and later and "false" in 9.4 and earlier. | String | true, false (see desc.) |
| trustServerCertificate | Determines if the driver should validate the SQL Server Secure Sockets Layer (SSL) certificate. | Boolean | false |
| trustStoreType | Type of trust store type like JKS / PKCS12 or any FIPS Provider KeyStore implementation Type. | String | JKS |
| trustStore | The path to the certificate trust store file. | String | null |
| trustStorePassword | The password used to check the integrity of the trust store data. | String | null |
| hostNameInCertificate | The host name to be used when validating the SQL Server Secure Sockets Layer (SSL) certificate. | String | null |
| sendTimeAsDatetime | Determines whether to use the SQL Server datetime data type to send java.sql.Time values to the database. | Boolean | true |
| transparentNetworkIPResolution | Determines whether to use the Transparent Network IP Resolution feature. false when: Connecting to Azure SQL Database where the data source ends with: .database.chinacloudapi.cn or .database.usgovcloudapi.net or .database.cloudapi.de or .database.windows.net or .database.fabric.microsoft.com or Authentication is 'Active Directory Password' or 'Active Directory Integrated' | String (true, false, yes, or no) | true, false (see desc.) |
| queryTimeout | Sets the default query timeout value, set by Heimdall via the setQueryTimeout method | Integer ( -1 and 0 = wait indefinitely ) | -1 (infinite timeout) |
| socketTimeout | The number of milliseconds to wait before the java.net.SocketTimeoutException is raised. | Integer | 0 |
| serverPreparedStatementDiscardThreshold | The threshold for when to close discarded prepare statements on the server (calling a batch of sp_unprepares). A value of 1 or less will cause sp_unprepare to be called immediately on PreparedStatment close. | Integer | 10 |
| enablePrepareOnFirstPreparedStatementCall | This setting specifies whether a prepared statement is prepared (sp_prepexec) on first use (property=true) or on second after first calling sp_executesql (property=false). | Boolean | - |
| gsscredential | Impersonated GSS Credential to access SQL Server. | org.ietf.jgss.GSSCredential | null |
| authentication | The authentication to use. Possible values are ActiveDirectoryIntegrated, ActiveDirectoryPassword, ActiveDirectoryManagedIdentity (version 12.2+), ActiveDirectoryMSI (version 7.2+), ActiveDirectoryInteractive (version 9.2+), ActiveDirectoryServicePrincipal (version 9.2+), SqlPassword, and the default NotSpecified. | String | NotSpecified |
| accessToken | The access token to use for Azure Active Directory. | String | null |
| keyStoreAuthentication | The name that identifies a key store. | String | null |
| keyStoreSecret | The authentication secret or information needed to locate the secret. | String | null |
| keyStoreLocation | The key store location. | String | null |
| fipsProvider | FIPS Provider. Removed in versions >= 6.4.0. | String | null |
| fips | Determines if enable FIPS compilant SSL connection between the client and the server. | Boolean | false |
| jaasConfigurationName | Login configuration file for Kerberos authentication. (Version 6.2+) Each connection to SQL Server can use its own JAAS Login Configuration name to establish a Kerberos connection. | String | SQLJDBCDriver |
| hdParseSP | Parse SQL Server stored procedures to build rules necessary for proper functions | Boolean | - |