ISQLServerConnection Interface

Package:

com.microsoft.sqlserver.jdbc

Maven Artifact:

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

Implements

java.sql.Connection

public interface ISQLServerConnection
extends java.sql.Connection

Provides an interface to the SQLServerConnection and SQLServerConnectionPoolProxy classes.

Field Summary

Modifier and Type	Field and Description
static final int	TRANSACTION_SNAPSHOT Transaction types "TRANSACTION_SNAPSHOT corresponds to" "SET TRANSACTION ISOLATION LEVEL SNAPSHOT"

Method Summary

Modifier and Type	Method and Description
abstract void	closeUnreferencedPreparedStatementHandles() Forces the un-prepare requests for any outstanding discarded prepared statements to be executed.
abstract java.sql.Statement	createStatement(int nType, int nConcur, int nHold, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
abstract java.lang.String	getAccessTokenCallbackClass() Returns the fully qualified class name of the implementing class for SQLServerAccessTokenCallback.
abstract boolean	getCalcBigDecimalPrecision() Returns the current flag for calcBigDecimalPrecision.
abstract java.util.UUID	getClientConnectionId() Returns the connection ID of the most recent connection attempt, regardless of whether the attempt succeeded or failed.
abstract java.lang.String	getDatetimeParameterType() Returns the value of the datetimeParameterType property.
abstract boolean	getDelayLoadingLobs() Returns the current flag value for delayLoadingLobs.
abstract boolean	getDisableStatementPooling() Returns the value whether statement pooling is disabled.
abstract int	getDiscardedServerPreparedStatementCount() Returns the number of currently outstanding prepared statement un-prepare actions.
abstract boolean	getEnablePrepareOnFirstPreparedStatementCall() Returns the behavior for a specific connection instance.
abstract java.lang.String	getIPAddressPreference() Gets the name of the preferred type of IP Address.
abstract boolean	getIgnoreOffsetOnDateTimeOffsetConversion() Returns the current flag value for ignoreOffsetOnDateTimeOffsetConversion.
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.
abstract java.lang.String	getPrepareMethod() Returns the behavior for a specific connection instance.
abstract boolean	getSendTimeAsDatetime() Returns the value of the sendTimeAsDatetime property.
abstract ISQLServerMessageHandler	getServerMessageHandler() Get Currently installed message handler on the connection
abstract int	getServerPreparedStatementDiscardThreshold() Returns the behavior for a specific connection instance.
abstract int	getStatementHandleCacheEntryCount() Returns the current number of pooled prepared statement handles.
abstract int	getStatementPoolingCacheSize() Returns the size of the prepared statement cache for this connection.
abstract boolean	getUseBulkCopyForBatchInsert() Returns the useBulkCopyForBatchInsert value.
abstract boolean	getUseFmtOnly() Returns the current flag value for useFmtOnly.
abstract boolean	getcacheBulkCopyMetadata() Sets the value for 'cacheBulkCopyMetadata' property
abstract boolean	isStatementPoolingEnabled() Returns whether statement pooling is enabled or not for this connection.
abstract java.sql.CallableStatement	prepareCall(String sql, int nType, int nConcur, int nHold, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
abstract java.sql.PreparedStatement	prepareStatement(String sql, int flag, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
abstract java.sql.PreparedStatement	prepareStatement(String sql, int nType, int nConcur, int resultSetHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
abstract java.sql.PreparedStatement	prepareStatement(String sql, int[] columnIndexes, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
abstract java.sql.PreparedStatement	prepareStatement(String sql, String[] columnNames, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
abstract void	setAccessTokenCallbackClass(String accessTokenCallbackClass) Sets 'accessTokenCallbackClass' to the fully qualified class name of the implementing class for SQLServerAccessTokenCallback.
abstract void	setCalcBigDecimalPrecision(boolean calcBigDecimalPrecision) Specifies whether to calculate precision from inputted big decimal values.
abstract void	setDatetimeParameterType(String datetimeParameterTypeValue) Sets the value of the datetimeParameterType connection property, which controls how date and time parameters are sent to the server against SQL Server 2008+.
abstract void	setDelayLoadingLobs(boolean delayLoadingLobs) Specifies the flag to immediately load LOB objects into memory.
abstract void	setDisableStatementPooling(boolean value) Sets the value to Disable/enable statement pooling.
abstract void	setEnablePrepareOnFirstPreparedStatementCall(boolean value) Sets the behavior for a specific connection instance.
abstract void	setIPAddressPreference(String iPAddressPreference) Sets the name of the preferred type of IP Address.
abstract void	setIgnoreOffsetOnDateTimeOffsetConversion(boolean ignoreOffsetOnDateTimeOffsetConversion) Specifies the flag to ignore offset when converting DATETIMEOFFSET to LocalDateTime.
abstract void	setMsiTokenCacheTtl(int timeToLive) Deprecated Time-to-live is no longer supported for the cached Managed Identity tokens. Time-to-live is no longer supported for the cached Managed Identity tokens.
abstract void	setPrepareMethod(String prepareMethod) Sets the behavior for the prepare method.
abstract void	setSendTimeAsDatetime(boolean sendTimeAsDateTimeValue) Sets the value of the sendTimeAsDatetime connection property.
abstract ISQLServerMessageHandler	setServerMessageHandler(ISQLServerMessageHandler messageHandler) Set message handler on the connection
abstract void	setServerPreparedStatementDiscardThreshold(int value) Sets the behavior for a specific connection instance.
abstract void	setStatementPoolingCacheSize(int value) Sets the size of the prepared statement cache for this connection.
abstract void	setUseBulkCopyForBatchInsert(boolean useBulkCopyForBatchInsert) Specifies the flag for using Bulk Copy API for batch insert operations.
abstract void	setUseFmtOnly(boolean useFmtOnly) Specifies the flag to use FMTONLY for parameter metadata queries.
abstract void	setcacheBulkCopyMetadata(boolean cacheBulkCopyMetadata) Returns value of 'cacheBulkCopyMetadata' from Connection String.

Field Details

TRANSACTION_SNAPSHOT

public static final int TRANSACTION_SNAPSHOT

Transaction types "TRANSACTION_SNAPSHOT corresponds to" "SET TRANSACTION ISOLATION LEVEL SNAPSHOT"

Method Details

closeUnreferencedPreparedStatementHandles

public abstract void closeUnreferencedPreparedStatementHandles()

Forces the un-prepare requests for any outstanding discarded prepared statements to be executed.

createStatement

public abstract Statement createStatement(int nType, int nConcur, int nHold, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)

Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability. This method is the same as the createStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Parameters:

nType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

nConcur - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

nHold - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

stmtColEncSetting - Specifies how data will be sent and received when reading and writing encrypted columns.

Returns:

a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability

Throws:

SQLServerException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

getAccessTokenCallbackClass

public abstract String getAccessTokenCallbackClass()

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

Returns:

accessTokenCallbackClass

getCalcBigDecimalPrecision

public abstract boolean getCalcBigDecimalPrecision()

Returns the current flag for calcBigDecimalPrecision.

Returns:

calcBigDecimalPrecision Whether calculating big decimal precision from input values is enabled.

getClientConnectionId

public abstract UUID getClientConnectionId()

Returns the connection ID of the most recent connection attempt, regardless of whether the attempt succeeded or failed.

Returns:

16-byte GUID representing the connection ID of the most recent connection attempt. Or, NULL if there is a failure after the connection request is initiated and the pre-login handshake.

Throws:

SQLServerException - If any errors occur.

getDatetimeParameterType

public abstract String getDatetimeParameterType()

Returns the value of the datetimeParameterType property.

Returns:

The string value of the datetimeParameterType property.

Throws:

SQLServerException - if a database access error occurs

getDelayLoadingLobs

public abstract boolean getDelayLoadingLobs()

Returns the current flag value for delayLoadingLobs.

Returns:

'delayLoadingLobs' property value.

getDisableStatementPooling

public abstract boolean getDisableStatementPooling()

Returns the value whether statement pooling is disabled.

Returns:

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

getDiscardedServerPreparedStatementCount

public abstract int getDiscardedServerPreparedStatementCount()

Returns the number of currently outstanding prepared statement un-prepare actions.

Returns:

Returns the current value per the description.

getEnablePrepareOnFirstPreparedStatementCall

public abstract boolean getEnablePrepareOnFirstPreparedStatementCall()

Returns the behavior for a specific connection instance. If false the first execution 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. The default for this option can be changed by calling setDefaultEnablePrepareOnFirstPreparedStatementCall().

Returns:

Returns the current setting per the description.

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.

getIgnoreOffsetOnDateTimeOffsetConversion

public abstract boolean getIgnoreOffsetOnDateTimeOffsetConversion()

Returns the current flag value for ignoreOffsetOnDateTimeOffsetConversion.

Returns:

'ignoreOffsetOnDateTimeOffsetConversion' property value.

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.

getPrepareMethod

public abstract String getPrepareMethod()

Returns the behavior for a specific connection instance. PrepareMethod

Returns:

Returns current setting for prepareMethod connection property.

getSendTimeAsDatetime

public abstract boolean getSendTimeAsDatetime()

Returns the value of the sendTimeAsDatetime property.

Returns:

boolean value of sendTimeAsDatetime

Throws:

SQLServerException - if a database access error occurs

getServerMessageHandler

public abstract ISQLServerMessageHandler getServerMessageHandler()

Get Currently installed message handler on the connection

Returns:

ISQLServerMessageHandler

getServerPreparedStatementDiscardThreshold

public abstract int getServerPreparedStatementDiscardThreshold()

Returns the behavior for a specific connection instance. This setting 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 immediately 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. The default for this option can be changed by calling getDefaultServerPreparedStatementDiscardThreshold().

Returns:

Returns the current setting per the description.

getStatementHandleCacheEntryCount

public abstract int getStatementHandleCacheEntryCount()

Returns the current number of pooled prepared statement handles.

Returns:

Returns the current setting per the description.

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.

getUseBulkCopyForBatchInsert

public abstract boolean getUseBulkCopyForBatchInsert()

Returns the useBulkCopyForBatchInsert value.

Returns:

flag for using Bulk Copy API for batch insert operations.

getUseFmtOnly

public abstract boolean getUseFmtOnly()

Returns the current flag value for useFmtOnly.

Returns:

'useFmtOnly' property value.

getcacheBulkCopyMetadata

public abstract boolean getcacheBulkCopyMetadata()

Sets the value for 'cacheBulkCopyMetadata' property

Returns:

cacheBulkCopyMetadata boolean value

isStatementPoolingEnabled

public abstract boolean isStatementPoolingEnabled()

Returns whether statement pooling is enabled or not for this connection.

Returns:

Returns the current setting per the description.

prepareCall

public abstract CallableStatement prepareCall(String sql, int nType, int nConcur, int nHold, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)

Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.

Parameters:

sql - a String object that is the SQL statement to be sent to the database; may contain on or more '?' parameters

nType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

nConcur - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

nHold - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

stmtColEncSetting - Specifies how data will be sent and received when reading and writing encrypted columns.

Returns:

a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability

Throws:

SQLServerException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

prepareStatement

public abstract PreparedStatement prepareStatement(String sql, int flag, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)

Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys. The given constant tells the driver whether it should make auto-generated keys available for retrieval. This parameter is ignored if the SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling #getHoldability.

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

flag - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS

stmtColEncSetting - Specifies how data will be sent and received when reading and writing encrypted columns.

Returns:

a new PreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys

Throws:

SQLServerException - if a database access error occurs, this method is called on a closed connection or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned

prepareStatement

public abstract PreparedStatement prepareStatement(String sql, int nType, int nConcur, int resultSetHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)

Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.

This method is the same as the prepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Parameters:

sql - a String object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters

nType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

nConcur - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

stmtColEncSetting - Specifies how data will be sent and received when reading and writing encrypted columns.

Returns:

a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability

Throws:

SQLServerException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

prepareStatement

public abstract PreparedStatement prepareStatement(String sql, int[] columnIndexes, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling #getHoldability.

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows

stmtColEncSetting - Specifies how data will be sent and received when reading and writing encrypted columns.

Returns:

a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes

Throws:

SQLServerException - if a database access error occurs or this method is called on a closed connection

prepareStatement

public abstract PreparedStatement prepareStatement(String sql, String[] columnNames, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the names of the columns in the target table that contain the auto-generated keys that should be returned. The driver will ignore the array if the SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling #getHoldability.

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows

stmtColEncSetting - Specifies how data will be sent and received when reading and writing encrypted columns.

Returns:

a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names

Throws:

SQLServerException - if a database access error occurs or this method is called on a closed connection

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

setCalcBigDecimalPrecision

public abstract void setCalcBigDecimalPrecision(boolean calcBigDecimalPrecision)

Specifies whether to calculate precision from inputted big decimal values.

Parameters:

calcBigDecimalPrecision - A boolean that indicates if the driver should calculate precision from inputted big decimal values.

setDatetimeParameterType

public abstract void setDatetimeParameterType(String datetimeParameterTypeValue)

Sets the value of the datetimeParameterType connection property, which controls how date and time parameters are sent to the server against SQL Server 2008+. This setting can affect server-side date conversions and comparisons during statement execution, particularly against SQL Server 2016+. By default, the value is set to "datetime2". Valid values are: datetime, datetime2 or datetimeoffset.

Parameters:

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

Throws:

SQLServerException - if a database access error occurs

setDelayLoadingLobs

public abstract void setDelayLoadingLobs(boolean delayLoadingLobs)

Specifies the flag to immediately load LOB objects into memory.

Parameters:

delayLoadingLobs - boolean value for 'delayLoadingLobs'.

setDisableStatementPooling

public abstract void setDisableStatementPooling(boolean value)

Sets the value to Disable/enable statement pooling.

Parameters:

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

setEnablePrepareOnFirstPreparedStatementCall

public abstract void setEnablePrepareOnFirstPreparedStatementCall(boolean value)

Sets the behavior for a specific connection instance. If value is false the first execution 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:

value - Changes the setting per the description.

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.

setIgnoreOffsetOnDateTimeOffsetConversion

public abstract void setIgnoreOffsetOnDateTimeOffsetConversion(boolean ignoreOffsetOnDateTimeOffsetConversion)

Specifies the flag to ignore offset when converting DATETIMEOFFSET to LocalDateTime.

Parameters:

ignoreOffsetOnDateTimeOffsetConversion - boolean value for 'ignoreOffsetOnDateTimeOffsetConversion'.

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.

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.

setPrepareMethod

public abstract void setPrepareMethod(String prepareMethod)

Sets the behavior for the prepare method. PrepareMethod

Parameters:

prepareMethod - Changes the setting as per description

setSendTimeAsDatetime

public abstract void setSendTimeAsDatetime(boolean sendTimeAsDateTimeValue)

Sets the value of the sendTimeAsDatetime connection property. When true, java.sql.Time values will be sent to the server as SQL Serverdatetime values. When false, java.sql.Time values will be sent to the server as SQL Servertime values. sendTimeAsDatetime can also be modified programmatically with SQLServerDataSource.setSendTimeAsDatetime. The default value for this property may change in a future release.

Parameters:

sendTimeAsDateTimeValue - enables/disables setting the sendTimeAsDatetime connection property. 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.

Throws:

SQLServerException - if a database access error occurs

setServerMessageHandler

public abstract ISQLServerMessageHandler setServerMessageHandler(ISQLServerMessageHandler messageHandler)

Set message handler on the connection

Parameters:

messageHandler - message handler

Returns:

ISQLServerMessageHandler

setServerPreparedStatementDiscardThreshold

public abstract void setServerPreparedStatementDiscardThreshold(int value)

Sets the behavior for a specific connection instance. This setting 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:

value - Changes the setting per the description.

setStatementPoolingCacheSize

public abstract void setStatementPoolingCacheSize(int value)

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

Parameters:

value - The new cache size.

setUseBulkCopyForBatchInsert

public abstract void setUseBulkCopyForBatchInsert(boolean useBulkCopyForBatchInsert)

Specifies the flag for using Bulk Copy API for batch insert operations.

Parameters:

useBulkCopyForBatchInsert - boolean value for useBulkCopyForBatchInsert.

setUseFmtOnly

public abstract void setUseFmtOnly(boolean useFmtOnly)

Specifies the flag to use FMTONLY for parameter metadata queries.

Parameters:

useFmtOnly - boolean value for 'useFmtOnly'.

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