JDBC 驱动程序版本 2.0 配置选项 - Amazon Redshift
AccessKeyIDAllowDBUserOverride应用 ID应用程序名称AutoCreate客户端 ID客户端密钥ClusterIDdatabaseMetadataCurrentDbOnlyDbUserDbGroupsdefaultRowFetchSizeDisableIsValidQueryenableFetchRingBufferenableMultiSqlSupportfetchRingBufferSizeForceLowercaseIAMDuration- IdP - 主机IdP _端口IdP _ 租户IdP _响应超时登录 URLLoginTimeoutloginToRpLogLevelLogPath合作伙伴 SPIDPasswordPlugin_Name首选角色ProfilePWDqueryGroupReadOnlyreWriteBatchedInsertsSizeSecretAccessKeySessionTokenSocketTimeoutSSLSSL 不安全SSLCertSSLFactorySSLKeySSLModeSSLPasswordSSLRootCertTCPKeepAliveUIDUser
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

JDBC 驱动程序版本 2.0 配置选项

本节介绍您可以为 Amazon Redshift JDBC 驱动程序版本 2.0 驱动程序指定的选项。

您可以使用连接 URL 设置配置属性。有关更多信息，请参阅“构建连接 URL”。

AccessKeyID

  • 默认值 – 无

  • 数据类型 – 字符串

您可以指定此参数以输入 IAM 用户或角色的 IAM 访问密钥。通常，您可以通过查看 和现有的字符串或用户配置文件来查找密钥。如果指定此参数，您还必须指定 SecretAccessKey 参数。

此参数为可选项。

AllowDBUserOverride

  • 默认值 – 0

  • 数据类型 – 字符串

此选项指定驱动程序是否使用 SAML 断言中的 DbUser 值或在连接 URL 的 DbUser 连接属性中指定的值。

此参数为可选项。

1

驱动程序使用 SAML 断言中的 DbUser 值。

如果 SAML 断言未指定 DbUser，则驱动程序将使用在 DbUser 连接属性中指定的值。如果连接属性也未指定值，则驱动程序将使用连接配置文件中指定的值。

0

驱动程序使用在 DbUser 连接属性中指定的 DbUser 值。

如果 DbUser 连接属性未指定值，则驱动程序将使用连接配置文件中指定的值。如果连接配置文件也未指定值，则驱动程序将使用 SAML 断言中的值。

应用 ID

  • 默认值 – 无

  • 数据类型 – 字符串

与 Amazon Redshift 应用程序关联的 Okta 提供的唯一 ID。

如果通过 Okta 服务进行身份验证，则此参数是必需的。

应用程序名称

  • 默认值 – 无

  • 数据类型 – 字符串

用于对与 Amazon Redshift 的连接进行身份验证的 Okta 应用程序的名称。

此参数为可选项。

AutoCreate

  • 默认值 – false

  • 数据类型 – 布尔值

此选项指定在指定的用户不存在时，驱动程序是否导致创建新用户。

此参数为可选项。

true

如果 DbUser 或 UID 指定的用户不存在，则将创建具有该名称的新用户。

false

驱动程序不会导致创建新用户。如果指定的用户不存在，身份验证将失败。

客户端 ID

  • 默认值 – 无

  • 数据类型 – 字符串

使用 Azure AD 服务对连接进行身份验证时要使用的客户端 ID。

如果通过 Azure AD 服务进行身份验证，则该参数是必需的。

客户端密钥

  • 默认值 – 无

  • 数据类型 – 字符串

使用 Azure AD 服务对连接进行身份验证时要使用的客户端密钥。

如果通过 Azure AD 服务进行身份验证，则该参数是必需的。

ClusterID

  • 默认值 – 无

  • 数据类型 – 字符串

要连接到的 Amazon Redshift 集群的名称。

此参数为可选项。

databaseMetadataCurrentDbOnly

  • 默认值 – true

  • 数据类型 – 布尔值

此选项指定元数据 API 是从所有可访问的数据库中检索数据，还是仅从连接的数据库中检索数据。

此参数为可选项。

可以指定以下值：

true

应用程序从单个数据库中检索元数据。

false

应用程序从所有可访问的数据库中检索元数据。

DbUser

  • 默认值 – 无

  • 数据类型 – 字符串

