ISQLServerDataSource Interface

Package:

com.microsoft.sqlserver.jdbc

Maven Artifact:

com.microsoft.sqlserver:mssql-jdbc:12.8.0.jre11

Implements

javax.sql.CommonDataSource

public interface ISQLServerDataSource
extends javax.sql.CommonDataSource

Provides a factory to create connections to the data source represented by this object. This interface was added in SQL Server JDBC Driver 3.0. This interface is implemented by SQLServerDataSource Class.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getAADSecurePrincipalId() Deprecated Use getUser() instead Returns the value for the connection property 'AADSecurePrincipalId'.
abstract java.lang.String	getAccessToken() Returns the access token.
abstract SQLServerAccessTokenCallback	getAccessTokenCallback() Returns a SQLServerAccessTokenCallback, the access token callback delegate.
abstract java.lang.String	getAccessTokenCallbackClass() Returns the fully qualified class name of the implementing class for SQLServerAccessTokenCallback.
abstract java.lang.String	getApplicationIntent() Returns the application intent.
abstract java.lang.String	getApplicationName() Returns the application name.
abstract java.lang.String	getAuthentication() Returns the authentication mode.
abstract boolean	getCalcBigDecimalPrecision() Sets the value for 'calcBigDecimalPrecision' property
abstract int	getCancelQueryTimeout() Returns the cancel timeout.
abstract java.lang.String	getClientCertificate() Returns client certificate path for client certificate authentication.
abstract java.lang.String	getClientKey() Returns Private key file path for client certificate authentication.
abstract java.lang.String	getColumnEncryptionSetting() Returns the Always Encrypted functionality setting for the data source object.
abstract int	getConnectRetryCount() Returns the maximum number of attempts set to reestablish a broken connection.
abstract int	getConnectRetryInterval() Returns the interval set, in seconds, between attempts to reestablish a broken connection.
abstract java.lang.String	getDatabaseName() Returns the database name.
abstract java.lang.String	getDatetimeParameterType() Returns the value of the datetimeParameterType connection property.
abstract boolean	getDelayLoadingLobs() Returns the current flag value for delayLoadingLobs.
abstract java.lang.String	getDescription() Returns a description of the data source.
abstract boolean	getDisableStatementPooling() Returns whether statement pooling is disabled.
abstract java.lang.String	getDomain() Returns the value for the connection property 'domain'.
abstract boolean	getEnablePrepareOnFirstPreparedStatementCall() Returns the value that indicates whether the first execution of a prepared statement will call sp_executesql and not prepare a statement.
abstract java.lang.String	getEnclaveAttestationProtocol() Returns the enclave attestation protocol used in Always Encrypted with Secure Enclaves.
abstract java.lang.String	getEnclaveAttestationUrl() Returns the enclave attestation URL used in Always Encrypted with Secure Enclaves.
abstract java.lang.String	getEncrypt() Returns the TLS encryption option.
abstract boolean	getFIPS() Returns the value of connection property "fips".
abstract java.lang.String	getFailoverPartner() Returns the name of the failover server that is used in a database mirroring configuration.
abstract org.ietf.jgss.GSSCredential	getGSSCredentials() Returns the GSSCredential.
abstract java.lang.String	getHostNameInCertificate() Returns the host name used in validating the SQL Server Secure Sockets Layer (SSL) certificate.
abstract java.lang.String	getIPAddressPreference() Gets the name of the preferred type of IP Address.
abstract java.lang.String	getInstanceName() Returns the SQL Server instance name.
abstract java.lang.String	getJAASConfigurationName() Returns the login configuration name for Kerberos authentication.
abstract java.lang.String	getJASSConfigurationName() Deprecated Use getJAASConfigurationName() instead Returns the login configuration name for Kerberos authentication.
abstract java.lang.String	getKeyStoreAuthentication() Returns the value of the keyStoreAuthentication setting for the data source object.
abstract java.lang.String	getKeyStoreLocation() Returns the keyStoreLocation for the Java Key Store.
abstract java.lang.String	getKeyStorePrincipalId() Returns the value for the connection property 'keyStorePrincipalId'.
abstract java.lang.String	getKeyVaultProviderClientId() Returns the value for the connection property 'keyVaultProviderClientId'.
abstract boolean	getLastUpdateCount() Returns a Boolean value that indicates if the lastUpdateCount property is enabled.
abstract int	getLockTimeout() Returns an int value that indicates the number of milliseconds that the database will wait before reporting a lock time out.
abstract java.lang.String	getMSIClientId() Deprecated Use getUser() instead. Returns the value for the connection property 'msiClientId'.
abstract java.lang.String	getMaxResultBuffer() Returns value of 'maxResultBuffer' from Connection String.
abstract int	getMsiTokenCacheTtl() Deprecated Time-to-live is no longer supported for the cached Managed Identity tokens.
abstract boolean	getMultiSubnetFailover() Returns the value of the multiSubnetFailover connection property.
abstract int	getPacketSize() Returns the current network packet size used to communicate with SQL Server, specified in bytes.
abstract int	getPortNumber() Returns the current port number that is used to communicate with SQL Server.
abstract java.lang.String	getPrepareMethod() Returns the value indicating the prepare method.
abstract int	getQueryTimeout() Returns the query timeout.
abstract java.lang.String	getRealm() Returns the realm for Kerberos authentication.
abstract boolean	getReplication() Returns the value of the replication connection property.
abstract java.lang.String	getResponseBuffering() Returns the response buffering mode for this SQLServerDataSource object.
abstract java.lang.String	getSSLProtocol() Returns the value of connection property 'sslProtocol'.
abstract java.lang.String	getSelectMethod() Returns the default cursor type used for all result sets that are created by using this SQLServerDataSource object.
abstract boolean	getSendStringParametersAsUnicode() Returns whether sending string parameters to the server in UNICODE format is enabled.
abstract boolean	getSendTemporalDataTypesAsStringForBulkCopy() Returns the current flag for value sendTemporalDataTypesAsStringForBulkCopy
abstract boolean	getSendTimeAsDatetime() Returns the value of the sendTimeAsDatetime connection property.
abstract java.lang.String	getServerCertificate() Returns the path to the server certificate.
abstract java.lang.String	getServerName() Returns the name of the SQL Server instance.
abstract boolean	getServerNameAsACE() Returns if the serverName should be translated from Unicode to ASCII Compatible Encoding (ACE).
abstract int	getServerPreparedStatementDiscardThreshold() Returns the value of the setting that controls how many outstanding prepared statement discard actions (sp_unprepare) can be outstanding per connection before a call to clean-up the outstanding handles on the server is executed.
abstract java.lang.String	getServerSpn() Returns the server spn.
abstract java.lang.String	getSocketFactoryClass() Returns the value for the connection property 'socketFactoryClass'.
abstract java.lang.String	getSocketFactoryConstructorArg() Returns the value for the connection property 'socketFactoryConstructorArg'.
abstract int	getSocketTimeout() Returns the socket timeout value.
abstract int	getStatementPoolingCacheSize() Returns the size of the prepared statement cache for this connection.
abstract boolean	getTransparentNetworkIPResolution() Returns the TransparentNetworkIPResolution value.
abstract java.lang.String	getTrustManagerClass() Returns the value for the connection property 'trustManagerClass'.
abstract java.lang.String	getTrustManagerConstructorArg() Returns the value for the connection property 'trustManagerConstructorArg'.
abstract boolean	getTrustServerCertificate() Returns a boolean value that indicates if the trustServerCertificate property is enabled.
abstract java.lang.String	getTrustStore() Returns the path (including file name) to the certificate trustStore file.
abstract java.lang.String	getTrustStoreType() Returns the keyStore Type for the trustStore.
abstract java.lang.String	getURL() Returns the URL that is used to connect to the data source.
abstract boolean	getUseBulkCopyForBatchInsert() Returns whether the use Bulk Copy API is used for Batch Insert.
abstract boolean	getUseDefaultGSSCredential() Returns the useDefaultGSSCredential.
abstract boolean	getUseDefaultJaasConfig() Returns whether the default JAAS Configuration should be used
abstract boolean	getUseFlexibleCallableStatements() Returns whether or not sp_sproc_columns is being used for parameter name lookup.
abstract boolean	getUseFmtOnly() Returns the current flag value for useFmtOnly.
abstract java.lang.String	getUser() Returns the user name that is used to connect the data source.
abstract java.lang.String	getWorkstationID() Returns the name of the client computer name that is used to connect to the data source.
abstract boolean	getXopenStates() Returns the value that indicates if converting SQL states to XOPEN compliant states is enabled.
abstract boolean	getcacheBulkCopyMetadata() Sets the value for 'cacheBulkCopyMetadata' property
abstract void	setAADSecurePrincipalId(String aadSecurePrincipalId) Deprecated Use setUser(String user) instead Sets the 'AADSecurePrincipalId' connection property used for Active Directory Service Principal authentication.
abstract void	setAADSecurePrincipalSecret(String aadSecurePrincipalSecret) Deprecated Use setPassword(String password) instead Sets the 'AADSecurePrincipalSecret' connection property used for Active Directory Service Principal authentication.
abstract void	setAccessToken(String accessToken) Sets the access token.
abstract void	setAccessTokenCallback(SQLServerAccessTokenCallback accessTokenCallback) Sets the SQLServerAccessTokenCallback delegate.
abstract void	setAccessTokenCallbackClass(String accessTokenCallbackClass) Sets 'accessTokenCallbackClass' to the fully qualified class name of the implementing class for SQLServerAccessTokenCallback.
abstract void	setApplicationIntent(String applicationIntent) Sets the application intent.
abstract void	setApplicationName(String applicationName) Sets the application name.
abstract void	setAuthentication(String authentication) Sets the authentication mode.
abstract void	setAuthenticationScheme(String authenticationScheme) Sets the kind of integrated security you want your application to use.
abstract void	setCalcBigDecimalPrecision(boolean calcBigDecimalPrecision) Returns value of 'calcBigDecimalPrecision' from Connection String.
abstract void	setCancelQueryTimeout(int cancelQueryTimeout) Sets the cancel timeout.
abstract void	setClientCertificate(String certPath) Sets client certificate path for client certificate authentication.
abstract void	setClientKey(String keyPath) Sets Private key file path for client certificate authentication.
abstract void	setClientKeyPassword(String password) Sets the password to be used for Private key provided by the user for client certificate authentication.
abstract void	setColumnEncryptionSetting(String columnEncryptionSetting) Sets the value to enable/disable Always Encrypted functionality for the data source object.
abstract void	setConnectRetryCount(int connectRetryCount) Sets the maximum number of attempts to reestablish a broken connection.
abstract void	setConnectRetryInterval(int connectRetryInterval) Sets the interval, in seconds, between attempts to reestablish a broken connection.
abstract void	setDatabaseName(String databaseName) Sets the database name to connect to.
abstract void	setDatetimeParameterType(String datetimeParameterType) Sets the SQL server datatype to use for Java datetime and timestamp values.
abstract void	setDelayLoadingLobs(boolean delayLoadingLobs) Specifies the flag to load LOBs instead of streaming them.
abstract void	setDescription(String description) Sets the description of the data source.
abstract void	setDisableStatementPooling(boolean disableStatementPooling) Sets the value to disable/enable statement pooling.
abstract void	setDomain(String domain) Sets the 'domain' connection property used for NTLM Authentication.
abstract void	setEnablePrepareOnFirstPreparedStatementCall(boolean enablePrepareOnFirstPreparedStatementCall) Sets the value that enables/disables whether the first execution of a prepared statement will call sp_executesql and not prepare a statement.
abstract void	setEnclaveAttestationProtocol(String protocol) Sets the enclave attestation protocol to be used in Always Encrypted with Secure Enclaves.
abstract void	setEnclaveAttestationUrl(String url) Sets the enclave attestation URL used in Always Encrypted with Secure Enclaves.
abstract void	setEncrypt(boolean encryptOption) Deprecated Use setEncrypt(String encryptOption) instead Sets the option whether TLS encryption is used.
abstract void	setEncrypt(String encryptOption) Sets the option whether TLS encryption is used.
abstract void	setFIPS(boolean fips) Sets whether Fips Mode should be enabled/disabled on the connection.
abstract void	setFailoverPartner(String serverName) Sets the name of the failover server that is used in a database mirroring configuration.
abstract void	setGSSCredentials(GSSCredential userCredential) Sets the GSSCredential.
abstract void	setHostNameInCertificate(String hostName) Sets the host name to be used in validating the SQL Server Secure Sockets Layer (SSL) certificate.
abstract void	setIPAddressPreference(String iPAddressPreference) Sets the name of the preferred type of IP Address.
abstract void	setInstanceName(String instanceName) Sets the SQL Server instance name.
abstract void	setIntegratedSecurity(boolean enable) Sets a Boolean value that indicates if the integratedSecurity property is enabled.
abstract void	setJAASConfigurationName(String configurationName) Sets the login configuration name for Kerberos authentication.
abstract void	setJASSConfigurationName(String configurationName) Deprecated Use setJAASConfigurationName(String configurationName) instead Sets the login configuration name for Kerberos authentication.
abstract void	setKeyStoreAuthentication(String keyStoreAuthentication) Sets the name that identifies a key store.
abstract void	setKeyStoreLocation(String keyStoreLocation) Sets the location including the file name for the Java keystore.
abstract void	setKeyStorePrincipalId(String keyStorePrincipalId) Sets the value for the connection property 'keyStorePrincipalId'.
abstract void	setKeyStoreSecret(String keyStoreSecret) Sets the password for the Java keystore.
abstract void	setKeyVaultProviderClientId(String keyVaultProviderClientId) Sets the Azure Key Vault (AKV) Provider Client Id to provided value to be used for column encryption.
abstract void	setKeyVaultProviderClientKey(String keyVaultProviderClientKey) Sets the Azure Key Vault (AKV) Provider Client Key to provided value to be used for column encryption.
abstract void	setLastUpdateCount(boolean lastUpdateCount) Sets a Boolean value that indicates if the lastUpdateCount property is enabled.
abstract void	setLockTimeout(int lockTimeout) Sets an int value that indicates the number of milliseconds to wait before the database reports a lock time out.
abstract void	setMSIClientId(String managedIdentityClientId) Deprecated Use setUser(String user) instead. Sets the client id to be used to retrieve the access token for a user-assigned Managed Identity.
abstract void	setMaxResultBuffer(String maxResultBuffer) Sets the value for 'maxResultBuffer' property
abstract void	setMsiTokenCacheTtl(int timeToLive) Deprecated Time-to-live is no longer supported for the cached Managed Identity tokens.
abstract void	setMultiSubnetFailover(boolean multiSubnetFailover) Sets the value of the multiSubnetFailover connection property.
abstract void	setPacketSize(int packetSize) Sets the current network packet size used to communicate with SQL Server, specified in bytes.
abstract void	setPassword(String password) Sets the password that will be used to connect to SQL Server.
abstract void	setPortNumber(int portNumber) Sets the port number to be used to communicate with SQL Server.
abstract void	setPrepareMethod(String prepareMethod) Sets the behavior for the prepare method.
abstract void	setQueryTimeout(int queryTimeout) Setting the query timeout.
abstract void	setRealm(String realm) Sets the realm for Kerberos authentication.
abstract void	setReplication(boolean replication) Sets the value to enable/disable the replication connection property.
abstract void	setResponseBuffering(String bufferingMode) Sets the response buffering mode for connections created by using this SQLServerDataSource object.
abstract void	setSSLProtocol(String sslProtocol) Sets the sslProtocol property for connection Set this value to specify TLS protocol keyword.
abstract void	setSelectMethod(String selectMethod) Sets the default cursor type that is used for all result sets that are created by using this SQLServerDataSource object.
abstract void	setSendStringParametersAsUnicode(boolean sendStringParametersAsUnicode) Sets a boolean value that indicates if sending string parameters to the server in UNICODE format is enabled.
abstract void	setSendTemporalDataTypesAsStringForBulkCopy(boolean sendTemporalDataTypesAsStringForBulkCopy) Specifies the flag to send temporal datatypes as String for Bulk Copy.
abstract void	setSendTimeAsDatetime(boolean sendTimeAsDatetime) Sets the value to enable/disable the sendTimeAsDatetime connection property.
abstract void	setServerCertificate(String cert) Sets the connection property 'serverCertificate' on the connection.
abstract void	setServerName(String serverName) Sets the name of the computer that is running SQL Server.
abstract void	setServerNameAsACE(boolean serverNameAsACE) Sets whether the serverName will be translated from Unicode to ASCII Compatible Encoding (ACE).
abstract void	setServerPreparedStatementDiscardThreshold(int serverPreparedStatementDiscardThreshold) Sets the value that controls how many outstanding prepared statement discard actions (sp_unprepare) can be outstanding per connection before a call to clean-up the outstanding handles on the server is executed.
abstract void	setServerSpn(String serverSpn) Sets the server spn.
abstract void	setSocketFactoryClass(String socketFactoryClass) Sets the connection property 'socketFactoryClass' on the connection.
abstract void	setSocketFactoryConstructorArg(String socketFactoryConstructorArg) Sets Constructor Arguments to be provided on constructor of 'socketFactoryClass'.
abstract void	setSocketTimeout(int socketTimeout) Sets the socket timeout value.
abstract void	setStatementPoolingCacheSize(int statementPoolingCacheSize) Sets the size of the prepared statement cache for this connection.
abstract void	setTransparentNetworkIPResolution(boolean tnir) Sets the value to enable/disable Transparent Network IP Resolution (TNIR).
abstract void	setTrustManagerClass(String trustManagerClass) Sets the connection property 'trustManagerClass' on the connection.
abstract void	setTrustManagerConstructorArg(String trustManagerConstructorArg) Sets Constructor Arguments to be provided on constructor of 'trustManagerClass'.
abstract void	setTrustServerCertificate(boolean e) Sets a boolean value that indicates if the trustServerCertificate property is enabled.
abstract void	setTrustStore(String trustStore) Sets the path (including file name) to the certificate trustStore file.
abstract void	setTrustStorePassword(String trustStorePassword) Sets the password that is used to check the integrity of the trustStore data.
abstract void	setTrustStoreType(String trustStoreType) Sets the keystore type for the trustStore.
abstract void	setURL(String url) Sets the URL that is used to connect to the data source.
abstract void	setUseBulkCopyForBatchInsert(boolean useBulkCopyForBatchInsert) Sets whether the use Bulk Copy API should be used for Batch Insert.
abstract void	setUseDefaultGSSCredential(boolean enable) Sets the value to indicate whether useDefaultGSSCredential is enabled.
abstract void	setUseDefaultJaasConfig(boolean useDefaultJaasConfig) Sets whether the default JAAS Configuration will be used.
abstract void	setUseFlexibleCallableStatements(boolean useFlexibleCallableStatements) Sets whether or not sp_sproc_columns will be used for parameter name lookup.
abstract void	setUseFmtOnly(boolean useFmtOnly) Specifies the flag to use FMTONLY for parameter metadata queries.
abstract void	setUser(String user) Sets the user name that is used to connect the data source.
abstract void	setWorkstationID(String workstationID) Sets the name of the client computer name that is used to connect to the data source.
abstract void	setXopenStates(boolean xopenStates) Sets whether converting SQL states to XOPEN compliant states is enabled.
abstract void	setcacheBulkCopyMetadata(boolean cacheBulkCopyMetadata) Returns value of 'cacheBulkCopyMetadata' from Connection String.

