通过

JDBC 驱动程序的 Always Encrypted API 参考

  • 项目

下载 JDBC 驱动程序

Always Encrypted 允许客户端对客户端应用程序内的敏感数据进行加密，并且永远不向服务器透漏加密密钥。 安装在客户端计算机上的启用了 Always Encrypted 的驱动程序通过在客户端应用程序中自动加密和解密敏感数据来实现此功能。

该驱动程序先对敏感列中的数据进行加密，然后再将该数据传递到 SQL Server，并且自动重写查询来将语义保留到应用程序中。 同样，该驱动程序以透明方式对存储在加密数据库列（在查询结果中）中的数据进行解密。 有关详细信息，请参阅 Always Encrypted（数据库引擎）和结合使用 Always Encrypted 和 JDBC 驱动程序。

注意

在 Azure SQL 数据库和 SQL Server 2016 及更高版本中，Always Encrypted 仅受 Microsoft JDBC Driver 6.0/6.0+ for SQL Server 的支持。

Always Encrypted API 参考

对 JDBC 驱动程序 API 有多次新的添加和修改，以供在使用始终加密的客户端应用程序中使用。

SQLServerConnection 类

名称 说明
新的连接字符串关键字：

columnEncryptionSetting		 columnEncryptionSetting=Enabled 为该连接启用 Always Encrypted 功能，而 columnEncryptionSetting=Disabled 禁用该功能。 接受的值为“启用”/“禁用”。 默认值为“禁用”。
新的连接字符串关键字：（MS JDBC 7.4 及更高版本）

keyVaultProviderClientId

keyVaultProviderClientKey		 keyVaultProviderClientId=<ClientID>;keyVaultProviderClientKey=<ClientKey>

注册 SQLServerColumnEncryptionAzureKeyVaultProvider，并使用 ClientID 和 ClientKey 值从 Azure Key Vault 检索列主密钥
新方法：

public static void setColumnEncryptionTrustedMasterKeyPaths(Map<String, List\<String>> trustedKeyPaths)

public static void updateColumnEncryptionTrustedMasterKeyPaths(String server, List\<String> trustedKeyPaths)

public static void removeColumnEncryptionTrustedMasterKeyPaths(String server)		 允许为数据库服务器设置/更新/删除受信任的密钥路径的列表。 如果在处理应用程序查询时，驱动程序收到不在列表上的密钥路径，则查询将失败。 此属性提供针对安全攻击的额外防护，这些攻击涉及发送伪造密钥路径的遭入侵服务器，这可能会导致泄露密钥存储凭据。
新方法：

public static Map<String, List\<String>> getColumnEncryptionTrustedMasterKeyPaths()		 为数据库服务器返回受信任的密钥路径的列表。
新方法：

public static void registerColumnEncryptionKeyStoreProviders (Map\<String, SQLServerColumnEncryptionKeyStoreProvider> clientKeyStoreProviders)		 允许你注册自定义密钥存储提供程序。 它是一个将密钥存储提供程序名称映射到密钥存储提供程序实现的字典。

若要使用 JVM 密钥存储，需要使用 JVM 密钥存储凭据实例化 SQLServerColumnEncryptionJVMKeyStoreProvider 对象，并使用驱动程序注册它。 此提供程序的名称必须为“MSSQL_JVM_KEYSTORE”。

若要使用 Azure Key Vault 存储库，必须实例化 SQLServerColumnEncryptionAzureKeyStoreProvider 对象，并使用驱动程序注册它。 此提供程序的名称必须为“AZURE_KEY_VAULT”。
新方法：

public static void unregisterColumnEncryptionKeyStoreProviders (Map\<String, SQLServerColumnEncryptionKeyStoreProvider> clientKeyStoreProviders)		 可通过清理将密钥存储库提供程序映射到密钥存储库提供程序实现的目录，取消注册所有自定义密钥存储库提供程序。
public final boolean getSendTimeAsDatetime() 返回 sendTimeAsDatetime 连接属性的设置。
public void setSendTimeAsDatetime(boolean sendTimeAsDateTimeValue) 修改 sendTimeAsDatetime 连接属性的设置。