要用于您的 Amazon Redshift 账户的用户 ID。如果您已启用 AutoCreate 属性，则可使用当前不存在的 ID。

此参数为可选项。

DbGroups

  • 默认值 – PUBLIC

  • 数据类型 – 字符串

为当前会话加入的现有数据库组名称的逗号分隔列表。DbUser

此参数为可选项。

defaultRowFetchSize

  • 默认值 – 0

  • 数据类型 – 整数

此选项指定 getFetchSize 的默认值。

此参数为可选项。

可以指定以下值：

0

在单个操作中提取所有行。

正整数

对于 ResultSet 的每次提取迭代，要从数据库中提取的行数。

DisableIsValidQuery

  • 默认值 – False

  • 数据类型 – 布尔值

此选项指定驱动程序在使用 Connection.isValid（） 方法确定数据库连接是否处于活动状态时是否提交新的数据库查询。

此参数为可选项。

true

在使用 Connection.isValid（） 确定数据库连接是否处于活动状态时，驱动程序不会提交查询。这可能会导致驱动程序在数据库服务器意外关闭时将数据库连接识别为活动状态。

false

驱动程序在使用 Connection.isValid（） 时提交查询来确定数据库连接是否处于活动状态。

enableFetchRingBuffer

  • 默认值 – true

  • 数据类型 – 布尔值

此选项指定驱动程序在单独的线程上使用环缓冲区提取行。参数指定环缓冲区大小。fetchRingBufferSize

此参数为可选项。

enableMultiSqlSupport

  • 默认值 – true

  • 数据类型 – 布尔值

此选项指定是否处理语句中用分号分隔的多个 SQL 命令。

此参数为可选项。

可以指定以下值：

true

驱动程序在 Statement 对象中处理多个 SQL 命令，用分号分隔。

false

驱动程序在单个语句中返回多个 SQL 命令的错误。

fetchRingBufferSize

  • 默认值 – 1G

  • 数据类型 – 字符串

此选项指定在提取结果集时使用的环缓冲区的大小。您可以指定以字节为单位的大小，例如 1K （1 KB）、5000 （5000 字节）、1M （1 MB）、1G （1 GB） 等。您还可以指定堆内存的百分比。驱动程序在达到限制时停止提取行。当应用程序读取行并释放环缓冲区中的空间时，提取操作恢复。

此参数为可选项。

ForceLowercase

  • 默认值 – false

  • 数据类型 – 布尔值

此选项指定驱动程序在使用 SSO 身份验证时是否将身份提供商发送到 DbGroups 的所有 Amazon Redshift 小写。

此参数为可选项。

true

驱动程序会为从身份提供商发送的所有 DbGroups 添加小写。

false

驱动程序不会更改 DbGroups。

IAMDuration

  • 默认值 – 900

  • 数据类型 – 整数

临时 IAM 凭证过期之前的时间长度（以秒为单位）。

  • 最小值 – 900

  • 最大值 – 3600

此参数为可选项。

- IdP - 主机

  • 默认值 – 无

  • 数据类型 – 字符串

您正在用于向 IdP 进行身份验证的 Amazon Redshift（身份提供商）主机。这可在连接字符串或配置文件中指定。

此参数为可选项。

IdP _端口

  • 默认值 – 无

  • 数据类型 – 字符串

使用的端口（身份提供商）。IdP这可在连接字符串或配置文件中指定。

此参数为可选项。

IdP _ 租户

  • 默认值 – 无

  • 数据类型 – 字符串

您的 Amazon Redshift 应用程序的 Azure AD 租户 ID。

如果通过 Azure AD 服务进行身份验证，则该参数是必需的。

IdP _响应超时

  • 默认值 – 120

  • 数据类型 – 整数

在通过浏览器插件使用 SAML 或 Azure AD 服务时，驱动程序等待身份提供商的 SAML 响应的时间长度（以秒为单位）。

此参数为可选项。

登录 URL

  • 默认值 – 无

  • 数据类型 – 字符串

在通过浏览器插件使用 SAML 或 Azure AD 服务时，身份提供商网站上的资源的 URL。

如果通过浏览器插件在 SAML 或 Azure AD 服务中进行身份验证，则该参数是必需的。

LoginTimeout

  • 默认值 – 0

  • 数据类型 – 整数