Method Details

getAADSecurePrincipalId

(=9.4.1,=true)
public abstract String getAADSecurePrincipalId()

Deprecated

Use getUser() instead

Returns the value for the connection property 'AADSecurePrincipalId'.

Returns:

'AADSecurePrincipalId' property value.

getAccessToken

public abstract String getAccessToken()

Returns the access token.

Returns:

the access token.

getAccessTokenCallback

public abstract SQLServerAccessTokenCallback getAccessTokenCallback()

Returns a SQLServerAccessTokenCallback, the access token callback delegate.

Returns:

Access token callback delegate.

getAccessTokenCallbackClass

public abstract String getAccessTokenCallbackClass()

Returns the fully qualified class name of the implementing class for SQLServerAccessTokenCallback.

Returns:

accessTokenCallbackClass

getApplicationIntent

public abstract String getApplicationIntent()

Returns the application intent.

Returns:

A String that contains the application intent.

getApplicationName

public abstract String getApplicationName()

Returns the application name.

Returns:

A String that contains the application name, or "Microsoft JDBC Driver for SQL Server" if no value is set.

getAuthentication

public abstract String getAuthentication()

Returns the authentication mode.

Returns:

the authentication value

getCalcBigDecimalPrecision

public abstract boolean getCalcBigDecimalPrecision()