SQLServerConnectionPoolProxy 类

名称 说明
public final boolean getSendTimeAsDatetime() 返回 sendTimeAsDatetime 连接属性的设置。
public void setSendTimeAsDatetime(boolean sendTimeAsDateTimeValue) 修改 sendTimeAsDatetime 连接属性的设置。

SQLServerDataSource 类

名称 说明
public void setColumnEncryptionSetting(String columnEncryptionSetting) 为数据源对象启用/禁用始终加密功能。

默认值为“禁用”。
public String getColumnEncryptionSetting() 检索数据源对象的始终加密功能设置。
public void setKeyStoreAuthentication(String keyStoreAuthentication) 设置标识密钥存储的名称。 唯一支持的值是，用于标识 Java 密钥存储库的 JavaKeyStorePassword。

默认值为 NULL。
public String getKeyStoreAuthentication() 获取数据源对象的 keyStoreAuthentication 设置值。
public void setKeyStoreSecret(String keyStoreSecret) 设置 Java 密钥存储库的密码。 密钥存储库的密码和密钥必须相同。 必须使用 JavaKeyStorePassword 设置 JavaKeyStorePassword。
public void setKeyStoreLocation(String keyStoreLocation) 设置包含 Java 密钥存储库的文件名的位置。 必须使用 JavaKeyStorePassword 设置 JavaKeyStorePassword。
public String getKeyStoreLocation() 检索 Java 密钥存储库的 keyStoreLocation。

SQLServerColumnEncryptionJavaKeyStoreProvider 类

Java 密钥存储的密钥存储提供程序的实现。 此类支持将存储在 Java 密钥存储中的证书用作列主密钥。

构造函数：

名称 说明
public SQLServerColumnEncryptionJavaKeyStoreProvider (String keyStoreLocation, char[] keyStoreSecret) Java 密钥存储库的密钥存储库提供程序。

方法：

名称 说明
public byte[] decryptColumnEncryptionKey (String masterKeyPath, String encryptionAlgorithm, byte[] encryptedColumnEncryptionKey) 对列加密密钥的指定加密值进行解密。 加密值应使用具有指定密钥路径的证书和指定的算法进行加密。

密钥路径应采用以下格式之一：

指纹：<certificate_thumbprint>

别名：<certificate_alias>

（重写 SQLServerColumnEncryptionKeyStoreProvider。 decryptColumnEncryptionKey(String, String, Byte[])。）
public byte[] encryptColumnEncryptionKey (String masterKeyPath, String encryptionAlgorithm, byte[] plainTextColumnEncryptionKey) 使用具有指定密钥路径的证书和使用指定的算法对列加密密钥进行加密。

密钥路径应采用以下格式之一：

指纹：<certificate_thumbprint>

别名：<certificate_alias>

（重写 SQLServerColumnEncryptionKeyStoreProvider。 encryptColumnEncryptionKey(String, String, Byte[])。）
public boolean verifyColumnEncryptionKey (String masterKeyPath, boolean allowEnclaveComputations, byte[] signature) 使用证书验证列加密密钥的签名。

密钥路径应采用以下格式之一：

指纹：<certificate_thumbprint>

别名：<certificate_alias>

（重写 SQLServerColumnEncryptionKeyStoreProvider。 verifyColumnEncryptionKey(String, boolean, Byte[]).)
public void setName (String name) 设置此密钥存储库提供程序的名称。
public String getName () 获取此密钥存储库提供程序的名称。

SQLServerColumnEncryptionAzureKeyVaultProvider 类

Azure Key Vault 的密钥存储提供程序的实现。 借助此类，可以将 Azure Key Vault 中存储的密钥用作列主密钥。

构造函数：

