JDBC 驱动程序版本 2.0 配置选项 - Amazon Redshift
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

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

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

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

AccessKeyID

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

AllowDBUserOverride

  • 默认值— 0

  • 数据类型— String

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

此参数为可选项。

1

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

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

0

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

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

app_id

  • 默认值— 无

  • 数据类型— String

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

如果通过 Okta 服务进行身份验证,则需要此参数。

应用程序名称

  • 默认值— 无

  • 数据类型— String

您用于验证与 Amazon Redshift 的连接的 Okta 应用程序的名称。

此参数为可选项。

AutoCreate

  • 默认值— false

  • 数据类型— 布尔值

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

此参数为可选项。

true

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

false

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

客户_id

  • 默认值— 无

  • 数据类型— String

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

如果通过 Azure AD 服务进行身份验证,则需要此参数。

客户端 _ 密钥

  • 默认值— 无

  • 数据类型— String

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

如果通过 Azure AD 服务进行身份验证,则需要此参数。

ClusterID

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

databaseMetadataCurrentDbOnly

  • 默认值— true

  • 数据类型— 布尔值

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

此参数为可选项。

可以指定以下值:

true

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

false

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

DbUser

  • 默认值— 无

  • 数据类型— String

用于您的 Amazon Redshift 账户的用户 ID。如果启用了 “AutoCreate” 属性,则可以使用当前不存在的 ID。

此参数为可选项。

DbGroups

  • 默认值— 公有

  • 数据类型— String

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

此参数为可选项。

defaultRowFetchSize

  • 默认值— 0

  • 数据类型— 整数

此选项指定获取大小的默认值。

此参数为可选项。

可以指定以下值:

0

在单一操作中获取所有行。

正整数

对于 ResultSet 的每次读取小版本,要从数据库中读取的行数。

DisableIsValidQuery

  • 默认值— false

  • 数据类型— 布尔值

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

此参数为可选项。

true

驱动程序在使用连接时不提交查询。ISVALID () 用于确定数据库连接是否处于活动状态。这可能会导致驱动程序错误地将数据库连接标识为活动,如果数据库服务器意外关闭。

false

驱动程序在使用连接时提交查询 .isvalid () 以确定数据库连接是否处于活动状态。

enableFetchRingBuffer

  • 默认值— true

  • 数据类型— 布尔值

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

此参数为可选项。

enableMultiSqlSupport

  • 默认值— true

  • 数据类型— 布尔值

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

此参数为可选项。

可以指定以下值:

true

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

false

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

fetchRingBufferSize

  • 默认值— 1 克

  • 数据类型— String

此选项指定在获取结果集时使用的环形缓冲区的大小。您可以指定以字节为单位的大小,例如 1K 表示 1 KB,5000 代表 5,000 字节,1M 表示 1 MB,1G 表示 1 GB,依此类推。您还可以指定堆内存的百分比。驱动程序在达到限制时停止读取行。当应用程序读取行并释放环形缓冲区中的空间时,读取将恢复。

此参数为可选项。

ForceLowercase

  • 默认值— false

  • 数据类型— 布尔值

此选项指定在使用 SSO 身份验证时,驱动程序是否将从身份提供程序发送到 Amazon Redshift 的所有数据库组 (DBGroups) 小写。

此参数为可选项。

true

驱动程序会小写从身份提供程序发送的所有数据库组。

false

驱动程序不会更改数据库组。

IAMDisableCache

  • 默认值— false

  • 数据类型— 布尔值

此选项指定是否缓存 IAM 凭证。

此参数为可选项。

true

IAM 凭证不会被缓存。

false

IAM 凭证将被缓存。例如,当对 API 网关的请求受到限制时,这可以提高性能。

IAMDuration

  • 默认值— 900

  • 数据类型— 整数

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

  • 最小值— 900

  • 最大值— 3600

此参数为可选项。

idp_host

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

idp_port

  • 默认值— 无

  • 数据类型— String

IdP(身份提供程序)使用的端口。这可以在连接字符串或配置文件中指定。

此参数为可选项。

IDP_tenant

  • 默认值— 无

  • 数据类型— String

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

如果通过 Azure AD 服务进行身份验证,则需要此参数。

IDP_ 响应 _ 超时

  • 默认值— 120

  • 数据类型— 整数

当通过浏览器插件使用 SAML 或 Azure AD 服务时,驱动程序等待身份提供商的 SAML 响应的时间(以秒为单位)。

此参数为可选项。

登录网址

  • 默认值— 无

  • 数据类型— String

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

如果通过浏览器插件使用 SAML 或 Azure AD 服务进行身份验证,则此参数是必需的。

LoginTimeout

  • 默认值— 0

  • 数据类型— 整数

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

当此属性设置为 0 时,连接不会发生超时。

此参数为可选项。

loginToRp

  • 默认值urn:amazon:webservices

  • 数据类型— String

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

此参数为可选项。

LogLevel

  • 默认值— 0

  • 数据类型— 整数

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

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

此参数为可选项。

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

0

禁用所有日志记录。

1

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

2

在 ERROR 级别启用记录,记录也许不会导致驱动程序中止运行的错误事件。

3

启用警告级别的日志记录,该日志记录在未执行操作时可能导致错误的事件。

4

在 INFO 级别启用记录,记录描述驱动程序进程的一般信息。