Sets the value for 'calcBigDecimalPrecision' property

Returns:

calcBigDecimalPrecision boolean value

getCancelQueryTimeout

public abstract int getCancelQueryTimeout()

Returns the cancel timeout.

Returns:

the number of seconds to wait before we wait for the query timeout to happen.

getClientCertificate

public abstract String getClientCertificate()

Returns client certificate path for client certificate authentication.

Returns:

Client certificate path.

getClientKey

public abstract String getClientKey()

Returns Private key file path for client certificate authentication.

Returns:

Private key file path.

getColumnEncryptionSetting

public abstract String getColumnEncryptionSetting()

Returns the Always Encrypted functionality setting for the data source object.

Returns:

the Always Encrypted functionality setting for the data source object.

getConnectRetryCount

public abstract int getConnectRetryCount()

Returns the maximum number of attempts set to reestablish a broken connection.

Returns:

maximum number of attempts

getConnectRetryInterval

public abstract int getConnectRetryInterval()

Returns the interval set, in seconds, between attempts to reestablish a broken connection.

Returns:

interval in seconds

getDatabaseName

public abstract String getDatabaseName()

Returns the database name.

Returns:

A String that contains the database name or null if no value is set.

getDatetimeParameterType

public abstract String getDatetimeParameterType()

Returns the value of the datetimeParameterType connection property. This method was added in SQL Server JDBC Driver 12.2. Returns the setting of the datetimeParameterType connection property.