在连接到服务器并进行身份验证时，超时前等待的秒数。如果建立连接的用时长于此阈值，则连接将被中止。

当此属性设置为 0 时，连接不会超时。

此参数为可选项。

loginToRp

  • 默认值 – urn:amazon:webservices

  • 数据类型 – 字符串

要用于 AD FS 身份验证类型的信赖方信任。

此参数为可选项。

LogLevel

  • 默认值 – 0

  • 数据类型 – 整数

可以使用该属性在驱动程序中启用或禁用日志记录，并指定 日志文件中包含的详细信息量。

仅启用日志记录足够长以捕获问题。日志记录会降低性能并会占用大量磁盘空间。

此参数为可选项。

将参数设置为以下值之一：

0

禁用所有日志记录。

1

在 FATAL 级别上启用日志记录，这将记录将导致驱动程序中止的非常严重的错误事件。

2

在 ERROR 级别启用日志记录，这将记录可能仍允许驱动程序继续运行的错误事件。

3

在 WARNING 级别启用日志记录，这将记录在未执行操作时可能导致错误的事件。

4

在 INFO 级别启用日志记录，这将记录描述驱动程序的进度的一般信息。

5

在 DEBUG 级别启用日志记录，这会记录对调试驱动程序有用的详细信息。

6

在 TRACE 级别启用日志记录，这会记录所有驱动程序活动。

启用日志记录后，驱动程序会在 LogPath 属性指定的位置生成以下日志文件：

  • redshift_jdbc.log 记录非特定于连接的驱动程序活动的 – 文件。

  • redshift_jdbc_connection_[Number].log – 为与数据库进行的每个连接提供的文件，其中 [Number] 是一个用于将每个日志文件与其他日志文件区分开来的数字。此文件记录特定于连接的驱动程序活动。

如果 LogPath 值无效，则驱动程序会将记录的信息发送到标准输出流 System.out。

LogPath

  • 默认值 – 当前工作目录。

  • 数据类型 – 字符串

启用 DSILogLevel 属性时驱动程序将日志文件保存到的文件夹的完整路径。

为确保连接 URL 与所有 JDBC 应用程序兼容，我们建议您通过键入另一个反斜杠来转义文件路径中的反斜杠 （\\）。

此参数为可选项。

合作伙伴 SPID

  • 默认值 – 无

  • 数据类型 – 字符串

使用 PingFederate 服务对连接进行身份验证时要使用的合作伙伴 SPD （服务提供商 ID） 值。

此参数为可选项。

Password

  • 默认值 – 无

  • 数据类型 – 字符串

当使用 IAM 身份验证通过 IDP 进行连接时，这是 IDP_Host 服务器的密码。使用标准身份验证时，这可用于 Amazon Redshift 数据库密码而不是 PWD。

此参数为可选项。

Plugin_Name

  • 默认值 – 无

  • 数据类型 – 字符串

用于实施特定凭证提供程序插件的完全限定类名称。

此参数为可选项。

支持以下提供程序选项：

  • AdfsCredentialsProvider – Active Directory 联合身份验证服务

  • AzureCredentialsProvider – Microsoft Azure Active Directory （AD） 服务

  • BrowserAzureCredentialsProvider 浏览器 Microsoft Azure Active Directory （AD） 服务–

  • BrowserSamlCredentialsProvider 适用于 SAML 服务（如 Okta、Ping 或 ADFS）的浏览器 SAML–

  • OktaCredentialsProvider Okta 服务–

  • PingCredentialsProvider – PingFederate 服务

首选角色

  • 默认值 – 无

  • 数据类型 – 字符串

要在连接到 Amazon Redshift 期间代入的 IAM 角色。

此参数为可选项。

Profile

  • 默认值 – 无

  • 数据类型 – 字符串

用于 IAM 身份验证的配置文件的名称。此配置文件包含在连接字符串中未指定的任何其他连接属性。

此参数为可选项。

PWD

  • 默认值 – 无

  • 数据类型 – 字符串

与您使用属性 UID 提供的 Amazon Redshift 用户名对应的密码。

此参数为可选项。

queryGroup

  • 默认值 – null

  • 数据类型 – 字符串

此选项通过将查询分配给适当的查询组，在运行时向队列分配查询。为会话设置查询组。在连接上执行的所有查询属于此查询组。