5

在 DEBUG 级别启用日志记录,该日志记录用于调试驱动程序的详细信息。

6

启用 TRACE 级别的日志记录,记录所有驱动程序活动。

启用日志记录后,驱动程序会在LogPath属性:

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

  • redshift_jdbc_connection_[Number].log— 与数据库建立的每个连接的文件,其中[Number]是区分每个日志文件和其他日志文件的数字。此文件记录特定于连接的驱动程序活动。

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

LogPath

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

  • 数据类型— String

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

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

此参数为可选项。

合作伙伴

  • 默认值— 无

  • 数据类型— String

在使用 PingFederate 合服务验证连接时使用的伙伴 SPID(服务提供商 ID)值。

此参数为可选项。

Password

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

Plugin_Name

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

支持以下提供程序选项:

  • AdfsCredentialsProvider— Active Directory 身份验证服务

  • AzureCredentialsProvider— Microsoft Azure Active Directory (AD) Active Directory 服务

  • BasicJwtCredentialsProvider— JSON 网络令牌(JWT)服务

  • BrowserAzureCredentialsProvider— 浏览器 Microsoft Azure Active Directory (AD) 服务

  • BrowserSamlCredentialsProvider— 用于 SAML 服务(如 Okta、Ping 或 ADFS)的浏览器 SAML

  • OktaCredentialsProvider— Okta Service

  • PingCredentialsProvider— PingFederate 务

首选 _role

  • 默认值— 无

  • 数据类型— String

您希望在与 Amazon Redshift 连接期间担任的 IAM 角色。

此参数为可选项。

Profile

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

PWD

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

queryGroup

  • 默认值— Null

  • 数据类型— String

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

此参数为可选项。

ReadOnly

  • 默认值— false

  • 数据类型— 布尔值

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

此参数为可选项。

true

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

false

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

Region

  • 默认值— Null

  • 数据类型— String

此选项指定Amazon群集所在的区域。如果指定 “标准点” 选项,则会忽略 “区域” 选项。(中国)GetClusterCredentialsAPI 操作还使用区域选项。

此参数为可选项。

reWriteBatchedInsertsSize

  • 默认值— 128

  • 数据类型— 整数

通过此选项,可以优化重写和组合批处理的兼容 INSERT 语句。此值必须以 2 的幂呈指数增加。

此参数为可选项。

roleArn

  • 默认值— 无

  • 数据类型— String

角色的 Amazon 资源名称 (ARN)。在为 “插件名称” 选项指定基本证书提供程序时,请确保指定此参数。采用以下格式指定 ARN:

arn:partition:service:region:account-id:resource-id

如果您为插件名称指定基本证书提供商,则此参数是必需的。

roleSessionName

  • 默认值— 红色移动会话

  • 数据类型— String

所担任角色会话的标识符。通常,您可以传递与应用程序用户关联的名称或标识符。您的应用程序使用的临时安全证书与该用户相关联。当您为插件名称指定基本证书提供商时,您可以指定此参数。

此参数为可选项。

SecretAccessKey

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

SessionToken

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

SocketTimeout

  • 默认值— 0

  • 数据类型— 整数

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

此参数为可选项。

SSL

  • 默认值— TRUE

  • 数据类型— String

使用此属性可以启用或禁用 SSL。

此参数为可选项。

可以指定以下值:

TRUE

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

FALSE

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

此外,也可以配置 AuthMech 属性。

SSL_不安全

  • 默认值— true

  • 数据类型— String

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

此参数为可选项。

可以指定以下值:

true

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

false

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

SSLCert

  • 默认值— 无

  • 数据类型— String

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

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

SSLFactory

  • 默认值— 无

  • 数据类型— String

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

SSLKey

  • 默认值— 无

  • 数据类型— String

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

如果指定了 SSLCERT,则此为必需参数。

SSLMode

  • 默认值— 核实

  • 数据类型— String

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

此参数为可选项。

可以指定以下值:

verify-ca

驱动程序将验证证书来自受信证书颁发机构 (CA)。

verify-full

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

SSLPassword

  • 默认值— 0

  • 数据类型— String

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

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

SSLRootCert

  • 默认值— 无

  • 数据类型— String

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

StsEndpointUrl

  • 默认值— Null

  • 数据类型— String

您可以指定Amazon Security Token Service(Amazon STS)终端节点。如果指定此选项,则 “区域” 选项将被忽略。您只能为此端点指定安全协议 (HTTPS)。

TCPKeepAlive

  • 默认值— TRUE

  • 数据类型— String

使用此属性可以启用或禁用 TCP 保存。

此参数为可选项。

可以指定以下值:

TRUE

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

FALSE

驱动程序不会使用 TCP Keepalive。

UID

  • 默认值— 无

  • 数据类型— String

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

此参数为必需参数。

User

  • 默认值— 无

  • 数据类型— String

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

此参数为可选项。

webIdentityToken

  • 默认值— 无

  • 数据类型— String

由身份提供商提供的 OAuth 2.0 访问令牌或 OpenID Connect ID 令牌。您的应用程序必须通过 Web 身份提供商对您的应用程序用户进行身份验证来获取此令牌。在为 “插件名称” 选项指定基本证书提供程序时,请确保指定此参数。

如果您为插件名称指定基本证书提供商,则此参数是必需的。