Returns:

Returns the value of the datetimeParameterType property.

getDelayLoadingLobs

public abstract boolean getDelayLoadingLobs()

Returns the current flag value for delayLoadingLobs.

Returns:

'delayLoadingLobs' property value.

getDescription

public abstract String getDescription()

Returns a description of the data source.

Returns:

A String that contains the data source description or null if no value is set.

getDisableStatementPooling

public abstract boolean getDisableStatementPooling()

Returns whether statement pooling is disabled.

Returns:

true if statement pooling is disabled, false if it is enabled.

getDomain

public abstract String getDomain()

Returns the value for the connection property 'domain'.

Returns:

'domain' property value

getEnablePrepareOnFirstPreparedStatementCall

public abstract boolean getEnablePrepareOnFirstPreparedStatementCall()

Returns the value that indicates whether the first execution of a prepared statement will call sp_executesql and not prepare a statement. If this configuration returns false the first execution of a prepared statement will call sp_executesql and not prepare a statement, once the second execution happens it will call sp_prepexec and actually setup a prepared statement handle. Following executions will call sp_execute. This relieves the need for sp_unprepare on prepared statement close if the statement is only executed once.

Returns:

Returns the current setting per the description.

getEnclaveAttestationProtocol

public abstract String getEnclaveAttestationProtocol()

Returns the enclave attestation protocol used in Always Encrypted with Secure Enclaves.

Returns:

Enclave attestation protocol.

getEnclaveAttestationUrl

public abstract String getEnclaveAttestationUrl()

Returns the enclave attestation URL used in Always Encrypted with Secure Enclaves.

Returns:

enclave attestation URL.

getEncrypt

public abstract String getEncrypt()

Returns the TLS encryption option.

Returns:

the TLS encrypt option

getFIPS

public abstract boolean getFIPS()

Returns the value of connection property "fips". For FIPS enabled JVM this property should be true.

Returns:

fips boolean value

getFailoverPartner

public abstract String getFailoverPartner()

Returns the name of the failover server that is used in a database mirroring configuration.

Returns:

A String that contains the name of the failover partner, or null if none is set.

getGSSCredentials

public abstract GSSCredential getGSSCredentials()

Returns the GSSCredential.

Returns:

GSSCredential

getHostNameInCertificate

public abstract String getHostNameInCertificate()

Returns the host name used in validating the SQL Server Secure Sockets Layer (SSL) certificate.

Returns:

A String that contains the host name, or null if no value is set.

getIPAddressPreference

public abstract String getIPAddressPreference()

Gets the name of the preferred type of IP Address.

Returns:

IPAddressPreference A String that contains the preferred type of IP Address.

getInstanceName

public abstract String getInstanceName()

Returns the SQL Server instance name.

Returns:

A String that contains the instance name, or null if no value is set.

getJAASConfigurationName

public abstract String getJAASConfigurationName()

Returns the login configuration name for Kerberos authentication.

Returns:

login configuration name

getJASSConfigurationName

(=9.3.0,=true)
public abstract String getJASSConfigurationName()

Deprecated

Use getJAASConfigurationName() instead

Returns the login configuration name for Kerberos authentication.

Returns:

login configuration file name

getKeyStoreAuthentication

public abstract String getKeyStoreAuthentication()

Returns the value of the keyStoreAuthentication setting for the data source object.

Returns:

the value of the keyStoreAuthentication setting for the data source object.

getKeyStoreLocation

public abstract String getKeyStoreLocation()

Returns the keyStoreLocation for the Java Key Store.

Returns:

the keyStoreLocation for the Java Key Store.

getKeyStorePrincipalId

public abstract String getKeyStorePrincipalId()

Returns the value for the connection property 'keyStorePrincipalId'.

Returns:

keyStorePrincipalId

getKeyVaultProviderClientId

public abstract String getKeyVaultProviderClientId()

Returns the value for the connection property 'keyVaultProviderClientId'.

Returns:

keyVaultProviderClientId

getLastUpdateCount

public abstract boolean getLastUpdateCount()

Returns a Boolean value that indicates if the lastUpdateCount property is enabled.

Returns:

true if lastUpdateCount is enabled. Otherwise, false.

getLockTimeout

public abstract int getLockTimeout()

Returns an int value that indicates the number of milliseconds that the database will wait before reporting a lock time out.

Returns:

An int value that contains the number of milliseconds that the database will wait.

getMSIClientId

(=12.1.0,=true)
public abstract String getMSIClientId()

Deprecated

Use getUser() instead.

Returns the value for the connection property 'msiClientId'.

Returns:

msiClientId property value

getMaxResultBuffer

public abstract String getMaxResultBuffer()

Returns value of 'maxResultBuffer' from Connection String.

Returns:

'maxResultBuffer' property.

getMsiTokenCacheTtl

(=12.1.0,=true)
public abstract int getMsiTokenCacheTtl()

Deprecated

Time-to-live is no longer supported for the cached Managed Identity tokens. This method will always return 0 and is for backwards compatibility only.

Returns:

Method will always return 0.

getMultiSubnetFailover

public abstract boolean getMultiSubnetFailover()

Returns the value of the multiSubnetFailover connection property.

Returns:

Returns true or false, depending on the current setting of the connection property.

getPacketSize

public abstract int getPacketSize()

Returns the current network packet size used to communicate with SQL Server, specified in bytes.

Returns:

An int value containing the current network packet size.

getPortNumber

public abstract int getPortNumber()

Returns the current port number that is used to communicate with SQL Server.

Returns:

An int value that contains the current port number.

getPrepareMethod

public abstract String getPrepareMethod()

Returns the value indicating the prepare method. PrepareMethod

Returns:

prepare method

getQueryTimeout

public abstract int getQueryTimeout()

Returns the query timeout.

Returns:

The number of seconds to wait before a timeout has occurred on a query.

getRealm

public abstract String getRealm()

Returns the realm for Kerberos authentication.

Returns:

A String that contains the realm

getReplication

public abstract boolean getReplication()

Returns the value of the replication connection property.

Returns:

true if the connection is to be used for replication. Otherwise false.

getResponseBuffering

public abstract String getResponseBuffering()

Returns the response buffering mode for this SQLServerDataSource object.

Returns:

A String that contains a lower-case full or adaptive.

getSSLProtocol

public abstract String getSSLProtocol()

Returns the value of connection property 'sslProtocol'.

Returns:

sslProtocol property value

getSelectMethod

public abstract String getSelectMethod()

