Setting the Connection Properties
The connection string properties can be specified in various ways:
As name=value properties in the connection URL when you connect by using the DriverManager class.
As name=value properties in the Properties parameter of the Connect method in the DriverManager class.
As values in the appropriate setter method of the data source of the driver. For example:
Property names are case-insensitive, and duplicate property names are resolved in the following order:
API arguments (such as user and password)
Last instance in the connection string.
In addition, unknown values are allowed for the property names, and their values are not validated by the JDBC driver for case sensitivity.
Synonyms are allowed and are resolved in order, just as duplicate property names.
The following table lists all the currently available connection string properties for the JDBC driver.
Declares the application workload type when connecting to a server. Possible values are ReadOnly and ReadWrite. For more information, see JDBC Driver Support for High Availability, Disaster Recovery.
The application name, or "Microsoft JDBC Driver for SQL Server" if no name is provided. Used to identify the specific application in various SQL Server profiling and logging tools.
Indicates which kind of integrated security you want your application to use. Possible values are JavaKerberos and the default NativeAuthentication.
When using authenticationScheme=JavaKerberos, you must specify the fully-qualified domain name (FQDN) in the serverName or serverSpn property. Otherwise, an error will occur (Server not found in Kerberos database).
For more information on using authenticationScheme, see Using Kerberos Integrated Authentication to Connect to SQL Server.
The name of the database to connect to. If not stated, a connection is made to the default database.
Only the value "true" is currently supported. If set to "false", an exception will occur.
Set to "true" to specify that the SQL Server uses Secure Sockets Layer (SSL) encryption for all the data sent between the client and the server if the server has a certificate installed. The default value is false.
The name of the failover server used in a database mirroring configuration. This property is used for an initial connection failure to the principal server; after you make the initial connection, this property is ignored. Must be used in conjunction with databaseName property.
If you specify a Virtual Network Name in the Server connection property, you cannot use database mirroring. See JDBC Driver Support for High Availability, Disaster Recovery for more information.
The host name to be used in validating the SQL Server SSL certificate.
If the hostNameInCertificate property is unspecified or set to null, the Microsoft JDBC Driver for SQL Server will use the serverName property value on the connection URL as the host name to validate the SQL Server SSL certificate.
The SQL Server instance name to connect to. When it is not specified, a connection is made to the default instance. For the case where both the instanceName and port are specified, see the notes for port.
If you specify a Virtual Network Name in the Server connection property, you cannot use instanceName connection property. See JDBC Driver Support for High Availability, Disaster Recovery for more information.
Set to "true" to indicate that Windows credentials will be used by SQL Server to authenticate the user of the application. If "true," the JDBC driver searches the local computer credential cache for credentials that have already been provided at the computer or network logon. If "false," the username and password must be supplied.
A "true" value only returns the last update count from an SQL statement passed to the server, and it can be used on single SELECT, INSERT, or DELETE statements to ignore additional update counts caused by server triggers. Setting this property to "false" causes all update counts to be returned, including those returned by server triggers.
The number of milliseconds to wait before the database reports a lock time-out. The default behavior is to wait indefinitely. If it is specified, this value is the default for all statements on the connection. Note that Statement.setQueryTimeout() can be used to set the time-out for specific statements. The value can be 0, which specifies no wait.
The number of seconds the driver should wait before timing out a failed connection. A zero value indicates that the timeout is the default system timeout, which is specified as 15 seconds by default. A non-zero value is the number of seconds the driver should wait before timing out a failed connection.
If you specify a Virtual Network Name in the Server connection property, you should specify a timeout value of three minutes or more to allow sufficient time for a failover connection to succeed. See JDBC Driver Support for High Availability, Disaster Recovery for more information.
Always specify multiSubnetFailover=true when connecting to the availability group listener of a SQL Server 2012 availability group or a SQL Server 2012 Failover Cluster Instance. multiSubnetFailover=true configures Microsoft JDBC Driver for SQL Server to provide faster detection of and connection to the (currently) active server. Possible values are true and false. See JDBC Driver Support for High Availability, Disaster Recovery for more information.
int [-1| 0 | 512..32767]
The network packet size used to communicate with SQL Server, specified in bytes. A value of -1 indicates using the server default packet size. A value of 0 indicates using the maximum value, which is 32767. If this property is set to a value outside the acceptable range, an exception will occur.
The database password.
The port where SQL Server is listening. If the port number is specified in the connection string, no request to sqlbrowser is made. When the port and instanceName are both specified, the connection is made to the specified port. However, the instanceName is validated and an error is thrown if it does not match the port.
If this property is set to "adaptive", the minimum possible data is buffered when necessary. The default mode is "adaptive".
When this property is set to "full", the entire result set is read from the server when a statement is executed.
If this property is set to "cursor," a database cursor is created for each query created on the connection for TYPE_FORWARD_ONLY and CONCUR_READ_ONLY cursors. This property is typically required only if the application generates very large result sets that cannot be fully contained in client memory. When this property is set to "cursor," only a limited number of result set rows are retained in client memory. The default behavior is that all result set rows are retained in client memory. This behavior provides the fastest performance when the application is processing all rows.
If the sendStringParametersAsUnicode property is set to "true", String parameters are sent to the server in Unicode format.
If the sendStringParametersAsUnicode property is set to “false", String parameters are sent to the server in non-Unicode format such as ASCII/MBCS instead of Unicode.
The default value for the sendStringParametersAsUnicode property is "true".
This property was added in SQL Server JDBC Driver 3.0.
When true, java.sql.Time values will be sent to the server as SQL Server datetime values.
When false, java.sql.Time values will be sent to the server as SQL Server time values.
sendTimeAsDatetime can also be modified programmatically with SQLServerDataSource.setSendTimeAsDatetime.
The default value for this property may change in a future release.
For more information about how the Microsoft JDBC Driver for SQL Server configures java.sql.Time values before sending them to the server, see Configuring How java.sql.Time Values are Sent to the Server.
The computer running SQL Server.
You can also specify the Virtual Network Name of a AlwaysOn Availability Groups availability group. See JDBC Driver Support for High Availability, Disaster Recovery for more information.
Beginning in Microsoft JDBC Driver 4.2 for SQL Server, this optional property can be used to specify the Service Principal Name (SPN) for a Java Kerberos connection. It is used in conjunction with authenticationScheme.
To specify the SPN, it can be in the form of: “MSSQLSvc/fqdn:port@REALM” where fqdn is the fully-qualified domain name, port is the port number, and REALM is the Kerberos realm of the SQL Server in upper-case letters.
Note: the @REALM is optional if the default realm of the client (as specified in the Kerberos configuration) is the same as the Kerberos realm for the SQL Server.
For more information on using serverSpn with Java Kerberos, see Using Kerberos Integrated Authentication to Connect to SQL Server.
Set to "true" to specify that the Microsoft JDBC Driver for SQL Server will not validate the SQL Server SSL certificate.
If "true", the SQL Server SSL certificate is automatically trusted when the communication layer is encrypted using SSL.
If "false", the Microsoft JDBC Driver for SQL Server will validate the server SSL certificate. If the server certificate validation fails, the driver will raise an error and terminate the connection. The default value is "false". Make sure the value passed to serverName exactly matches the Common Name (CN) or DNS name in the Subject Alternate Name in the server certificate for an SSL connection to succeed. For more information, see Understanding SSL Support.
The path (including filename) to the certificate trustStore file. The trustStore file contains the list of certificates that the client trusts.
When this property is unspecified or set to null, the driver will rely on the trust manager factory's look up rules to determine which certificate store to use.
The default SunX509 TrustManagerFactory tries to locate the trusted material in the following search order:
For more information, see the SUNX509 TrustManager Interface documentation on the Sun Microsystems Web site.
The password used to check the integrity of the trustStore data.
If the trustStore property is set but the trustStorePassword property is not set, the integrity of the trustStore is not checked.
When both trustStore and trustStorePassword properties are unspecified, the driver will use the JVM system properties, "javax.net.ssl.trustStore" and "javax.net.ssl.trustStorePassword". If the "javax.net.ssl.trustStorePassword" system property is not specified, the integrity of the trustStore is not checked.
If the trustStore property is not set but the trustStorePassword property is set, the JDBC driver will use the file specified by the "javax.net.ssl.trustStore" as a trust store and the integrity of the trust store is checked by using the specified trustStorePassword. This might be needed when the client application does not want to store the password in the JVM system property.
The database user.
The workstation ID. Used to identify the specific workstation in various SQL Server profiling and logging tools. If none is specified, the <empty string> is used.
Set to "true" to specify that the driver returns XOPEN-compliant state codes in exceptions. The default is to return SQL 99 state codes.
The Microsoft JDBC Driver for SQL Server takes the server default values for connection properties except for ANSI_DEFAULTS and IMPLICIT_TRANSACTIONS. The Microsoft JDBC Driver for SQL Server automatically sets ANSI_DEFAULTS to ON and IMPLICIT_TRANSACTIONS to OFF.