名称 说明
public SQLServerColumnEncryptionAzureKeyVaultProvider () 构造 SQLServerColumnEncryptionAzureKeyVaultProvider 来向 Azure Key Vault 进行身份验证。
public SQLServerColumnEncryptionAzureKeyVaultProvider (String clientId) 使用请求令牌的客户端的标识符构造 SQLServerColumnEncryptionAzureKeyVaultProvider 来向 Azure Key Vault 进行身份验证。
public SQLServerColumnEncryptionAzureKeyVaultProvider (String clientId, String clientKey) 使用请求令牌的客户端的标识符和密钥构造 SQLServerColumnEncryptionAzureKeyVaultProvider 来向 Azure Key Vault 进行身份验证。
public SQLServerColumnEncryptionAzureKeyVaultProvider (TokenCredential tokenCredential) 使用所提供的 TokenCredential 构造 SQLServerColumnEncryptionAzureKeyVaultProvider 来向 Azure Key Vault 进行身份验证。

方法：

名称 说明
public byte[] decryptColumnEncryptionKey (String masterKeyPath, String encryptionAlgorithm, byte[] encryptedColumnEncryptionKey) 对加密列加密密钥 (CEK) 进行解密。 这种解密是通过 RSA 加密算法完成的，此算法使用主密钥路径指定的非对称密钥。
（重写 SQLServerColumnEncryptionKeyStoreProvider。 decryptColumnEncryptionKey(String, String, Byte[])。）
public byte[] encryptColumnEncryptionKey (String masterKeyPath, String encryptionAlgorithm, byte[] columnEncryptionKey) 通过向指定算法提供指定列主密钥，对列加密密钥进行加密。
（重写 SQLServerColumnEncryptionKeyStoreProvider。 encryptColumnEncryptionKey(String, String, Byte[])。）
public void setName (String name) 设置此密钥存储库提供程序的名称。
public String getName () 获取此密钥存储库提供程序的名称。

SQLServerKeyVaultAuthenticationCallback 接口

此接口包含一种用于 Azure Key Vault 身份验证的方法，这种方法将由用户实现。

方法：

名称 说明
public String getAccessToken(String authority, String resource, String scope); 必须重写此方法。 此方法用于获取 Azure Key Vault 的访问令牌。

SQLServerColumnEncryptionKeyStoreProvider 类

扩展此类以实现自定义密钥存储提供程序。

名称 说明
SQLServerColumnEncryptionKeyStoreProvider 所有密钥存储提供程序的基类。 自定义提供程序必须派生自此类并替代其成员函数，然后使用 SQLServerConnection 注册它。 registerColumnEncryptionKeyStoreProviders()。

方法：

名称 说明
public abstract byte[] decryptColumnEncryptionKey (String masterKeyPath, String encryptionAlgorithm, byte [] encryptedColumnEncryptionKey) 用于解密列加密密钥的指定加密值的基类方法。 预期使用带有指定密钥路径的列主密钥和指定算法加密该加密值。
public abstract byte[] encryptColumnEncryptionKey (String masterKeyPath, String encryptionAlgorithm, byte[] columnEncryptionKey) 用于使用带有指定密钥路径的列主密钥并使用指定算法加密列加密密钥的基类算法。
public abstract void setName(String name) 设置此密钥存储库提供程序的名称。
public abstract String getName() 获取此密钥存储库提供程序的名称。

SQLServerPreparedStatement 类中的新方法或重载方法

名称 说明
public void setBigDecimal(int parameterIndex, BigDecimal x, int precision, int scale)

public void setObject(int parameterIndex, Object x, int targetSqlType, Integer precision, int scale)

public void setObject(int parameterIndex, Object x, SQLType targetSqlType, Integer precision, Integer scale)

public void setTime(int parameterIndex, java.sql.Time x, int scale)

public void setTimestamp(int parameterIndex, java.sql.Timestamp x, int scale)
public void setDateTimeOffset(int parameterIndex, microsoft.sql.DateTimeOffset x, int scale)		 这些方法使用精度和/或确定位数参数进行重载，以支持对需要精度和确定位数信息的特定数据类型使用 Always Encrypted。
public void setMoney(int parameterIndex, BigDecimal x)

public void setSmallMoney(int parameterIndex, BigDecimal x)

public void setUniqueIdentifier(int parameterIndex, String guid)

public void setDateTime(int parameterIndex, java.sql.Timestamp x)