Returns the default cursor type used for all result sets that are created by using this SQLServerDataSource object.

Returns:

A String value that contains the default cursor type.

getSendStringParametersAsUnicode

public abstract boolean getSendStringParametersAsUnicode()

Returns whether sending string parameters to the server in UNICODE format is enabled.

Returns:

true if string parameters are sent to the server in UNICODE format. Otherwise, false.

getSendTemporalDataTypesAsStringForBulkCopy

public abstract boolean getSendTemporalDataTypesAsStringForBulkCopy()

Returns the current flag for value sendTemporalDataTypesAsStringForBulkCopy

Returns:

'sendTemporalDataTypesAsStringForBulkCopy' property value.

getSendTimeAsDatetime

public abstract boolean getSendTimeAsDatetime()

Returns the value of the sendTimeAsDatetime connection property. This method was added in SQL Server JDBC Driver 3.0. Returns the setting of the sendTimeAsDatetime connection property.

Returns:

true if java.sql.Time values will be sent to the server as a SQL Server datetime type. false if java.sql.Time values will be sent to the server as a SQL Server time type.

getServerCertificate

public abstract String getServerCertificate()

Returns the path to the server certificate.

Returns:

serverCertificate property value

getServerName

public abstract String getServerName()

Returns the name of the SQL Server instance.

Returns:

A String that contains the server name or null if no value is set.

getServerNameAsACE

public abstract boolean getServerNameAsACE()

Returns if the serverName should be translated from Unicode to ASCII Compatible Encoding (ACE).

Returns:

if enabled, will return true. Otherwise, false.

getServerPreparedStatementDiscardThreshold

public abstract int getServerPreparedStatementDiscardThreshold()

Returns the value of the setting that controls how many outstanding prepared statement discard actions (sp_unprepare) can be outstanding per connection before a call to clean-up the outstanding handles on the server is executed.

Returns:

Returns the current setting per the description.

getServerSpn

public abstract String getServerSpn()

Returns the server spn.

Returns:

A String that contains the server spn

getSocketFactoryClass

public abstract String getSocketFactoryClass()

Returns the value for the connection property 'socketFactoryClass'.

Returns:

socketFactoryClass property value

getSocketFactoryConstructorArg

public abstract String getSocketFactoryConstructorArg()

Returns the value for the connection property 'socketFactoryConstructorArg'.

Returns:

socketFactoryConstructorArg property value

getSocketTimeout

public abstract int getSocketTimeout()

Returns the socket timeout value.

Returns:

The number of milliseconds to wait before a timeout is occurred on a socket read or accept.

getStatementPoolingCacheSize

public abstract int getStatementPoolingCacheSize()

Returns the size of the prepared statement cache for this connection. A value less than 1 means no cache.

Returns:

Returns the current setting per the description.

getTransparentNetworkIPResolution

public abstract boolean getTransparentNetworkIPResolution()

Returns the TransparentNetworkIPResolution value.

Returns:

if enabled, returns true. Otherwise, false.

getTrustManagerClass

public abstract String getTrustManagerClass()

Returns the value for the connection property 'trustManagerClass'.

Returns:

trustManagerClass property value

getTrustManagerConstructorArg

public abstract String getTrustManagerConstructorArg()

Returns the value for the connection property 'trustManagerConstructorArg'.

Returns:

trustManagerConstructorArg property value

getTrustServerCertificate

public abstract boolean getTrustServerCertificate()

Returns a boolean value that indicates if the trustServerCertificate property is enabled.

Returns:

true if trustServerCertificate is enabled. Otherwise, false. If encrypt=strict, returns server certificate location

getTrustStore

public abstract String getTrustStore()

Returns the path (including file name) to the certificate trustStore file.

Returns:

trustStore A String that contains the path (including file name) to the certificate trustStore file, or null if no value is set.

getTrustStoreType

public abstract String getTrustStoreType()

Returns the keyStore Type for the trustStore.

Returns:

trustStoreType A String that contains the trust store type

getURL

public abstract String getURL()

Returns the URL that is used to connect to the data source.

Returns:

A String that contains the URL.

getUseBulkCopyForBatchInsert

public abstract boolean getUseBulkCopyForBatchInsert()

Returns whether the use Bulk Copy API is used for Batch Insert.

Returns:

whether the driver should use Bulk Copy API for Batch Insert operations.

getUseDefaultGSSCredential

public abstract boolean getUseDefaultGSSCredential()

Returns the useDefaultGSSCredential.

Returns:

if enabled, return true. Otherwise, false.

getUseDefaultJaasConfig

public abstract boolean getUseDefaultJaasConfig()

Returns whether the default JAAS Configuration should be used

Returns:

useDefaultJaasConfig boolean value

getUseFlexibleCallableStatements

public abstract boolean getUseFlexibleCallableStatements()

Returns whether or not sp_sproc_columns is being used for parameter name lookup.

Returns:

useFlexibleCallableStatements

getUseFmtOnly

public abstract boolean getUseFmtOnly()

Returns the current flag value for useFmtOnly.

Returns:

'useFmtOnly' property value.

getUser

public abstract String getUser()

Returns the user name that is used to connect the data source.

Returns:

A String that contains the user name.

getWorkstationID

public abstract String getWorkstationID()

Returns the name of the client computer name that is used to connect to the data source.

Returns:

A String that contains the client computer name.

getXopenStates

public abstract boolean getXopenStates()

Returns the value that indicates if converting SQL states to XOPEN compliant states is enabled.

Returns:

true if converting SQL states to XOPEN compliant states is enabled. Otherwise, false.

getcacheBulkCopyMetadata

public abstract boolean getcacheBulkCopyMetadata()

Sets the value for 'cacheBulkCopyMetadata' property

Returns:

cacheBulkCopyMetadata boolean value

setAADSecurePrincipalId

(=9.4.1,=true)
public abstract void setAADSecurePrincipalId(String aadSecurePrincipalId)

Deprecated

Use setUser(String user) instead

Sets the 'AADSecurePrincipalId' connection property used for Active Directory Service Principal authentication.

Parameters:

aadSecurePrincipalId - Active Directory Service Principal Id.

setAADSecurePrincipalSecret

(=9.4.1,=true)
public abstract void setAADSecurePrincipalSecret(String aadSecurePrincipalSecret)

Deprecated

Use setPassword(String password) instead

Sets the 'AADSecurePrincipalSecret' connection property used for Active Directory Service Principal authentication.

Parameters:

aadSecurePrincipalSecret - Active Directory Service Principal secret.

setAccessToken

public abstract void setAccessToken(String accessToken)

Sets the access token.

Parameters:

accessToken - to be set in the string property.

setAccessTokenCallback

public abstract void setAccessTokenCallback(SQLServerAccessTokenCallback accessTokenCallback)

Sets the SQLServerAccessTokenCallback delegate.

Parameters:

accessTokenCallback - Access token callback delegate.

setAccessTokenCallbackClass

public abstract void setAccessTokenCallbackClass(String accessTokenCallbackClass)

Sets 'accessTokenCallbackClass' to the fully qualified class name of the implementing class for SQLServerAccessTokenCallback.

Parameters:

accessTokenCallbackClass - access token callback class

setApplicationIntent