此参数为可选项。

ReadOnly

  • 默认值 – false

  • 数据类型 – 布尔值

此属性指定驱动程序是否处于只读模式。

此参数为可选项。

true

连接处于只读模式，无法写入到数据存储。

false

连接未处于只读模式，可以写入数据存储。

reWriteBatchedInsertsSize

  • 默认值 – 128

  • 数据类型 – 整数

此选项启用优化以重写并组合已批处理的兼容的 INSERT 语句。此值必须以指数方式增加 2 的力度。

此参数为可选项。

SecretAccessKey

  • 默认值 – 无

  • 数据类型 – 字符串

用户或角色的 IAM 访问密钥。如果指定此项，则还必须指定 AccessKeyID。

此参数为可选项。

SessionToken

  • 默认值 – 无

  • 数据类型 – 字符串

与您用于进行身份验证的 IAM 角色关联的临时 IAM 会话令牌。

此参数为可选项。

SocketTimeout

  • 默认值 – 0

  • 数据类型 – 整数

套接字读取操作发生超时前等待的秒数。如果操作用时长于此阈值，则连接将关闭。当此属性设置为 0 时，连接不会超时。

此参数为可选项。

SSL

  • 默认值 – TRUE

  • 数据类型 – 字符串

可以使用该属性为连接启用或禁用 SSL。

此参数为可选项。

可以指定以下值：

TRUE

驱动程序通过 SSL 连接到服务器。

FALSE

驱动程序在不使用 SSL 的情况下连接到服务器。IAM 身份验证不支持此选项。

或者，您可以配置 AuthMech 属性。

SSL 不安全

  • 默认值 – true

  • 数据类型 – 字符串

此属性指示是否应验证 IDP 托管服务器证书。

此参数为可选项。

可以指定以下值：

true

驱动程序不会检查 IDP 服务器证书的真实性。

false

驱动程序将检查 IDP 服务器证书的真实性。

SSLCert

  • 默认值 – 无

  • 数据类型 – 字符串

包含其他受信任 CA 证书的 .pem 或 .crt 文件的完整路径，用于在使用 SSL 时验证 Amazon Redshift 服务器实例。

如果指定了 SSLKey，则此参数是必需的。

SSLFactory

  • 默认值 – 无

  • 数据类型 – 字符串

在不使用服务器证书的情况下通过 TLS/SSL 连接到服务器时使用的 SSL 工厂。

SSLKey

  • 默认值 – 无

  • 数据类型 – 字符串

包含 PKCS8 密钥文件的 .der 文件的完整路径，用于验证 SSLCert 中指定的证书。

如果指定了 SSLCert，则此参数是必需的。

SSLMode

  • 默认值 – verify-ca

  • 数据类型 – 字符串

使用此属性可指定在启用 TLS/SSL 时驱动程序如何验证证书。

此参数为可选项。

可以指定以下值：

verify-ca

驱动程序将验证证书是否来自可信证书颁发机构 （CA）。

verify-full

驱动程序将验证证书是否来自受信任的 CA，以及证书中的主机名是否与连接 URL 中指定的主机名匹配。

SSLPassword

  • 默认值 – 0

  • 数据类型 – 字符串

中指定的加密密钥文件的密码。SSLKey

如果指定了 SSLKey 并且密钥文件已加密，则此参数是必需的。

SSLRootCert

  • 默认值 – 无

  • 数据类型 – 字符串

.pem 或 .crt 文件的完整路径，该文件包含用于在使用 SSL 时验证 Amazon Redshift 服务器实例的根 CA 证书。

TCPKeepAlive

  • 默认值 – TRUE

  • 数据类型 – 字符串

可以使用该属性启用或禁用 TCP keepalive。

此参数为可选项。

可以指定以下值：

TRUE

驱动程序使用 TCP keepalive 来防止连接超时。

FALSE

驱动程序不使用 TCP keepalive。

UID

  • 默认值 – 无

  • 数据类型 – 字符串

用于访问数据库的用户名。

此参数为必需参数。

User

  • 默认值 – 无

  • 数据类型 – 字符串

当使用 IAM 身份验证通过 IDP 进行连接时，这是 idp_host 服务器的用户名。使用标准身份验证时，这可用于 Amazon Redshift 数据库用户名。

此参数为可选项。