public void setSmallDateTime(int parameterIndex, java.sql.Timestamp x)		 通过这些方法，可支持对 money、smallmoney、uniqueidentifier、datetime 和 smalldatetime 数据类型使用 Always Encrypted。

现有 setTimestamp() 方法用于将参数值发送到加密列 datetime2。 对于加密列 datetime 和 smalldatetime，请分别使用新方法 setDateTime() 和 setSmallDateTime()。
public final void setBigDecimal(int parameterIndex, BigDecimal x, int precision, int scale, boolean forceEncrypt)

public final void setMoney(int parameterIndex, BigDecimal x, boolean forceEncrypt)

public final void setSmallMoney(int parameterIndex, BigDecimal x, boolean forceEncrypt)

public final void setBoolean(int parameterIndex, boolean x, boolean forceEncrypt)

public final void setByte(int parameterIndex, byte x, boolean forceEncrypt)

public final void setBytes(int parameterIndex, byte x[], boolean forceEncrypt)

public final void setUniqueIdentifier(int parameterIndex, String guid, boolean forceEncrypt)

public final void setDouble(int parameterIndex, double x, boolean forceEncrypt)

public final void setFloat(int parameterIndex, float x, boolean forceEncrypt)

public final void setInt(int parameterIndex, int value, boolean forceEncrypt)

public final void setLong(int parameterIndex, long x, boolean forceEncrypt)

public final setObject(int parameterIndex, Object x, int targetSqlType, Integer precision, int scale, boolean forceEncrypt)

public final void setObject(int parameterIndex, Object x, SQLType targetSqlType, Integer precision, Integer scale, boolean forceEncrypt)

public final void setShort(int parameterIndex, short x, boolean forceEncrypt)

public final void setString(int parameterIndex, String str, boolean forceEncrypt)

public final void setNString(int parameterIndex, String value, boolean forceEncrypt)

public final void setTime(int parameterIndex, java.sql.Time x, int scale, boolean forceEncrypt)

public final void setTimestamp(int parameterIndex, java.sql.Timestamp x, int scale, boolean forceEncrypt)

public final void setDateTimeOffset(int parameterIndex, microsoft.sql.DateTimeOffset x, int scale, boolean forceEncrypt)

public final void setDateTime(int parameterIndex, java.sql.Timestamp x, boolean forceEncrypt)

public final void setSmallDateTime(int parameterIndex, java.sql.Timestamp x, boolean forceEncrypt)

public final void setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal, boolean forceEncrypt)

public final void setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal, boolean forceEncrypt)

public final void setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal, boolean forceEncrypt)		 将命名参数设置为给定的 Java 值。

如果布尔 forceEncrypt 设置为 true，那么只有当指定列已加密，并且在连接或语句上启用 Always Encrypted 时，才设置查询参数。

如果布尔 forceEncrypt 设置为 false，那么驱动程序不会强制对参数进行加密。

SQLServerCallableStatement 类中的新方法或重载方法

名称 说明
public void registerOutParameter(int parameterIndex, int sqlType, int precision, int scale)

public void registerOutParameter(int parameterIndex, SQLType sqlType, int precision, int scale)

public void registerOutParameter(String parameterName, int sqlType, int precision, int scale)

public void registerOutParameter(String parameterName, SQLType sqlType, int precision, int scale)
public void setBigDecimal(String parameterName, BigDecimal bd, int precision, int scale)

public void setTime(String parameterName, java.sql.Time t, int scale)

public void setTimestamp(String parameterName, java.sql.Timestamp t, int scale)

public void setDateTimeOffset(String parameterName, microsoft.sql.DateTimeOffset t, int scale)

public final void setObject(String sCol, Object x, int targetSqlType, Integer precision, int scale)		 这些方法使用精度和/或确定位数参数进行重载，以支持对需要精度和确定位数信息的特定数据类型使用 Always Encrypted。
public void setDateTime(String parameterName, java.sql.Timestamp x)

public void setSmallDateTime(String parameterName, java.sql.Timestamp x)

public void setUniqueIdentifier(String parameterName, String guid)

public void setMoney(String parameterName, BigDecimal bd)

public void setSmallMoney(String parameterName, BigDecimal bd)