public abstract void setApplicationIntent(String applicationIntent)

Sets the application intent.

Parameters:

applicationIntent - A String that contains the application intent.

setApplicationName

public abstract void setApplicationName(String applicationName)

Sets the application name.

Parameters:

applicationName - A String that contains the name of the application.

setAuthentication

public abstract void setAuthentication(String authentication)

Sets the authentication mode.

Parameters:

authentication - the authentication mode

setAuthenticationScheme

public abstract void setAuthenticationScheme(String authenticationScheme)

Sets the kind of integrated security you want your application to use.

Parameters:

authenticationScheme - Values are "JavaKerberos" and the default "NativeAuthentication".

setCalcBigDecimalPrecision

public abstract void setCalcBigDecimalPrecision(boolean calcBigDecimalPrecision)

Returns value of 'calcBigDecimalPrecision' from Connection String.

Parameters:

calcBigDecimalPrecision - indicates whether the driver should attempt to calculate precision from inputted big decimal values

setCancelQueryTimeout

public abstract void setCancelQueryTimeout(int cancelQueryTimeout)

Sets the cancel timeout.

Parameters:

cancelQueryTimeout - The number of seconds to wait before we wait for the query timeout to happen.

setClientCertificate

public abstract void setClientCertificate(String certPath)

Sets client certificate path for client certificate authentication.

Parameters:

certPath - Client certificate path.

setClientKey

public abstract void setClientKey(String keyPath)

Sets Private key file path for client certificate authentication.

Parameters:

keyPath - Private key file path.

setClientKeyPassword

public abstract void setClientKeyPassword(String password)

Sets the password to be used for Private key provided by the user for client certificate authentication.

Parameters:

password - Private key password.

setColumnEncryptionSetting

public abstract void setColumnEncryptionSetting(String columnEncryptionSetting)

Sets the value to enable/disable Always Encrypted functionality for the data source object. The default is Disabled.

Parameters:

columnEncryptionSetting - Enables/disables Always Encrypted functionality for the data source object. The default is Disabled.

setConnectRetryCount

public abstract void setConnectRetryCount(int connectRetryCount)

Sets the maximum number of attempts to reestablish a broken connection.

Parameters:

connectRetryCount - maximum number of attempts

setConnectRetryInterval

public abstract void setConnectRetryInterval(int connectRetryInterval)

Sets the interval, in seconds, between attempts to reestablish a broken connection.

Parameters:

connectRetryInterval - interval in seconds

setDatabaseName

public abstract void setDatabaseName(String databaseName)

Sets the database name to connect to.

Parameters:

databaseName - A String that contains the database name.

setDatetimeParameterType

public abstract void setDatetimeParameterType(String datetimeParameterType)

Sets the SQL server datatype to use for Java datetime and timestamp values.

Parameters:

datetimeParameterType - The SQL datatype to use when encoding Java dates for SQL Server. Valid values are: datetime, datetime2 or datetimeoffset.

setDelayLoadingLobs

public abstract void setDelayLoadingLobs(boolean delayLoadingLobs)

Specifies the flag to load LOBs instead of streaming them.

Parameters:

delayLoadingLobs - boolean value for 'delayLoadingLobs'.

setDescription

public abstract void setDescription(String description)

Sets the description of the data source.

Parameters:

description - A String that contains the description.

setDisableStatementPooling

public abstract void setDisableStatementPooling(boolean disableStatementPooling)

Sets the value to disable/enable statement pooling.

Parameters:

disableStatementPooling - true to disable statement pooling, false to enable it.

setDomain

public abstract void setDomain(String domain)

Sets the 'domain' connection property used for NTLM Authentication.

Parameters:

domain - Windows domain name

setEnablePrepareOnFirstPreparedStatementCall

public abstract void setEnablePrepareOnFirstPreparedStatementCall(boolean enablePrepareOnFirstPreparedStatementCall)

Sets the value that enables/disables whether the first execution of a prepared statement will call sp_executesql and not prepare a statement. If this configuration is false the first execution of a prepared statement will call sp_executesql and not prepare a statement, once the second execution happens it will call sp_prepexec and actually setup a prepared statement handle. Following executions will call sp_execute. This relieves the need for sp_unprepare on prepared statement close if the statement is only executed once.

Parameters:

enablePrepareOnFirstPreparedStatementCall - Changes the setting per the description.

setEnclaveAttestationProtocol

public abstract void setEnclaveAttestationProtocol(String protocol)

Sets the enclave attestation protocol to be used in Always Encrypted with Secure Enclaves.

Parameters:

protocol - Enclave attestation protocol.

setEnclaveAttestationUrl

public abstract void setEnclaveAttestationUrl(String url)

Sets the enclave attestation URL used in Always Encrypted with Secure Enclaves.

Parameters:

url - Enclave attestation URL.

setEncrypt

(=10.1.0,=true)
public abstract void setEncrypt(boolean encryptOption)

Deprecated

Use setEncrypt(String encryptOption) instead

Sets the option whether TLS encryption is used.

Parameters:

encryptOption - TLS encrypt option. Default is true

setEncrypt

public abstract void setEncrypt(String encryptOption)

Sets the option whether TLS encryption is used.

Parameters:

encryptOption - TLS encrypt option. Default is "true"

setFIPS

public abstract void setFIPS(boolean fips)

Sets whether Fips Mode should be enabled/disabled on the connection. For FIPS enabled JVM this property should be true.

Parameters:

fips - Boolean property to enable/disable fips

setFailoverPartner

public abstract void setFailoverPartner(String serverName)

Sets the name of the failover server that is used in a database mirroring configuration.

Parameters:

serverName - A String that contains the failover server name.

setGSSCredentials

public abstract void setGSSCredentials(GSSCredential userCredential)

Sets the GSSCredential.

Parameters:

userCredential - the credential

setHostNameInCertificate

public abstract void setHostNameInCertificate(String hostName)

Sets the host name to be used in validating the SQL Server Secure Sockets Layer (SSL) certificate.

Parameters:

hostName - A String that contains the host name.

setIPAddressPreference

public abstract void setIPAddressPreference(String iPAddressPreference)

Sets the name of the preferred type of IP Address.

Parameters:

iPAddressPreference - A String that contains the preferred type of IP Address.

setInstanceName

public abstract void setInstanceName(String instanceName)

Sets the SQL Server instance name.

Parameters:

instanceName - A String that contains the instance name.

setIntegratedSecurity

public abstract void setIntegratedSecurity(boolean enable)

Sets a Boolean value that indicates if the integratedSecurity property is enabled.

Parameters:

enable - true if integratedSecurity is enabled. Otherwise, false.

setJAASConfigurationName

public abstract void setJAASConfigurationName(String configurationName)

Sets the login configuration name for Kerberos authentication. This overrides the default configuration SQLJDBCDriver

Parameters:

configurationName - the configuration name

setJASSConfigurationName

(=9.3.0,=true)
public abstract void setJASSConfigurationName(String configurationName)

Deprecated

Use setJAASConfigurationName(String configurationName) instead

Sets the login configuration name for Kerberos authentication. This overrides the default configuration SQLJDBCDriver

Parameters:

configurationName - the configuration name

setKeyStoreAuthentication

public abstract void setKeyStoreAuthentication(String keyStoreAuthentication)

