Class SQLServerConnection
- java.lang.Object
-
- com.microsoft.sqlserver.jdbc.SQLServerConnection
-
- All Implemented Interfaces:
ISQLServerConnection,Serializable,AutoCloseable,Connection,Wrapper
- Direct Known Subclasses:
SQLServerConnection43
public class SQLServerConnection extends Object implements ISQLServerConnection, Serializable
Provides an implementation java.sql.connection interface that assists creating a JDBC connection to SQL Server. SQLServerConnections support JDBC connection pooling and may be either physical JDBC connections or logical JDBC connections. SQLServerConnection manages transaction control for all statements that were created from it. SQLServerConnection may participate in XA distributed transactions managed via an XAResource adapter. SQLServerConnection instantiates a new TDSChannel object for use by itself and all statement objects that are created under this connection. SQLServerConnection manages a pool of prepared statement handles. Prepared statements are prepared once and typically executed many times with different data values for their parameters. Prepared statements are also maintained across logical (pooled) connection closes. SQLServerConnection is not thread safe, however multiple statements created from a single connection can be processing simultaneously in concurrent threads. This class's public functions need to be kept identical to the SQLServerConnectionPoolProxy's. The API javadoc for JDBC API methods that this class implements are not repeated here. Please see Sun's JDBC API interfaces javadoc for those details. NOTE: All the public functions in this class also need to be defined in SQLServerConnectionPoolProxy Declare all new custom (non-static) Public APIs in ISQLServerConnection interface such that they can also be implemented by SQLServerConnectionPoolProxy- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
-
Fields inherited from interface com.microsoft.sqlserver.jdbc.ISQLServerConnection
TRANSACTION_SNAPSHOT
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidabort(Executor executor)static voidclearUserTokenCache()Clears User token cache.voidclearWarnings()voidclose()voidcloseUnreferencedPreparedStatementHandles()Forces the un-prepare requests for any outstanding discarded prepared statements to be executed.voidcommit()voidcommit(boolean delayedDurability)Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by thisConnectionobject.ArraycreateArrayOf(String typeName, Object[] elements)BlobcreateBlob()ClobcreateClob()NClobcreateNClob()SQLXMLcreateSQLXML()StatementcreateStatement()StatementcreateStatement(int resultSetType, int resultSetConcurrency)StatementcreateStatement(int nType, int nConcur, int resultSetHoldability)StatementcreateStatement(int nType, int nConcur, int resultSetHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)Creates aStatementobject that will generateResultSetobjects with the given type, concurrency, and holdability.StructcreateStruct(String typeName, Object[] attributes)StringgetAccessTokenCallbackClass()Returns the fully qualified class name of the implementing class forSQLServerAccessTokenCallback.booleangetAutoCommit()booleangetcacheBulkCopyMetadata()Sets the value for 'cacheBulkCopyMetadata' propertybooleangetCalcBigDecimalPrecision()Returns the current flag for calcBigDecimalPrecision.StringgetCatalog()UUIDgetClientConnectionId()Returns the connection ID of the most recent connection attempt, regardless of whether the attempt succeeded or failed.PropertiesgetClientInfo()StringgetClientInfo(String name)static Map<String,List<String>>getColumnEncryptionTrustedMasterKeyPaths()Returns the Trusted Master Key Paths.StringgetDatetimeParameterType()Returns the value of the datetimeParameterType property.booleangetDelayLoadingLobs()Returns the current flag value for delayLoadingLobs.booleangetDisableStatementPooling()Returns the value whether statement pooling is disabled.intgetDiscardedServerPreparedStatementCount()Returns the number of currently outstanding prepared statement un-prepare actions.booleangetEnablePrepareOnFirstPreparedStatementCall()Returns the behavior for a specific connection instance.intgetHoldability()booleangetIgnoreOffsetOnDateTimeOffsetConversion()Returns the current flag value for ignoreOffsetOnDateTimeOffsetConversion.StringgetIPAddressPreference()Gets the name of the preferred type of IP Address.DatabaseMetaDatagetMetaData()intgetMsiTokenCacheTtl()Deprecated, for removal: This API element is subject to removal in a future version.Time-to-live is no longer supported for the cached Managed Identity tokens.intgetNetworkTimeout()StringgetPrepareMethod()Returns the behavior for a specific connection instance.StringgetSchema()booleangetSendTimeAsDatetime()Returns the value of the sendTimeAsDatetime property.ISQLServerMessageHandlergetServerMessageHandler()Get Currently installed message handler on the connectionintgetServerPreparedStatementDiscardThreshold()Returns the behavior for a specific connection instance.intgetStatementHandleCacheEntryCount()Returns the current number of pooled prepared statement handles.intgetStatementPoolingCacheSize()Returns the size of the prepared statement cache for this connection.intgetTransactionIsolation()Map<String,Class<?>>getTypeMap()booleangetUseBulkCopyForBatchInsert()Returns the useBulkCopyForBatchInsert value.booleangetUseFlexibleCallableStatements()Returns whether or not sp_sproc_columns is being used for parameter name lookup.booleangetUseFmtOnly()Returns the current flag value for useFmtOnly.SQLWarninggetWarnings()booleanisClosed()booleanisReadOnly()booleanisStatementPoolingEnabled()Returns whether statement pooling is enabled or not for this connection.booleanisValid(int timeout)Determine whether the connection is still valid.booleanisWrapperFor(Class<?> iface)StringnativeSQL(String sql)protected booleanneedsReconnect()Returns if Federated Authentication is in use or is about to expire soonCallableStatementprepareCall(String sql)CallableStatementprepareCall(String sql, int resultSetType, int resultSetConcurrency)CallableStatementprepareCall(String sql, int nType, int nConcur, int resultSetHoldability)CallableStatementprepareCall(String sql, int nType, int nConcur, int resultSetHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetiing)Creates aCallableStatementobject that will generateResultSetobjects with the given type and concurrency.PreparedStatementprepareStatement(String sql)PreparedStatementprepareStatement(String sql, int flag)PreparedStatementprepareStatement(String sql, int[] columnIndexes)PreparedStatementprepareStatement(String sql, int[] columnIndexes, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)Creates a defaultPreparedStatementobject capable of returning the auto-generated keys designated by the given array.PreparedStatementprepareStatement(String sql, int resultSetType, int resultSetConcurrency)PreparedStatementprepareStatement(String sql, int nType, int nConcur, int resultSetHoldability)PreparedStatementprepareStatement(String sql, int nType, int nConcur, int resultSetHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)Creates aPreparedStatementobject that will generateResultSetobjects with the given type, concurrency, and holdability.PreparedStatementprepareStatement(String sql, int flag, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)Creates a defaultPreparedStatementobject that has the capability to retrieve auto-generated keys.PreparedStatementprepareStatement(String sql, String[] columnNames)PreparedStatementprepareStatement(String sql, String[] columnNames, SQLServerStatementColumnEncryptionSetting stmtColEncSetting)Creates a defaultPreparedStatementobject capable of returning the auto-generated keys designated by the given array.voidregisterBeforeReconnectListener(ReconnectListener reconnectListener)static voidregisterColumnEncryptionKeyStoreProviders(Map<String,SQLServerColumnEncryptionKeyStoreProvider> clientKeyStoreProviders)Registers key store providers in the globalCustomColumnEncryptionKeyStoreProviders.voidregisterColumnEncryptionKeyStoreProvidersOnConnection(Map<String,SQLServerColumnEncryptionKeyStoreProvider> clientKeyStoreProviders)Registers connection-level key store providers, replacing all existing providers.voidreleaseSavepoint(Savepoint savepoint)voidremoveBeforeReconnectListener(ReconnectListener reconnectListener)static voidremoveColumnEncryptionTrustedMasterKeyPaths(String server)Removes the trusted Master key Path from the columnEncryptionTrustedMasterKeyPaths.voidrollback()voidrollback(Savepoint s)voidsetAccessTokenCallbackClass(String accessTokenCallbackClass)Sets 'accessTokenCallbackClass' to the fully qualified class name of the implementing class forSQLServerAccessTokenCallback.voidsetAutoCommit(boolean newAutoCommitMode)voidsetcacheBulkCopyMetadata(boolean value)Returns value of 'cacheBulkCopyMetadata' from Connection String.voidsetCalcBigDecimalPrecision(boolean calcBigDecimalPrecision)Specifies whether to calculate precision from inputted big decimal values.voidsetCatalog(String catalog)voidsetClientInfo(String name, String value)voidsetClientInfo(Properties properties)static voidsetColumnEncryptionKeyCacheTtl(int columnEncryptionKeyCacheTTL, TimeUnit unit)Sets time-to-live for column encryption key entries in the column encryption key cache for the Always Encrypted feature.static voidsetColumnEncryptionTrustedMasterKeyPaths(Map<String,List<String>> trustedKeyPaths)Sets Trusted Master Key Paths in the columnEncryptionTrustedMasterKeyPaths.voidsetDatetimeParameterType(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+.voidsetDelayLoadingLobs(boolean b)Specifies the flag to immediately load LOB objects into memory.voidsetDisableStatementPooling(boolean value)Sets the value to Disable/enable statement pooling.voidsetEnablePrepareOnFirstPreparedStatementCall(boolean value)Sets the behavior for a specific connection instance.voidsetHoldability(int holdability)voidsetIgnoreOffsetOnDateTimeOffsetConversion(boolean ignoreOffsetOnDateTimeOffsetConversion)Specifies the flag to ignore offset when converting DATETIMEOFFSET to LocalDateTime.voidsetIPAddressPreference(String iPAddressPreference)Sets the name of the preferred type of IP Address.voidsetMsiTokenCacheTtl(int timeToLive)Deprecated, for removal: This API element is subject to removal in a future version.Time-to-live is no longer supported for the cached Managed Identity tokens.voidsetNetworkTimeout(Executor executor, int timeout)voidsetPrepareMethod(String prepareMethod)Sets the behavior for the prepare method.voidsetReadOnly(boolean readOnly)SavepointsetSavepoint()SavepointsetSavepoint(String sName)voidsetSchema(String schema)voidsetSendTimeAsDatetime(boolean sendTimeAsDateTimeValue)Sets the value of the sendTimeAsDatetime connection property.ISQLServerMessageHandlersetServerMessageHandler(ISQLServerMessageHandler messageHandler)Set current message handlervoidsetServerPreparedStatementDiscardThreshold(int value)Sets the behavior for a specific connection instance.voidsetStatementPoolingCacheSize(int value)Sets the size of the prepared statement cache for this connection.voidsetTransactionIsolation(int level)voidsetTypeMap(Map<String,Class<?>> map)voidsetUseBulkCopyForBatchInsert(boolean useBulkCopyForBatchInsert)Specifies the flag for using Bulk Copy API for batch insert operations.voidsetUseFlexibleCallableStatements(boolean useFlexibleCallableStatements)Sets whether or not sp_sproc_columns will be used for parameter name lookup.voidsetUseFmtOnly(boolean useFmtOnly)Specifies the flag to use FMTONLY for parameter metadata queries.StringtoString()Provides a helper function to return an ID string suitable for tracing.static voidunregisterColumnEncryptionKeyStoreProviders()Unregisters all the custom key store providers from the globalCustomColumnEncryptionKeyStoreProviders by clearing the map and setting it to null.<T> Tunwrap(Class<T> iface)static voidupdateColumnEncryptionTrustedMasterKeyPaths(String server, List<String> trustedKeyPaths)Updates the columnEncryptionTrustedMasterKeyPaths with the new Server and trustedKeyPaths.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.sql.Connection
beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid
-
-
-
-
Method Detail
-
getUseBulkCopyForBatchInsert
public boolean getUseBulkCopyForBatchInsert()
Returns the useBulkCopyForBatchInsert value.- Specified by:
getUseBulkCopyForBatchInsertin interfaceISQLServerConnection- Returns:
- flag for using Bulk Copy API for batch insert operations.
-
setUseBulkCopyForBatchInsert
public void setUseBulkCopyForBatchInsert(boolean useBulkCopyForBatchInsert)
Specifies the flag for using Bulk Copy API for batch insert operations.- Specified by:
setUseBulkCopyForBatchInsertin interfaceISQLServerConnection- Parameters:
useBulkCopyForBatchInsert- boolean value for useBulkCopyForBatchInsert.
-
getSendTimeAsDatetime
public final boolean getSendTimeAsDatetime()
Description copied from interface:ISQLServerConnectionReturns the value of the sendTimeAsDatetime property.- Specified by:
getSendTimeAsDatetimein interfaceISQLServerConnection- Returns:
- boolean value of sendTimeAsDatetime
-
getDatetimeParameterType
public final String getDatetimeParameterType()
Description copied from interface:ISQLServerConnectionReturns the value of the datetimeParameterType property.- Specified by:
getDatetimeParameterTypein interfaceISQLServerConnection- Returns:
- The string value of the datetimeParameterType property.
-
getDelayLoadingLobs
public boolean getDelayLoadingLobs()
Description copied from interface:ISQLServerConnectionReturns the current flag value for delayLoadingLobs.- Specified by:
getDelayLoadingLobsin interfaceISQLServerConnection- Returns:
- 'delayLoadingLobs' property value.
-
setDelayLoadingLobs
public void setDelayLoadingLobs(boolean b)
Description copied from interface:ISQLServerConnectionSpecifies the flag to immediately load LOB objects into memory.- Specified by:
setDelayLoadingLobsin interfaceISQLServerConnection- Parameters:
b- boolean value for 'delayLoadingLobs'.
-
getIgnoreOffsetOnDateTimeOffsetConversion
public boolean getIgnoreOffsetOnDateTimeOffsetConversion()
Description copied from interface:ISQLServerConnectionReturns the current flag value for ignoreOffsetOnDateTimeOffsetConversion.- Specified by:
getIgnoreOffsetOnDateTimeOffsetConversionin interfaceISQLServerConnection- Returns:
- 'ignoreOffsetOnDateTimeOffsetConversion' property value.
-
setIgnoreOffsetOnDateTimeOffsetConversion
public void setIgnoreOffsetOnDateTimeOffsetConversion(boolean ignoreOffsetOnDateTimeOffsetConversion)
Description copied from interface:ISQLServerConnectionSpecifies the flag to ignore offset when converting DATETIMEOFFSET to LocalDateTime.- Specified by:
setIgnoreOffsetOnDateTimeOffsetConversionin interfaceISQLServerConnection- Parameters:
ignoreOffsetOnDateTimeOffsetConversion- boolean value for 'ignoreOffsetOnDateTimeOffsetConversion'.
-
getCalcBigDecimalPrecision
public boolean getCalcBigDecimalPrecision()
Description copied from interface:ISQLServerConnectionReturns the current flag for calcBigDecimalPrecision.- Specified by:
getCalcBigDecimalPrecisionin interfaceISQLServerConnection- Returns:
- calcBigDecimalPrecision Whether calculating big decimal precision from input values is enabled.
-
setCalcBigDecimalPrecision
public void setCalcBigDecimalPrecision(boolean calcBigDecimalPrecision)
Description copied from interface:ISQLServerConnectionSpecifies whether to calculate precision from inputted big decimal values.- Specified by:
setCalcBigDecimalPrecisionin interfaceISQLServerConnection- Parameters:
calcBigDecimalPrecision- A boolean that indicates if the driver should calculate precision from inputted big decimal values.
-
registerColumnEncryptionKeyStoreProviders
public static void registerColumnEncryptionKeyStoreProviders(Map<String,SQLServerColumnEncryptionKeyStoreProvider> clientKeyStoreProviders) throws SQLServerException
Registers key store providers in the globalCustomColumnEncryptionKeyStoreProviders.- Parameters:
clientKeyStoreProviders- a map containing the store providers information.- Throws:
SQLServerException- when an error occurs
-
unregisterColumnEncryptionKeyStoreProviders
public static void unregisterColumnEncryptionKeyStoreProviders()
Unregisters all the custom key store providers from the globalCustomColumnEncryptionKeyStoreProviders by clearing the map and setting it to null.
-
registerColumnEncryptionKeyStoreProvidersOnConnection
public void registerColumnEncryptionKeyStoreProvidersOnConnection(Map<String,SQLServerColumnEncryptionKeyStoreProvider> clientKeyStoreProviders) throws SQLServerException
Registers connection-level key store providers, replacing all existing providers.- Parameters:
clientKeyStoreProviders- a map containing the store providers information.- Throws:
SQLServerException- when an error occurs
-
setColumnEncryptionTrustedMasterKeyPaths
public static void setColumnEncryptionTrustedMasterKeyPaths(Map<String,List<String>> trustedKeyPaths)
Sets Trusted Master Key Paths in the columnEncryptionTrustedMasterKeyPaths.- Parameters:
trustedKeyPaths- all master key paths that are trusted
-
updateColumnEncryptionTrustedMasterKeyPaths
public static void updateColumnEncryptionTrustedMasterKeyPaths(String server, List<String> trustedKeyPaths)
Updates the columnEncryptionTrustedMasterKeyPaths with the new Server and trustedKeyPaths.- Parameters:
server- String server nametrustedKeyPaths- all master key paths that are trusted
-
removeColumnEncryptionTrustedMasterKeyPaths
public static void removeColumnEncryptionTrustedMasterKeyPaths(String server)
Removes the trusted Master key Path from the columnEncryptionTrustedMasterKeyPaths.- Parameters:
server- String server name
-
getColumnEncryptionTrustedMasterKeyPaths
public static Map<String,List<String>> getColumnEncryptionTrustedMasterKeyPaths()
Returns the Trusted Master Key Paths.- Returns:
- columnEncryptionTrustedMasterKeyPaths.
-
clearUserTokenCache
public static void clearUserTokenCache()
Clears User token cache. This will clear all account info so interactive login will be required on the next request to acquire an access token.
-
getClientConnectionId
public UUID getClientConnectionId() throws SQLServerException
Description copied from interface:ISQLServerConnectionReturns the connection ID of the most recent connection attempt, regardless of whether the attempt succeeded or failed.- Specified by:
getClientConnectionIdin interfaceISQLServerConnection- 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.
-
registerBeforeReconnectListener
public void registerBeforeReconnectListener(ReconnectListener reconnectListener)
-
removeBeforeReconnectListener
public void removeBeforeReconnectListener(ReconnectListener reconnectListener)
-
toString
public String toString()
Provides a helper function to return an ID string suitable for tracing.
-
needsReconnect
protected boolean needsReconnect()
Returns if Federated Authentication is in use or is about to expire soon- Returns:
- true/false
-
createStatement
public Statement createStatement() throws SQLServerException
- Specified by:
createStatementin interfaceConnection- Throws:
SQLServerException
-
prepareStatement
public PreparedStatement prepareStatement(String sql) throws SQLServerException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLServerException
-
prepareCall
public CallableStatement prepareCall(String sql) throws SQLServerException
- Specified by:
prepareCallin interfaceConnection- Throws:
SQLServerException
-
nativeSQL
public String nativeSQL(String sql) throws SQLServerException
- Specified by:
nativeSQLin interfaceConnection- Throws:
SQLServerException
-
setAutoCommit
public void setAutoCommit(boolean newAutoCommitMode) throws SQLServerException- Specified by:
setAutoCommitin interfaceConnection- Throws:
SQLServerException
-
getAutoCommit
public boolean getAutoCommit() throws SQLServerException- Specified by:
getAutoCommitin interfaceConnection- Throws:
SQLServerException
-
commit
public void commit() throws SQLServerException- Specified by:
commitin interfaceConnection- Throws:
SQLServerException
-
commit
public void commit(boolean delayedDurability) throws SQLServerExceptionMakes all changes made since the previous commit/rollback permanent and releases any database locks currently held by thisConnectionobject. This method should be used only when auto-commit mode has been disabled.- Parameters:
delayedDurability- flag to indicate whether the commit will occur with delayed durability on.- Throws:
SQLServerException- Exception if a database access error occurs
-
rollback
public void rollback() throws SQLServerException- Specified by:
rollbackin interfaceConnection- Throws:
SQLServerException
-
abort
public void abort(Executor executor) throws SQLException
- Specified by:
abortin interfaceConnection- Throws:
SQLException
-
close
public void close() throws SQLServerException- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceConnection- Throws:
SQLServerException
-
isClosed
public boolean isClosed() throws SQLServerException- Specified by:
isClosedin interfaceConnection- Throws:
SQLServerException
-
getMetaData
public DatabaseMetaData getMetaData() throws SQLServerException
- Specified by:
getMetaDatain interfaceConnection- Throws:
SQLServerException
-
setReadOnly
public void setReadOnly(boolean readOnly) throws SQLServerException- Specified by:
setReadOnlyin interfaceConnection- Throws:
SQLServerException
-
isReadOnly
public boolean isReadOnly() throws SQLServerException- Specified by:
isReadOnlyin interfaceConnection- Throws:
SQLServerException
-
setCatalog
public void setCatalog(String catalog) throws SQLServerException
- Specified by:
setCatalogin interfaceConnection- Throws:
SQLServerException
-
getCatalog
public String getCatalog() throws SQLServerException
- Specified by:
getCatalogin interfaceConnection- Throws:
SQLServerException
-
setTransactionIsolation
public void setTransactionIsolation(int level) throws SQLServerException- Specified by:
setTransactionIsolationin interfaceConnection- Throws:
SQLServerException
-
getTransactionIsolation
public int getTransactionIsolation() throws SQLServerException- Specified by:
getTransactionIsolationin interfaceConnection- Throws:
SQLServerException
-
getWarnings
public SQLWarning getWarnings() throws SQLServerException
- Specified by:
getWarningsin interfaceConnection- Throws:
SQLServerException
-
clearWarnings
public void clearWarnings() throws SQLServerException- Specified by:
clearWarningsin interfaceConnection- Throws:
SQLServerException
-
createStatement
public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLServerException
- Specified by:
createStatementin interfaceConnection- Throws:
SQLServerException
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLServerException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLServerException
-
prepareCall
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLServerException
- Specified by:
prepareCallin interfaceConnection- Throws:
SQLServerException
-
setTypeMap
public void setTypeMap(Map<String,Class<?>> map) throws SQLException
- Specified by:
setTypeMapin interfaceConnection- Throws:
SQLException
-
getTypeMap
public Map<String,Class<?>> getTypeMap() throws SQLServerException
- Specified by:
getTypeMapin interfaceConnection- Throws:
SQLServerException
-
createStatement
public Statement createStatement(int nType, int nConcur, int resultSetHoldability) throws SQLServerException
- Specified by:
createStatementin interfaceConnection- Throws:
SQLServerException
-
createStatement
public Statement createStatement(int nType, int nConcur, int resultSetHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) throws SQLServerException
Description copied from interface:ISQLServerConnectionCreates aStatementobject that will generateResultSetobjects with the given type, concurrency, and holdability. This method is the same as thecreateStatementmethod above, but it allows the default result set type, concurrency, and holdability to be overridden.- Specified by:
createStatementin interfaceISQLServerConnection- Parameters:
nType- one of the followingResultSetconstants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEnConcur- one of the followingResultSetconstants:ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLEresultSetHoldability- one of the followingResultSetconstants:ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMITstmtColEncSetting- Specifies how data will be sent and received when reading and writing encrypted columns.- Returns:
- a new
Statementobject that will generateResultSetobjects 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 notResultSetconstants indicating type, concurrency, and holdability
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int nType, int nConcur, int resultSetHoldability) throws SQLServerException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLServerException
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int nType, int nConcur, int resultSetHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) throws SQLServerException
Description copied from interface:ISQLServerConnectionCreates aPreparedStatementobject that will generateResultSetobjects with the given type, concurrency, and holdability.This method is the same as the
prepareStatementmethod above, but it allows the default result set type, concurrency, and holdability to be overridden.- Specified by:
prepareStatementin interfaceISQLServerConnection- Parameters:
sql- aStringobject that is the SQL statement to be sent to the database; may contain one or more '?' IN parametersnType- one of the followingResultSetconstants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEnConcur- one of the followingResultSetconstants:ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLEresultSetHoldability- one of the followingResultSetconstants:ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMITstmtColEncSetting- Specifies how data will be sent and received when reading and writing encrypted columns.- Returns:
- a new
PreparedStatementobject, containing the pre-compiled SQL statement, that will generateResultSetobjects 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 notResultSetconstants indicating type, concurrency, and holdability
-
prepareCall
public CallableStatement prepareCall(String sql, int nType, int nConcur, int resultSetHoldability) throws SQLServerException
- Specified by:
prepareCallin interfaceConnection- Throws:
SQLServerException
-
prepareCall
public CallableStatement prepareCall(String sql, int nType, int nConcur, int resultSetHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetiing) throws SQLServerException
Description copied from interface:ISQLServerConnectionCreates aCallableStatementobject that will generateResultSetobjects with the given type and concurrency. This method is the same as theprepareCallmethod above, but it allows the default result set type, result set concurrency type and holdability to be overridden.- Specified by:
prepareCallin interfaceISQLServerConnection- Parameters:
sql- aStringobject that is the SQL statement to be sent to the database; may contain on or more '?' parametersnType- one of the followingResultSetconstants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEnConcur- one of the followingResultSetconstants:ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLEresultSetHoldability- one of the followingResultSetconstants:ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMITstmtColEncSetiing- Specifies how data will be sent and received when reading and writing encrypted columns.- Returns:
- a new
CallableStatementobject, containing the pre-compiled SQL statement, that will generateResultSetobjects 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 notResultSetconstants indicating type, concurrency, and holdability
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int flag) throws SQLServerException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLServerException
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int flag, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) throws SQLServerException
Description copied from interface:ISQLServerConnectionCreates a defaultPreparedStatementobject 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 anINSERTstatement, 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
prepareStatementwill 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 thePreparedStatementobject is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.Result sets created using the returned
PreparedStatementobject will by default be typeTYPE_FORWARD_ONLYand have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callingConnection.getHoldability().- Specified by:
prepareStatementin interfaceISQLServerConnection- Parameters:
sql- an SQL statement that may contain one or more '?' IN parameter placeholdersflag- a flag indicating whether auto-generated keys should be returned; one ofStatement.RETURN_GENERATED_KEYSorStatement.NO_GENERATED_KEYSstmtColEncSetting- Specifies how data will be sent and received when reading and writing encrypted columns.- Returns:
- a new
PreparedStatementobject, 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 aStatementconstant indicating whether auto-generated keys should be returned
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLServerException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLServerException
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int[] columnIndexes, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) throws SQLServerException
Description copied from interface:ISQLServerConnectionCreates a defaultPreparedStatementobject 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 anINSERTstatement, 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
PreparedStatementobject. 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
prepareStatementwill 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 thePreparedStatementobject is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.Result sets created using the returned
PreparedStatementobject will by default be typeTYPE_FORWARD_ONLYand have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callingConnection.getHoldability().- Specified by:
prepareStatementin interfaceISQLServerConnection- Parameters:
sql- an SQL statement that may contain one or more '?' IN parameter placeholderscolumnIndexes- an array of column indexes indicating the columns that should be returned from the inserted row or rowsstmtColEncSetting- Specifies how data will be sent and received when reading and writing encrypted columns.- Returns:
- a new
PreparedStatementobject, 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 PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLServerException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLServerException
-
prepareStatement
public PreparedStatement prepareStatement(String sql, String[] columnNames, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) throws SQLServerException
Description copied from interface:ISQLServerConnectionCreates a defaultPreparedStatementobject 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 anINSERTstatement, 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
PreparedStatementobject. 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
prepareStatementwill 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 thePreparedStatementobject is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.Result sets created using the returned
PreparedStatementobject will by default be typeTYPE_FORWARD_ONLYand have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callingConnection.getHoldability().- Specified by:
prepareStatementin interfaceISQLServerConnection- Parameters:
sql- an SQL statement that may contain one or more '?' IN parameter placeholderscolumnNames- an array of column names indicating the columns that should be returned from the inserted row or rowsstmtColEncSetting- Specifies how data will be sent and received when reading and writing encrypted columns.- Returns:
- a new
PreparedStatementobject, 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
-
releaseSavepoint
public void releaseSavepoint(Savepoint savepoint) throws SQLException
- Specified by:
releaseSavepointin interfaceConnection- Throws:
SQLException
-
setSavepoint
public Savepoint setSavepoint(String sName) throws SQLServerException
- Specified by:
setSavepointin interfaceConnection- Throws:
SQLServerException
-
setSavepoint
public Savepoint setSavepoint() throws SQLServerException
- Specified by:
setSavepointin interfaceConnection- Throws:
SQLServerException
-
rollback
public void rollback(Savepoint s) throws SQLServerException
- Specified by:
rollbackin interfaceConnection- Throws:
SQLServerException
-
getHoldability
public int getHoldability() throws SQLServerException- Specified by:
getHoldabilityin interfaceConnection- Throws:
SQLServerException
-
setHoldability
public void setHoldability(int holdability) throws SQLServerException- Specified by:
setHoldabilityin interfaceConnection- Throws:
SQLServerException
-
getNetworkTimeout
public int getNetworkTimeout() throws SQLException- Specified by:
getNetworkTimeoutin interfaceConnection- Throws:
SQLException
-
setNetworkTimeout
public void setNetworkTimeout(Executor executor, int timeout) throws SQLException
- Specified by:
setNetworkTimeoutin interfaceConnection- Throws:
SQLException
-
getSchema
public String getSchema() throws SQLException
- Specified by:
getSchemain interfaceConnection- Throws:
SQLException
-
setSchema
public void setSchema(String schema) throws SQLException
- Specified by:
setSchemain interfaceConnection- Throws:
SQLException
-
setSendTimeAsDatetime
public void setSendTimeAsDatetime(boolean sendTimeAsDateTimeValue)
Description copied from interface:ISQLServerConnectionSets 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.- Specified by:
setSendTimeAsDatetimein interfaceISQLServerConnection- 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.
-
setDatetimeParameterType
public void setDatetimeParameterType(String datetimeParameterTypeValue) throws SQLServerException
Description copied from interface:ISQLServerConnectionSets 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.- Specified by:
setDatetimeParameterTypein interfaceISQLServerConnection- 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
-
setUseFmtOnly
public void setUseFmtOnly(boolean useFmtOnly)
Description copied from interface:ISQLServerConnectionSpecifies the flag to use FMTONLY for parameter metadata queries.- Specified by:
setUseFmtOnlyin interfaceISQLServerConnection- Parameters:
useFmtOnly- boolean value for 'useFmtOnly'.
-
getUseFmtOnly
public final boolean getUseFmtOnly()
Description copied from interface:ISQLServerConnectionReturns the current flag value for useFmtOnly.- Specified by:
getUseFmtOnlyin interfaceISQLServerConnection- Returns:
- 'useFmtOnly' property value.
-
createArrayOf
public Array createArrayOf(String typeName, Object[] elements) throws SQLException
- Specified by:
createArrayOfin interfaceConnection- Throws:
SQLException
-
createBlob
public Blob createBlob() throws SQLException
- Specified by:
createBlobin interfaceConnection- Throws:
SQLException
-
createClob
public Clob createClob() throws SQLException
- Specified by:
createClobin interfaceConnection- Throws:
SQLException
-
createNClob
public NClob createNClob() throws SQLException
- Specified by:
createNClobin interfaceConnection- Throws:
SQLException
-
createSQLXML
public SQLXML createSQLXML() throws SQLException
- Specified by:
createSQLXMLin interfaceConnection- Throws:
SQLException
-
createStruct
public Struct createStruct(String typeName, Object[] attributes) throws SQLException
- Specified by:
createStructin interfaceConnection- Throws:
SQLException
-
getClientInfo
public Properties getClientInfo() throws SQLException
- Specified by:
getClientInfoin interfaceConnection- Throws:
SQLException
-
getClientInfo
public String getClientInfo(String name) throws SQLException
- Specified by:
getClientInfoin interfaceConnection- Throws:
SQLException
-
setClientInfo
public void setClientInfo(Properties properties) throws SQLClientInfoException
- Specified by:
setClientInfoin interfaceConnection- Throws:
SQLClientInfoException
-
setClientInfo
public void setClientInfo(String name, String value) throws SQLClientInfoException
- Specified by:
setClientInfoin interfaceConnection- Throws:
SQLClientInfoException
-
isValid
public boolean isValid(int timeout) throws SQLExceptionDetermine whether the connection is still valid. The driver shall submit a query on the connection or use some other mechanism that positively verifies the connection is still valid when this method is called. The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.- Specified by:
isValidin interfaceConnection- Parameters:
timeout- The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation. Note that if the value is 0, the call to isValid may block indefinitely if the connection is not valid...- Returns:
- true if the connection has not been closed and is still valid.
- Throws:
SQLException- if the value supplied for the timeout is less than 0.
-
isWrapperFor
public boolean isWrapperFor(Class<?> iface) throws SQLException
- Specified by:
isWrapperForin interfaceWrapper- Throws:
SQLException
-
unwrap
public <T> T unwrap(Class<T> iface) throws SQLException
- Specified by:
unwrapin interfaceWrapper- Throws:
SQLException
-
setColumnEncryptionKeyCacheTtl
public static void setColumnEncryptionKeyCacheTtl(int columnEncryptionKeyCacheTTL, TimeUnit unit) throws SQLServerExceptionSets time-to-live for column encryption key entries in the column encryption key cache for the Always Encrypted feature. The default value is 2 hours. This variable holds the value in seconds. This only applies to global-level key store providers. Connection and Statement-level providers need to set their own cache TTL values.- Parameters:
columnEncryptionKeyCacheTTL- The timeunit in secondsunit- The Timeunit- Throws:
SQLServerException- when an error occurs
-
getDiscardedServerPreparedStatementCount
public int getDiscardedServerPreparedStatementCount()
Description copied from interface:ISQLServerConnectionReturns the number of currently outstanding prepared statement un-prepare actions.- Specified by:
getDiscardedServerPreparedStatementCountin interfaceISQLServerConnection- Returns:
- Returns the current value per the description.
-
closeUnreferencedPreparedStatementHandles
public void closeUnreferencedPreparedStatementHandles()
Description copied from interface:ISQLServerConnectionForces the un-prepare requests for any outstanding discarded prepared statements to be executed.- Specified by:
closeUnreferencedPreparedStatementHandlesin interfaceISQLServerConnection
-
getEnablePrepareOnFirstPreparedStatementCall
public boolean getEnablePrepareOnFirstPreparedStatementCall()
Description copied from interface:ISQLServerConnectionReturns 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().- Specified by:
getEnablePrepareOnFirstPreparedStatementCallin interfaceISQLServerConnection- Returns:
- Returns the current setting per the description.
-
setEnablePrepareOnFirstPreparedStatementCall
public void setEnablePrepareOnFirstPreparedStatementCall(boolean value)
Description copied from interface:ISQLServerConnectionSets 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.- Specified by:
setEnablePrepareOnFirstPreparedStatementCallin interfaceISQLServerConnection- Parameters:
value- Changes the setting per the description.
-
getcacheBulkCopyMetadata
public boolean getcacheBulkCopyMetadata()
Description copied from interface:ISQLServerConnectionSets the value for 'cacheBulkCopyMetadata' property- Specified by:
getcacheBulkCopyMetadatain interfaceISQLServerConnection- Returns:
- cacheBulkCopyMetadata boolean value
-
setcacheBulkCopyMetadata
public void setcacheBulkCopyMetadata(boolean value)
Description copied from interface:ISQLServerConnectionReturns value of 'cacheBulkCopyMetadata' from Connection String.- Specified by:
setcacheBulkCopyMetadatain interfaceISQLServerConnection- Parameters:
value- indicates whether the driver should use connection level caching of metadata for bulk copy
-
getPrepareMethod
public String getPrepareMethod()
Description copied from interface:ISQLServerConnectionReturns the behavior for a specific connection instance.PrepareMethod- Specified by:
getPrepareMethodin interfaceISQLServerConnection- Returns:
- Returns current setting for prepareMethod connection property.
-
setPrepareMethod
public void setPrepareMethod(String prepareMethod)
Description copied from interface:ISQLServerConnectionSets the behavior for the prepare method.PrepareMethod- Specified by:
setPrepareMethodin interfaceISQLServerConnection- Parameters:
prepareMethod- Changes the setting as per description
-
getServerPreparedStatementDiscardThreshold
public int getServerPreparedStatementDiscardThreshold()
Description copied from interface:ISQLServerConnectionReturns 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().- Specified by:
getServerPreparedStatementDiscardThresholdin interfaceISQLServerConnection- Returns:
- Returns the current setting per the description.
-
setServerPreparedStatementDiscardThreshold
public void setServerPreparedStatementDiscardThreshold(int value)
Description copied from interface:ISQLServerConnectionSets 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.- Specified by:
setServerPreparedStatementDiscardThresholdin interfaceISQLServerConnection- Parameters:
value- Changes the setting per the description.
-
getAccessTokenCallbackClass
public String getAccessTokenCallbackClass()
Returns the fully qualified class name of the implementing class forSQLServerAccessTokenCallback.- Specified by:
getAccessTokenCallbackClassin interfaceISQLServerConnection- Returns:
- accessTokenCallbackClass
-
setAccessTokenCallbackClass
public void setAccessTokenCallbackClass(String accessTokenCallbackClass)
Sets 'accessTokenCallbackClass' to the fully qualified class name of the implementing class forSQLServerAccessTokenCallback.- Specified by:
setAccessTokenCallbackClassin interfaceISQLServerConnection- Parameters:
accessTokenCallbackClass- access token callback class
-
getUseFlexibleCallableStatements
public boolean getUseFlexibleCallableStatements()
Returns whether or not sp_sproc_columns is being used for parameter name lookup.- Returns:
- useFlexibleCallableStatements
-
setUseFlexibleCallableStatements
public 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.
-
getDisableStatementPooling
public boolean getDisableStatementPooling()
Description copied from interface:ISQLServerConnectionReturns the value whether statement pooling is disabled.- Specified by:
getDisableStatementPoolingin interfaceISQLServerConnection- Returns:
- true if statement pooling is disabled, false if it is enabled.
-
setDisableStatementPooling
public void setDisableStatementPooling(boolean value)
Description copied from interface:ISQLServerConnectionSets the value to Disable/enable statement pooling.- Specified by:
setDisableStatementPoolingin interfaceISQLServerConnection- Parameters:
value- true to disable statement pooling, false to enable it.
-
getStatementPoolingCacheSize
public int getStatementPoolingCacheSize()
Description copied from interface:ISQLServerConnectionReturns the size of the prepared statement cache for this connection. A value less than 1 means no cache.- Specified by:
getStatementPoolingCacheSizein interfaceISQLServerConnection- Returns:
- Returns the current setting per the description.
-
getStatementHandleCacheEntryCount
public int getStatementHandleCacheEntryCount()
Description copied from interface:ISQLServerConnectionReturns the current number of pooled prepared statement handles.- Specified by:
getStatementHandleCacheEntryCountin interfaceISQLServerConnection- Returns:
- Returns the current setting per the description.
-
isStatementPoolingEnabled
public boolean isStatementPoolingEnabled()
Description copied from interface:ISQLServerConnectionReturns whether statement pooling is enabled or not for this connection.- Specified by:
isStatementPoolingEnabledin interfaceISQLServerConnection- Returns:
- Returns the current setting per the description.
-
setStatementPoolingCacheSize
public void setStatementPoolingCacheSize(int value)
Description copied from interface:ISQLServerConnectionSets the size of the prepared statement cache for this connection. A value less than 1 means no cache.- Specified by:
setStatementPoolingCacheSizein interfaceISQLServerConnection- Parameters:
value- The new cache size.
-
getMsiTokenCacheTtl
@Deprecated(since="12.1.0", forRemoval=true) public int getMsiTokenCacheTtl()
Deprecated, for removal: This API element is subject to removal in a future version.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.Description copied from interface:ISQLServerConnectionThis method will always return 0 and is for backwards compatibility only.- Specified by:
getMsiTokenCacheTtlin interfaceISQLServerConnection- Returns:
- Method will always return 0.
-
setMsiTokenCacheTtl
@Deprecated(since="12.1.0", forRemoval=true) public void setMsiTokenCacheTtl(int timeToLive)
Deprecated, for removal: This API element is subject to removal in a future version.Time-to-live is no longer supported for the cached Managed Identity tokens. This method is a no-op for backwards compatibility only.Description copied from interface:ISQLServerConnectionTime-to-live is no longer supported for the cached Managed Identity tokens. This method is a no-op for backwards compatibility only.- Specified by:
setMsiTokenCacheTtlin interfaceISQLServerConnection- Parameters:
timeToLive- Time-to-live is no longer supported.
-
setIPAddressPreference
public void setIPAddressPreference(String iPAddressPreference)
Description copied from interface:ISQLServerConnectionSets the name of the preferred type of IP Address.- Specified by:
setIPAddressPreferencein interfaceISQLServerConnection- Parameters:
iPAddressPreference- A String that contains the preferred type of IP Address.
-
getIPAddressPreference
public String getIPAddressPreference()
Description copied from interface:ISQLServerConnectionGets the name of the preferred type of IP Address.- Specified by:
getIPAddressPreferencein interfaceISQLServerConnection- Returns:
- IPAddressPreference A String that contains the preferred type of IP Address.
-
setServerMessageHandler
public ISQLServerMessageHandler setServerMessageHandler(ISQLServerMessageHandler messageHandler)
Set current message handler- Specified by:
setServerMessageHandlerin interfaceISQLServerConnection- Parameters:
messageHandler- message handler- Returns:
- The previously installed message handler (null if none)
- See Also:
ISQLServerMessageHandler.messageHandler(ISQLServerMessage)
-
getServerMessageHandler
public ISQLServerMessageHandler getServerMessageHandler()
Description copied from interface:ISQLServerConnectionGet Currently installed message handler on the connection- Specified by:
getServerMessageHandlerin interfaceISQLServerConnection- Returns:
- Get Currently installed message handler on the connection
- See Also:
ISQLServerMessageHandler.messageHandler(ISQLServerMessage)
-
-