public Timestamp getDateTime(int index)

public Timestamp getDateTime(String sCol)

public Timestamp getDateTime(int index, Calendar cal)

public Timestamp getSmallDateTime(int index)

public Timestamp getSmallDateTime(String sCol)

public Timestamp getSmallDateTime(int index, Calendar cal)

public Timestamp getSmallDateTime(String name, Calendar cal)

public BigDecimal getMoney(int index)

public BigDecimal getMoney(String sCol)

public BigDecimal getSmallMoney(int index)

public BigDecimal getSmallMoney(String sCol)		 通过这些方法，可支持对 money、smallmoney、uniqueidentifier、datetime 和 smalldatetime 数据类型使用 Always Encrypted。

现有 setTimestamp() 方法用于将参数值发送到加密列 datetime2。 对于加密列 datetime 和 smalldatetime，请分别使用新方法 setDateTime() 和 setSmallDateTime()。
public void setObject(String parameterName, Object o, int n, int m, boolean forceEncrypt)

public void setObject(String parameterName, Object obj, SQLType jdbcType, int scale, boolean forceEncrypt)

public void setDate(String parameterName, java.sql.Date x, Calendar c, boolean forceEncrypt)

public void setTime(String parameterName, java.sql.Time t, int scale, boolean forceEncrypt)

public void setTime(String parameterName, java.sql.Time x, Calendar c, boolean forceEncrypt)

public void setDateTime(String parameterName, java.sql.Timestamp x, boolean forceEncrypt)

public void setDateTimeOffset(String parameterName, microsoft.sql.DateTimeOffset t, int scale, boolean forceEncrypt)

public void setSmallDateTime(String parameterName, java.sql.Timestamp x, boolean forceEncrypt)

public void setTimestamp(String parameterName, java.sql.Timestamp t, int scale, boolean forceEncrypt)

public void setTimestamp(String parameterName, java.sql.Timestamp x, boolean forceEncrypt)

public void setUniqueIdentifier(String parameterName, String guid, boolean forceEncrypt)

public void setBytes(String parameterName, byte[] b, boolean forceEncrypt)

public void setByte(String parameterName, byte b, boolean forceEncrypt)

public void setString(String parameterName, String s, boolean forceEncrypt)

public final void setNString(String parameterName, String value, boolean forceEncrypt)<br /><br /> public void setMoney(String parameterName, BigDecimal bd, boolean forceEncrypt)

public void setSmallMoney(String parameterName, BigDecimal bd, boolean forceEncrypt)

public void setBigDecimal(String parameterName, BigDecimal bd, int precision, int scale, boolean forceEncrypt)

public void setDouble(String parameterName, double d, boolean forceEncrypt)

public void setFloat(String parameterName, float f, boolean forceEncrypt)

public void setInt(String parameterName, int i, boolean forceEncrypt)

public void setLong(String parameterName, long l, boolean forceEncrypt)

public void setShort(String parameterName, short s, boolean forceEncrypt)

public void setBoolean(String parameterNames, boolean b, boolean forceEncrypt)

public void setTimeStamp(String sCol, java.sql.Timestamp x, Calendar c, Boolean forceEncrypt)		 将命名参数设置为给定的 Java 值。

如果布尔 forceEncrypt 设置为 true，那么只有当指定列已加密，并且在连接或语句上启用 Always Encrypted 时，才设置查询参数。

如果布尔 forceEncrypt 设置为 false，那么驱动程序不会强制对参数进行加密。

SQLServerResultSet 类中的新方法或重载方法

名称 说明
public String getUniqueIdentifier(int columnIndex)

public String getUniqueIdentifier(String columnLabel)

public java.sql.Timestamp getDateTime(int columnIndex)

public java.sql.Timestamp getDateTime(String columnName)

public java.sql.Timestamp getDateTime(int columnIndex, Calendar cal)

public java.sql.Timestamp getDateTime(String colName, Calendar cal)

public java.sql.Timestamp getSmallDateTime(int columnIndex)

public java.sql.Timestamp getSmallDateTime(String columnName)

public java.sql.Timestamp getSmallDateTime(int columnIndex, Calendar cal)