Sets the name that identifies a key store. Only value supported is the "JavaKeyStorePassword" for identifying the Java Key Store. The default is null.

Parameters:

keyStoreAuthentication - the name that identifies a key store.

setKeyStoreLocation

public abstract void setKeyStoreLocation(String keyStoreLocation)

Sets the location including the file name for the Java keystore. Note that, keyStoreAuthentication must be set with "JavaKeyStorePassword".

Parameters:

keyStoreLocation - the location including the file name for the Java keystore.

setKeyStorePrincipalId

public abstract void setKeyStorePrincipalId(String keyStorePrincipalId)

Sets the value for the connection property 'keyStorePrincipalId'.

Parameters:

keyStorePrincipalId -

        When keyStoreAuthentication = keyVaultClientSecret, set this value to a valid Azure Active Directory Application Client ID.
        When keyStoreAuthentication = keyVaultManagedIdentity, set this value to a valid Azure Active Directory Application Object ID (optional, for user-assigned only).
        

setKeyStoreSecret

public abstract void setKeyStoreSecret(String keyStoreSecret)

Sets the password for the Java keystore. Note that, for Java Key Store provider the password for the keystore and the key must be the same. Note that, keyStoreAuthentication must be set with "JavaKeyStorePassword".

Parameters:

keyStoreSecret - the password to use for the keystore as well as for the key

setKeyVaultProviderClientId

public abstract void setKeyVaultProviderClientId(String keyVaultProviderClientId)

Sets the Azure Key Vault (AKV) Provider Client Id to provided value to be used for column encryption.

Parameters:

keyVaultProviderClientId - Client Id of Azure Key Vault (AKV) Provider to be used for column encryption.

setKeyVaultProviderClientKey

public abstract void setKeyVaultProviderClientKey(String keyVaultProviderClientKey)

Sets the Azure Key Vault (AKV) Provider Client Key to provided value to be used for column encryption.

Parameters:

keyVaultProviderClientKey - Client Key of Azure Key Vault (AKV) Provider to be used for column encryption.

setLastUpdateCount

public abstract void setLastUpdateCount(boolean lastUpdateCount)

Sets a Boolean value that indicates if the lastUpdateCount property is enabled.

Parameters:

lastUpdateCount - true if lastUpdateCount is enabled. Otherwise, false.

setLockTimeout

public abstract void setLockTimeout(int lockTimeout)

Sets an int value that indicates the number of milliseconds to wait before the database reports a lock time out.

Parameters:

lockTimeout - An int value that contains the number of milliseconds to wait.

setMSIClientId

(=12.1.0,=true)
public abstract void setMSIClientId(String managedIdentityClientId)

Deprecated

Use setUser(String user) instead.

Sets the client id to be used to retrieve the access token for a user-assigned Managed Identity.

Parameters:

managedIdentityClientId - Client ID of the user-assigned Managed Identity.

setMaxResultBuffer

public abstract void setMaxResultBuffer(String maxResultBuffer)

Sets the value for 'maxResultBuffer' property

Parameters:

maxResultBuffer - String value for 'maxResultBuffer'

setMsiTokenCacheTtl

(=12.1.0,=true)
public abstract void setMsiTokenCacheTtl(int timeToLive)

Deprecated

Time-to-live is no longer supported for the cached Managed Identity tokens. This method is a no-op for backwards compatibility only.

Parameters:

timeToLive - Time-to-live is no longer supported.

setMultiSubnetFailover

public abstract void setMultiSubnetFailover(boolean multiSubnetFailover)

Sets the value of the multiSubnetFailover connection property.

Parameters:

multiSubnetFailover - The new value of the multiSubnetFailover connection property.

setPacketSize

public abstract void setPacketSize(int packetSize)

Sets the current network packet size used to communicate with SQL Server, specified in bytes.

Parameters:

packetSize - An int value containing the network packet size.

setPassword

public abstract void setPassword(String password)

Sets the password that will be used to connect to SQL Server.

Parameters:

password - A String that contains the password.

setPortNumber

public abstract void setPortNumber(int portNumber)

Sets the port number to be used to communicate with SQL Server.

Parameters:

portNumber - An int value that contains the port number.

setPrepareMethod

public abstract void setPrepareMethod(String prepareMethod)

Sets the behavior for the prepare method. PrepareMethod

Parameters:

prepareMethod - Changes the setting as per description

setQueryTimeout

public abstract void setQueryTimeout(int queryTimeout)

Setting the query timeout.

Parameters:

queryTimeout - The number of seconds to wait before a timeout has occurred on a query. The default value is 0, which means infinite timeout.

setRealm

public abstract void setRealm(String realm)

Sets the realm for Kerberos authentication.

Parameters:

realm - A String that contains the realm

setReplication

public abstract void setReplication(boolean replication)

Sets the value to enable/disable the replication connection property.

Parameters:

replication - A Boolean value. When true, tells the server that the connection is used for replication.

setResponseBuffering

public abstract void setResponseBuffering(String bufferingMode)

Sets the response buffering mode for connections created by using this SQLServerDataSource object.

Parameters:

bufferingMode - A String that contains the buffering and streaming mode. The valid mode can be one of the following case-insensitive Strings: full or adaptive.

setSSLProtocol

public abstract void setSSLProtocol(String sslProtocol)

Sets the sslProtocol property for connection Set this value to specify TLS protocol keyword. Acceptable values are: TLS, TLSv1, TLSv1.1, and TLSv1.2.

Parameters:

sslProtocol - Value for SSL Protocol to be set.

setSelectMethod

public abstract void setSelectMethod(String selectMethod)

Sets the default cursor type that is used for all result sets that are created by using this SQLServerDataSource object.

Parameters:

selectMethod - A String value that contains the default cursor type.

setSendStringParametersAsUnicode

public abstract void setSendStringParametersAsUnicode(boolean sendStringParametersAsUnicode)

Sets a boolean value that indicates if sending string parameters to the server in UNICODE format is enabled.

Parameters:

sendStringParametersAsUnicode - true if string parameters are sent to the server in UNICODE format. Otherwise, false.

setSendTemporalDataTypesAsStringForBulkCopy

public abstract void setSendTemporalDataTypesAsStringForBulkCopy(boolean sendTemporalDataTypesAsStringForBulkCopy)

Specifies the flag to send temporal datatypes as String for Bulk Copy.

Parameters:

sendTemporalDataTypesAsStringForBulkCopy - boolean value for 'sendTemporalDataTypesAsStringForBulkCopy'.

setSendTimeAsDatetime

public abstract void setSendTimeAsDatetime(boolean sendTimeAsDatetime)

Sets the value to enable/disable the sendTimeAsDatetime connection property.

Parameters:

sendTimeAsDatetime - A Boolean value. When true, causes java.sql.Time values to be sent to the server as SQL Server datetime types. When false, causes java.sql.Time values to be sent to the server as SQL Server time types.

setServerCertificate

public abstract void setServerCertificate(String cert)

Sets the connection property 'serverCertificate' on the connection.

Parameters:

cert - The path to the server certificate.

setServerName

public abstract void setServerName(String serverName)

Sets the name of the computer that is running SQL Server.

Parameters:

serverName - A String that contains the server name.

setServerNameAsACE

public abstract void setServerNameAsACE(boolean serverNameAsACE)

Sets whether the serverName will be translated from Unicode to ASCII Compatible Encoding (ACE).

Parameters:

serverNameAsACE - if enabled the servername will be translated to ASCII Compatible Encoding (ACE)

setServerPreparedStatementDiscardThreshold

public abstract void setServerPreparedStatementDiscardThreshold(int serverPreparedStatementDiscardThreshold)

Sets the value that controls how many outstanding prepared statement discard actions (sp_unprepare) can be outstanding per connection before a call to clean-up the outstanding handles on the server is executed. If the setting is <= 1 unprepare actions will be executed immedietely on prepared statement close. If it is set to > 1 these calls will be batched together to avoid overhead of calling sp_unprepare too often.

Parameters:

serverPreparedStatementDiscardThreshold - Changes the setting per the description.

setServerSpn

public abstract void setServerSpn(String serverSpn)

Sets the server spn.

Parameters:

serverSpn - A String that contains the server spn

setSocketFactoryClass

public abstract void setSocketFactoryClass(String socketFactoryClass)

Sets the connection property 'socketFactoryClass' on the connection.

Parameters:

socketFactoryClass - The fully qualified class name of a custom javax.net.SocketFactory.

setSocketFactoryConstructorArg

public abstract void setSocketFactoryConstructorArg(String socketFactoryConstructorArg)

Sets Constructor Arguments to be provided on constructor of 'socketFactoryClass'.

Parameters:

socketFactoryConstructorArg - 'socketFactoryClass' constructor arguments

setSocketTimeout

public abstract void setSocketTimeout(int socketTimeout)

Sets the socket timeout value.

Parameters:

socketTimeout - The number of milliseconds to wait before a timeout is occurred on a socket read or accept. The default value is 0, which means infinite timeout.

setStatementPoolingCacheSize

public abstract void setStatementPoolingCacheSize(int statementPoolingCacheSize)

Sets the size of the prepared statement cache for this connection. A value less than 1 means no cache.

Parameters:

statementPoolingCacheSize - Changes the setting per the description.

setTransparentNetworkIPResolution

public abstract void setTransparentNetworkIPResolution(boolean tnir)

Sets the value to enable/disable Transparent Network IP Resolution (TNIR). Beginning in version 6.0 of the Microsoft JDBC Driver for SQL Server, a new connection property transparentNetworkIPResolution (TNIR) is added for transparent connection to Always On availability groups or to a server which has multiple IP addresses associated. When transparentNetworkIPResolution is true, the driver attempts to connect to the first IP address available. If the first attempt fails, the driver tries to connect to all IP addresses in parallel until the timeout expires, discarding any pending connection attempts when one of them succeeds.

transparentNetworkIPResolution is ignored if multiSubnetFailover is true

transparentNetworkIPResolution is ignored if database mirroring is used

transparentNetworkIPResolution is ignored if there are more than 64 IP addresses

Parameters:

tnir - if set to true, the driver attempts to connect to the first IP address available. It is true by default.

setTrustManagerClass

public abstract void setTrustManagerClass(String trustManagerClass)

Sets the connection property 'trustManagerClass' on the connection.

Parameters:

trustManagerClass - The fully qualified class name of a custom javax.net.ssl.TrustManager.

setTrustManagerConstructorArg

public abstract void setTrustManagerConstructorArg(String trustManagerConstructorArg)

Sets Constructor Arguments to be provided on constructor of 'trustManagerClass'.

Parameters:

trustManagerConstructorArg - 'trustManagerClass' constructor arguments

setTrustServerCertificate

public abstract void setTrustServerCertificate(boolean e)

Sets a boolean value that indicates if the trustServerCertificate property is enabled.

Parameters:

e - true, if the server Secure Sockets Layer (SSL) certificate should be automatically trusted when the communication layer is encrypted using SSL. false, if server SLL certificate should not be trusted certificate location, if encrypt=strict

setTrustStore

public abstract void setTrustStore(String trustStore)

Sets the path (including file name) to the certificate trustStore file.

Parameters:

trustStore - A String that contains the path (including file name) to the certificate trustStore file.

setTrustStorePassword

public abstract void setTrustStorePassword(String trustStorePassword)

Sets the password that is used to check the integrity of the trustStore data.

Parameters:

trustStorePassword - A String that contains the password that is used to check the integrity of the trustStore data.

setTrustStoreType

public abstract void setTrustStoreType(String trustStoreType)

Sets the keystore type for the trustStore.

Parameters:

trustStoreType - A String that contains the trust store type

setURL

public abstract void setURL(String url)

Sets the URL that is used to connect to the data source.

Parameters:

url - A String that contains the URL.

setUseBulkCopyForBatchInsert

public abstract void setUseBulkCopyForBatchInsert(boolean useBulkCopyForBatchInsert)

Sets whether the use Bulk Copy API should be used for Batch Insert.

Parameters:

useBulkCopyForBatchInsert - indicates whether Bulk Copy API should be used for Batch Insert operations.

setUseDefaultGSSCredential

public abstract void setUseDefaultGSSCredential(boolean enable)

Sets the value to indicate whether useDefaultGSSCredential is enabled.

Parameters:

enable - true if useDefaultGSSCredential is enabled. Otherwise, false.

setUseDefaultJaasConfig

public abstract void setUseDefaultJaasConfig(boolean useDefaultJaasConfig)

Sets whether the default JAAS Configuration will be used. This means the system-wide JAAS configuration is ignored to avoid conflicts with libraries that override the JAAS configuration.

Parameters:

useDefaultJaasConfig - boolean property to use the default JAAS configuration

setUseFlexibleCallableStatements

public abstract void setUseFlexibleCallableStatements(boolean useFlexibleCallableStatements)

Sets whether or not sp_sproc_columns will be used for parameter name lookup.

Parameters:

useFlexibleCallableStatements - When set to false, sp_sproc_columns is not used for parameter name lookup in callable statements. This eliminates a round trip to the server but imposes limitations on how parameters are set. When set to false, applications must either reference parameters by name or by index, not both. Parameters must also be set in the same order as the stored procedure definition.

setUseFmtOnly

public abstract void setUseFmtOnly(boolean useFmtOnly)

Specifies the flag to use FMTONLY for parameter metadata queries.

Parameters:

useFmtOnly - boolean value for 'useFmtOnly'.

setUser

public abstract void setUser(String user)

Sets the user name that is used to connect the data source.

Parameters:

user - A String that contains the user name.

setWorkstationID

public abstract void setWorkstationID(String workstationID)

Sets the name of the client computer name that is used to connect to the data source.

Parameters:

workstationID - A String that contains the client computer name.

setXopenStates

public abstract void setXopenStates(boolean xopenStates)

Sets whether converting SQL states to XOPEN compliant states is enabled.

Parameters:

xopenStates - true if converting SQL states to XOPEN compliant states is enabled. Otherwise, false.

setcacheBulkCopyMetadata

public abstract void setcacheBulkCopyMetadata(boolean cacheBulkCopyMetadata)

Returns value of 'cacheBulkCopyMetadata' from Connection String.

Parameters:

cacheBulkCopyMetadata - indicates whether the driver should use connection level caching of metadata for bulk copy