public java.sql.Timestamp getSmallDateTime(String colName, Calendar cal)

public BigDecimal getMoney(int columnIndex)

public BigDecimal getMoney(String columnName)

public BigDecimal getSmallMoney(int columnIndex)

public BigDecimal getSmallMoney(String columnName)

public void updateMoney(String columnName, BigDecimal x)

public void updateSmallMoney(String columnName, BigDecimal x)

public void updateDateTime(int index, java.sql.Timestamp x)

public void updateSmallDateTime(int index, java.sql.Timestamp x)		 通过这些方法，可支持对 money、smallmoney、uniqueidentifier、datetime 和 smalldatetime 数据类型使用 Always Encrypted。

现有 updateTimestamp() 方法用于更新加密列 datetime2。 对于加密列 datetime 和 smalldatetime，请分别使用新方法 updateDateTime() 和 updateSmallDateTime()。
public void updateBoolean(int index, boolean x, boolean forceEncrypt)

public void updateByte(int index, byte x, boolean forceEncrypt)

public void updateShort(int index, short x, boolean forceEncrypt)

public void updateInt(int index, int x, boolean forceEncrypt)

public void updateLong(int index, long x, boolean forceEncrypt)

public void updateFloat(int index, float x, boolean forceEncrypt)

public void updateDouble(int index, double x, boolean forceEncrypt)

public void updateMoney(int index, BigDecimal x, boolean forceEncrypt)

public void updateMoney(String columnName, BigDecimal x, boolean forceEncrypt)

public void updateSmallMoney(int index, BigDecimal x, boolean forceEncrypt)

public void updateSmallMoney(String columnName, BigDecimal x, boolean forceEncrypt)

public void updateBigDecimal(int index, BigDecimal x, Integer precision, Integer scale, boolean forceEncrypt)

public void updateString(int columnIndex, String stringValue, boolean forceEncrypt)

public void updateNString(int columnIndex, String nString, boolean forceEncrypt)

public void updateNString(String columnLabel, String nString, boolean forceEncrypt)

public void updateBytes(int index, byte x[], boolean forceEncrypt) <br/><br/> public void updateDate(int index, java.sql.Date x, boolean forceEncrypt)

public void updateTime(int index, java.sql.Time x, Integer scale, boolean forceEncrypt)

public void updateTimestamp(int index, java.sql.Timestamp x, int scale, boolean forceEncrypt)

public void updateDateTime(int index, java.sql.Timestamp x, Integer scale, boolean forceEncrypt)

public void updateSmallDateTime(int index, java.sql.Timestamp x, Integer scale, boolean forceEncrypt)

public void updateDateTimeOffset(int index, microsoft.sql.DateTimeOffset x, Integer scale, boolean forceEncrypt)

public void updateUniqueIdentifier(int index, String x, boolean forceEncrypt)

public void updateObject(int index, Object x, int precision, int scale, boolean forceEncrypt)

public void updateObject(int index, Object obj, SQLType targetSqlType, int scale, boolean forceEncrypt)

public void updateBoolean(String columnName, boolean x, boolean forceEncrypt)

public void updateByte(String columnName, byte x, boolean forceEncrypt)

public void updateShort(String columnName, short x, boolean forceEncrypt)

public void updateInt(String columnName, int x, boolean forceEncrypt)

public void updateLong(String columnName, long x, boolean forceEncrypt)

public void updateFloat(String columnName, float x, boolean forceEncrypt)

public void updateDouble(String columnName, double x, boolean forceEncrypt) <br/><br/> public void updateBigDecimal(String columnName, BigDecimal x, boolean forceEncrypt)

public void updateBigDecimal(String columnName, BigDecimal x, Integer precision, Integer scale, boolean forceEncrypt)

public void updateString(String columnName, String x, boolean forceEncrypt)

public void updateBytes(String columnName, byte x[], boolean forceEncrypt)

public void updateDate(String columnName, java.sql.Date x, boolean forceEncrypt)

public void updateTime(String columnName, java.sql.Time x, int scale, boolean forceEncrypt)

public void updateTimestamp(String columnName, java.sql.Timestamp x, int scale, boolean forceEncrypt)

public void updateDateTime(String columnName, java.sql.Timestamp x, int scale, boolean forceEncrypt)

public void updateSmallDateTime(String columnName, java.sql.Timestamp x, int scale, boolean forceEncrypt)

public void updateDateTimeOffset(String columnName, microsoft.sql.DateTimeOffset x, int scale, boolean forceEncrypt)

public void updateUniqueIdentifier(String columnName, String x, boolean forceEncrypt)

public void updateObject(String columnName, Object x, int precision, int scale, boolean forceEncrypt)

public void updateObject(String columnName, Object obj, SQLType targetSqlType, int scale, boolean forceEncrypt)		 将命名列更新为给定 Java 值。

如果布尔 forceEncrypt 设置为 true，那么只有当列已加密，并且在连接或语句上启用 Always Encrypted 时，才设置此列。

如果布尔 forceEncrypt 设置为 false，那么驱动程序不会强制对参数进行加密。

microsoft.sql.Types 类中的新类型

名称 说明
DATETIME、SMALLDATETIME、MONEY、SMALLMONEY、GUID 使用 setObject()/updateObject() API 方法将参数值发送到加密列 datetime、smalldatetime、money、smallmoney、uniqueidentifier 时，将这些类型用作目标 SQL 类型。

SQLServerStatementColumnEncryptionSetting Enum

指定读取和写入加密列时将如何发送及接收数据。 根据特定的查询，正当使用非加密列时跳过 Always Encrypted 驱动程序的处理可能会降低性能影响。 这些设置既不能用于绕过加密，也不能用于获取对纯文本数据的访问权限。

语法：

Public enum  SQLServerStatementColumnEncryptionSetting

成员：

名称 说明
UseConnectionSetting 指定该命令应默认为连接字符串中的 Always Encrypted 设置。
已启用 为查询启用 Always Encrypted。
ResultSetOnly 指定驱动程序中 Always Encrypted 例程应只能处理命令的结果。 当命令不具有需要加密的任何参数时使用此值。
已禁用 对查询禁用 Always Encrypted。

AE 的语句级别设置已添加到 SQLServerConnection 类和 SQLServerConnectionPoolProxy 类中。 这些类中的以下方法使用新设置进行重载。

名称 说明
public Statement createStatement(int nType, int nConcur, int statementHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) 创建 Statement 对象，此对象将生成具有给定类型、并发、可保持性和列加密设置的 ResultSet 对象。
public CallableStatement prepareCall(String sql, int nType, int nConcur, int statementHoldability, SQLServerStatementColumnEncryptionSetting stmtColEncSetiing) 创建具有给定列加密设置的 CallableStatement 对象，此对象将生成具有给定类型、并发和可保持性的 ResultSet 对象。
public PreparedStatement prepareStatement(String sql, int autogeneratedKeys, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) 创建具有给定列加密设置的 PreparedStatement 对象，此对象能够检索自动生成的密钥。
public PreparedStatement prepareStatement(String sql, String[] columnNames, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) 创建具有给定列加密设置的 PreparedStatement 对象，此对象将生成具有给定列名的 ResultSet 对象。
public PreparedStatement prepareStatement(String sql, int[] columnIndexes, SQLServerStatementColumnEncryptionSetting stmtColEncSetting 创建具有给定列加密设置的 PreparedStatement 对象，此对象将生成具有给定列索引的 ResultSet 对象。
public PreparedStatement prepareStatement(String sql, int nType, int nConcur, int nHold, SQLServerStatementColumnEncryptionSetting stmtColEncSetting) 创建具有给定列加密设置的 PreparedStatement 对象，此对象将生成具有给定类型、并发和可保持性的 ResultSet 对象。

注意

如果查询已禁用 Always Encrypted，且查询有需要加密的参数（对应于加密列的参数），那么查询会失败。

如果查询已禁用 Always Encrypted，且查询从加密列返回结果，那么查询会返回加密值。 加密值具有 varbinary 数据类型。

另请参阅

通过 JDBC 驱动程序使用 Always Encrypted