ODBC 驅動程式選項 - Amazon Redshift
AccessKeyIDapp_idapp_nameAuthProfileAuthTypeAutoCreateCaFileclient_id client_ secretClusterIdcompression資料庫DatabaseMetadataCurrentDbOnlydbgroups_filter驅動程式DSNEndpointUrlForceLowercasegroup_federationhttps_proxy_hosthttps_proxy_passwordhttps_proxy_porthttps_proxy_usernameIAMidc_client_display_nameidc_regionidp_hostidp_portidp_response_timeoutidp_tenantidp_use_https_proxyInstanceProfile發行者_urlKeepAliveKeepAliveCountKeepAliveIntervalKeepAliveTimelisten_portlogin_urlloginToRpLogLevelLogPath最小值_TLSpartner_spid密碼 | PWSplugin_name連接埠 | PortNumberpreferred_role設定檔provider_nameProxyHostProxyPortProxyPwdProxyUidReadOnlyregionSecretAccessKeySessionToken伺服器 | HostName | 主機ssl_insecureSSLModeStsConnectionTimeoutStsEndpointUrltokentoken_typeUID | 使用者 | LogonIDweb_identity_token

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

ODBC 驅動程式選項

您可以使用驅動程式組態選項來控制 Amazon Redshift ODBC驅動程式的行為。驅動程式選項不區分大小寫。

在 Microsoft Windows 中，您通常會在設定資料來源名稱 （） 時設定驅動程式選項DSN。您也可以在連接時以程式設計方式在連線字串中設定驅動程式選項，或在 HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\your_DSN 中新增或變更登錄機碼。

在 Linux 中，您可以在 odbc.ini和 amazon.redshiftodbc.ini 檔案中設定驅動程式組態選項。在 amazon.redshiftodbc.ini 檔案中設定的組態選項會套用至所有連線。相反地，odbc.ini 檔案中設定的組態選項是針對某個連線。odbc.ini 中設定的組態選項優先於 amazon.redshiftodbc.ini 中設定的組態選項。

以下是您可以為 Amazon Redshift 2.x ODBC版驅動程式指定的選項說明：

AccessKeyID

  • 預設值 — 無

  • 資料類型 — 字串

使用者或角色的IAM存取金鑰。如果您設定此參數，也必須指定 SecretAccessKey。

此為選用參數。

app_id

  • 預設值 — 無

  • 資料類型 — 字串

與您的 Amazon Redshift 應用程式相關聯、Okta 所提供的唯一 ID。

此為選用參數。

app_name

  • 預設值 — 無

  • 資料類型 — 字串

您用來驗證與 Amazon Redshift 之連線的 Okta 應用程式名稱。

此為選用參數。

AuthProfile

  • 預設值 — 無

  • 資料類型 — 字串

用來管理連線設定的身分驗證設定檔。如果您設定此參數，也必須設定 AccessKeyID 和 SecretAccessKey。

此為選用參數。

AuthType

  • 預設值 — 標準

  • 資料類型 — 字串

此選項指定驅動程式在您DSN使用 Amazon Redshift ODBC 驅動程式DSN設定對話方塊設定 時所使用的身分驗證模式：

  • 標準：使用 Amazon Redshift 使用者名稱和密碼的標準身分驗證。

  • AWS 設定檔：使用設定檔進行IAM身分驗證。

  • AWS IAM 憑證：使用IAM憑證進行IAM身分驗證。

  • Identity Provider：AD FS：使用 Active Directory Federation Services （AD FS） 進行IAM身分驗證。

  • Identity Provider：Auth Plugin：從任何連結至 AWS IAM Identity Center 的 Web Identity Provider 接受 AWS IAM Identity Center 權杖或 OpenID Connect （OIDC） JSON型身分權杖 （JWT） 的授權外掛程式。

  • Identity Provider：Azure AD：使用 Azure AD 入口網站進行IAM身分驗證。

  • 身分提供者：JWT：使用 JSON Web 權杖進行IAM身分驗證 （JWT）。

  • Identity Provider：Okta：使用 Okta 進行IAM身分驗證。

  • Identity Provider： PingFederate：使用 進行IAM身分驗證 PingFederate。

只有在您使用 Windows ODBC驅動程式中的 Amazon Redshift Driver DSN Setup 對話方塊設定 時DSN，才能使用此選項。當您使用連線字串或非 Windows 機器設定連線時，驅動程式會根據您指定的憑證自動決定是否使用標準、 AWS 設定檔或 AWS IAM憑證身分驗證。若要使用身分提供者，您必須設定 plugin_name 屬性。

此為必要參數。

AutoCreate

  • 預設值 — 0

  • 資料類型 — 布林值

指定當所指定的使用者不存在時，驅動程式是否會建立新使用者的布林值。

  • 1 | TRUE：如果 UID 指定的使用者不存在，驅動程式會建立新的使用者。

  • 0 | FALSE：驅動程式不會建立新的使用者。如果指定的使用者不存在，則身分驗證會失敗。

此為選用參數。

CaFile

  • 預設值 — 無

  • 資料類型 — 字串

用於某些形式IAM身分驗證的 CA 憑證檔案的檔案路徑。

這個參數只能在 Linux 上使用。

此為選用參數。

client_id

  • 預設值 — 無

  • 資料類型 — 字串

與 Azure AD 中 Amazon Redshift 應用程式相關聯的用戶端 ID。

如果透過 Azure AD 服務進行驗證，則需要此參數。

client_ secret

  • 預設值 — 無

  • 資料類型 — 字串

與 Azure AD 中 Amazon Redshift 應用程式相關聯的私密金鑰。

如果透過 Azure AD 服務進行驗證，則需要此參數。

ClusterId

  • 預設值 — 無

  • 資料類型 — 字串

您想要連線到之 Amazon Redshift 叢集的名稱。它用於IAM身分驗證。伺服器參數中不會指定叢集 ID。

此為選用參數。

compression

  • 預設值 – 關閉

  • 資料類型 — 字串

用於 Amazon Redshift 伺服器與用戶端或驅動程式之間的有線通訊協定通訊的壓縮方法。

您可以指定下列值：

  • lz4：將用於與 Amazon Redshift 進行有線通訊協定通訊的壓縮方法設定為 lz4。

  • zstd：將用於與 Amazon Redshift 進行有線通訊協定通訊的壓縮方法設定為 zstd。

  • 關閉：不會使用壓縮來與 Amazon Redshift 進行有線通訊協定通訊。

此為選用參數。

資料庫

  • 預設值 — 無

  • 資料類型 — 字串

您想要存取之 Amazon Redshift 資料庫的名稱。

此為必要參數。

DatabaseMetadataCurrentDbOnly

  • 預設值 — 1

  • 資料類型 — 布林值

指定驅動程式是否會從多個資料庫和叢集傳回中繼資料的布林值。

  • 1 | TRUE：驅動程式只會傳回目前資料庫的中繼資料。

  • 0 | FALSE。驅動程式會傳回多個 Amazon Redshift 資料庫和叢集的中繼資料。

此為選用參數。

dbgroups_filter

  • 預設值 — 無

  • 資料類型 — 字串

您可以使用 Azure、Browser Azure 和 Browser SAML身分驗證類型，指定篩選從 Amazon Redshift SAML回應接收 DbGroups 的規則運算式。

此為選用參數。

驅動程式

  • 預設值 – Amazon Redshift ODBC驅動程式 （x64）

  • 資料類型 — 字串

驅動程式的名稱。唯一支援的值是 Amazon Redshift ODBC Driver （x64）。

如果您未設定 ，則需要此參數DSN。

DSN

  • 預設值 — 無

  • 資料類型 — 字串

驅動程式資料來源名稱的名稱。應用程式會在 DSN中指定 SQLDriverConnect API。

如果您未設定驅動程式，則需要此參數。

EndpointUrl

  • 預設值 — 無

  • 資料類型 — 字串

用於與 Amazon Redshift Coral Service 通訊以進行IAM身分驗證的覆寫端點。

此為選用參數。

ForceLowercase

  • 預設值 — 0

  • 資料類型 — 布林值

布林值，指定在使用單一登入身分驗證時，驅動程式是否將所有從身分提供者 DbGroups 傳送至 Amazon Redshift 的案例都設為小寫。

  • 1 | TRUE：驅動程式會小寫所有從身分提供者傳送 DbGroups 的 。

  • 0 | FALSE：驅動程式不會變更 DbGroups。

此為選用參數。

group_federation

  • 預設值 — 0

  • 資料類型 — 布林值

布林值，指定 getClusterCredentialsWithIAM API 是否用於在佈建叢集中取得臨時叢集憑證。此選項可IAM讓使用者與佈建叢集中的 Redshift 資料庫角色整合。請注意，此選項不適用於 Redshift Serverless 命名空間。

  • 1 | TRUE：驅動程式使用 getClusterCredentialsWithIAMAPI來取得佈建叢集中的臨時叢集憑證。

  • 0 | FALSE：驅動程式使用 預設值getClusterCredentialsAPI在佈建叢集中取得臨時叢集憑證。

此為選用參數。

https_proxy_host

  • 預設值 — 無

  • 資料類型 — 字串

您要傳遞IAM身分驗證程序的代理伺服器的主機名稱或 IP 地址。

此為選用參數。

https_proxy_password

  • 預設值 — 無

  • 資料類型 — 字串

您用來存取代理伺服器的密碼。它用於IAM身分驗證。

此為選用參數。

https_proxy_port

  • 預設值 — 無

  • 資料類型 — 整數

代理伺服器用來接聽用戶端連線的連接埠號碼。它用於IAM身分驗證。

此為選用參數。

https_proxy_username

  • 預設值 — 無

  • 資料類型 — 字串

您用來存取代理伺服器的使用者名稱。它用於IAM身分驗證。

此為選用參數。

IAM

  • 預設值 — 0

  • 資料類型 — 布林值

布林值，指定驅動程式是否使用IAM身分驗證方法來驗證連線。

  • 1 | TRUE：驅動程式使用其中一種IAM身分驗證方法 （使用存取金鑰和私密金鑰對，或設定檔或憑證服務）。

  • 0 | FALSE。驅動程式會使用標準身分驗證 (使用資料庫使用者名稱和密碼)。

此為選用參數。

idc_client_display_name

  • 預設值 – Amazon Redshift ODBC驅動程式

  • 資料類型 — 字串

用於使用 之用戶端的顯示名稱 BrowserIdcAuthPlugin。

此為選用參數。

idc_region

  • 預設值 — 無

  • 資料類型 — 字串

Identity Center 執行個體所在的 AWS 區域 AWS IAM。

只有在 Plugin_name 組態選項BrowserIdcAuthPlugin中使用 驗證時，才需要此參數。

idp_host

  • 預設值 — 無

  • 資料類型 — 字串

您用來對 Amazon Redshift 進行身分驗證的 IdP (身分提供者) 主機。

此為選用參數。

idp_port

  • 預設值 — 無

  • 資料類型 — 整數

您用來對 Amazon Redshift 進行身分驗證的 IdP (身分提供者) 連接埠。根據您在建立、修改或遷移叢集時所選取的連接埠而定，允許存取選取的連接埠。

此為選用參數。

idp_response_timeout

  • 預設值 — 120

  • 資料類型 — 整數

透過瀏覽器外掛程式使用 SAML或 Azure AD 服務時，驅動程式等待身分提供者SAML回應的秒數。

此為選用參數。

idp_tenant

  • 預設值 — 無

  • 資料類型 — 字串

與 Amazon Redshift 應用程式相關聯的 Azure AD 租用戶 ID。

如果透過 Azure AD 服務進行驗證，則需要此參數。

idp_use_https_proxy

  • 預設值 — 0

  • 資料類型 — 布林值

指定驅動程式是否會透過代理伺服器來通過身分提供者 (IdP) 身分驗證程序的布林值。

  • 1 | TRUE：驅動程式透過代理伺服器傳遞 IdP 身分驗證程序。

  • 0 | FALSE。驅動程式不會透過代理伺服器來通過 IdP 身分驗證程序。

此為選用參數。

InstanceProfile

  • 預設值 — 0

  • 資料類型 — 布林值

當設定為使用設定檔進行身分驗證時，指定驅動程式是否使用 Amazon EC2執行個體設定檔的布林值。

  • 1 | TRUE：驅動程式使用 Amazon EC2執行個體設定檔。

  • 0 | FALSE。驅動程式會改用 [設定檔名稱] 選項 (設定檔) 所指定的鏈結角色設定檔。

此為選用參數。

發行者_url

  • 預設值 — 無

  • 資料類型 — 字串

指向 AWS IAM Identity Center 伺服器的執行個體端點。

只有在 Plugin_name 組態選項BrowserIdcAuthPlugin中使用 驗證時，才需要此參數。

KeepAlive

  • 預設值 — 1

  • 資料類型 — 布林值

布林值，指定驅動程式是否使用 TCP keepalives 來防止連線逾時。

  • 1 | TRUE：驅動程式使用TCP保持連線防止連線逾時。

  • 0 | FALSE。驅動程式不使用 TCP keepalives。

此為選用參數。

KeepAliveCount

  • 預設值 — 0

  • 資料類型 — 整數

在連線被視為中斷之前，可能遺失的TCP保持連線封包數量。此參數設為 0 時，驅動程式會使用此設定的系統預設值。

此為選用參數。

KeepAliveInterval

  • 預設值 — 0

  • 資料類型 — 整數

每次TCP保持連線重新傳輸之間的秒數。此參數設為 0 時，驅動程式會使用此設定的系統預設值。

此為選用參數。

KeepAliveTime

  • 預設值 — 0

  • 資料類型 — 整數

驅動程式傳送TCP保持連線封包之前閒置的秒數。此參數設為 0 時，驅動程式會使用此設定的系統預設值。

此為選用參數。

listen_port

  • 預設值 — 7890

  • 資料類型 — 整數

透過瀏覽器外掛程式使用 SAML、Azure AD 或 AWS IAM Identity Center 服務時，驅動程式用來接收身分提供者或授權碼SAML回應的連接埠。

此為選用參數。

login_url

  • 預設值 — 無

  • 資料類型 — 字串

使用一般 Browser SAML外掛程式時，身分提供者網站上URL資源的 。

如果透過瀏覽器外掛程式使用 SAML或 Azure AD 服務進行驗證，則需要此參數。

loginToRp

  • 預設值 — urn:amazon:webservices

  • 資料類型 — 字串

您要用於 AD FS 身分驗證類型的依賴方信任。

此為選用字串。

LogLevel

  • 預設值 — 0

  • 資料類型 — 整數

使用此屬性可在驅動程式中啟用或停用日誌記錄，以及指定日誌檔案中包含的詳細資訊數量。日誌記錄建議只啟用到足以擷取到問題就好，因為日誌記錄會降低效能，而且可能會耗用大量磁碟空間。

將此屬性設為以下其中一個值：

  • 0：OFF。停用所有日誌記錄功能。

  • 1：ERROR。記錄可能允許驅動程式繼續執行但會產生錯誤的錯誤事件。

  • 2：API_CALL。使用ODBCAPI函數引數值記錄函數呼叫。

  • 3：INFO。記錄用於描述驅動程式進展的一般資訊。

  • 4：MSG_PROTOCOL。記錄驅動程式的訊息通訊協定詳細資訊。

  • 5：DEBUG。記錄所有驅動程式活動。

  • 6：DEBUG_APPEND。持續附加所有驅動程式活動的日誌。

啟用記錄時，驅動程式會在您在 LogPath 屬性中指定的位置產生下列日誌檔案：

  • 記錄在連線交握期間發生之驅動程式活動的 redshift_odbc.log.1 檔案。

  • 在與資料庫建立連線後所有驅動程式活動的 redshift_odbc.log 檔案。

此為選用參數。

LogPath

  • 預設值 – 作業系統特定的TEMP目錄

  • 資料類型 — 字串

驅動程式在 LogLevel 高於 0 時儲存日誌檔案的資料夾完整路徑。

此為選用參數。

最小值_TLS

  • 預設值 – 1.2

  • 資料類型 — 字串

驅動程式允許資料存放區用於加密連線的 TLS/SSL 最低版本。例如，如果指定 TLS 1.2，則 1.1 TLS 無法用來加密連線。

Min_TLS 接受下列值：

  • 1.0：連線必須至少使用 TLS 1.0。

  • 1.1：連線必須至少使用 TLS 1.1。

  • 1.2：連線必須至少使用 TLS 1.2。

此為選用參數。

partner_spid

  • 預設值 — 無

  • 資料類型 — 字串

使用 服務驗證連線時要使用的合作夥伴 SPID（服務供應商 ID） 值 PingFederate 。

此為選用參數。

密碼 | PWS

  • 預設值 — 無

  • 資料類型 — 字串

與您在使用者欄位 （UID | 使用者 | LogonID） 中提供之資料庫使用者名稱對應的密碼。

此為選用參數。

plugin_name

  • 預設值 — 無

  • 資料類型 — 字串

您想要用於身分驗證的憑證提供者外掛程式名稱。

支援下列值：

  • ADFS：使用 Active Directory Federation Services 進行身分驗證。

  • AzureAD：使用 Microsoft Azure Active Directory (AD) Service 進行身分驗證。

  • BrowserAzureAD：使用 Microsoft Azure Active Directory (AD) Service 的瀏覽器外掛程式進行身分驗證。

  • BrowserIdcAuthPlugin ：使用 AWS IAM Identity Center 的授權外掛程式。

  • BrowserSAML：針對 Okta 或 Ping 等SAML服務使用瀏覽器外掛程式進行身分驗證。

  • IdpTokenAuthPlugin：一種授權外掛程式，可接受來自連結至 AWS IAM AWS IAM Identity Center 之任何 Web 身分提供者的 Identity Center 權杖或 OpenID Connect （OIDC） JSON型身分權杖 （JWT）。

  • JWT：使用 JSON Web 權杖 （JWT） 進行身分驗證。

  • Ping：使用 PingFederate 服務進行身分驗證。

  • Okta：使用 Okta 服務進行身分驗證。

此為選用參數。

連接埠 | PortNumber

  • 預設值 — 5439

  • 資料類型 — 整數

Amazon Redshift 伺服器用來接聽用戶端連線的TCP連接埠數目。

此為選用參數。

preferred_role

  • 預設值 — 無

  • 資料類型 — 字串

您要在連線到 Amazon Redshift 期間擔任的角色。它用於IAM身分驗證。

此為選用參數。

設定檔

  • 預設值 — 無

  • 資料類型 — 字串

用於向 Amazon Redshift 驗證的使用者 AWS 設定檔名稱。

  • 如果使用執行個體設定檔參數 （ InstanceProfile 屬性） 設定為 1 | TRUE，則設定優先，且驅動程式改用 Amazon EC2執行個體設定檔。

  • 包含設定檔之憑證檔案的預設位置為 ~/.aws/Credentials。可使用 AWS_SHARED_CREDENTIALS_FILE 環境變數以指向不同的憑證檔案。

此為選用參數。

provider_name

  • 預設值 — 無

  • 資料類型 — 字串

使用者使用CREATEIDENTITYPROVIDER查詢建立的身分驗證提供者。其會用於原生 Amazon Redshift 身分驗證。

此為選用參數。

ProxyHost

  • 預設值 — 無

  • 資料類型 — 字串

您想要透過其進行連線之代理伺服器的主機名稱或 IP 地址。

此為選用參數。

ProxyPort

  • 預設值 — 無

  • 資料類型 — 整數

代理伺服器用來接聽用戶端連線的連接埠號碼。

此為選用參數。

ProxyPwd

  • 預設值 — 無

  • 資料類型 — 字串

您用來存取代理伺服器的密碼。

此為選用參數。

ProxyUid

  • 預設值 — 無

  • 資料類型 — 字串

您用來存取代理伺服器的使用者名稱。

此為選用參數。

ReadOnly

  • 預設值 — 0

  • 資料類型 — 布林值

指定驅動程式是否處於唯讀模式的布林值。

  • 1 | TRUE：連線處於唯讀模式，無法寫入資料存放區。

  • 0 | FALSE：連線未處於唯讀模式，可以寫入資料存放區。

此為選用參數。

region

  • 預設值 — 無

  • 資料類型 — 字串

叢集所在的 AWS 區域。

此為選用參數。

SecretAccessKey

  • 預設值 — 無

  • 資料類型 — 字串

使用者或角色的IAM秘密金鑰。如果您設定此參數，也必須設定 AccessKeyID 。

此為選用參數。

SessionToken

  • 預設值 — 無

  • 資料類型 — 字串

與您用來驗證之IAM角色相關聯的臨時IAM工作階段權杖。

此為選用參數。

伺服器 | HostName | 主機

  • 預設值 — 無

  • 資料類型 — 字串

要連線到的端點伺服器。

此為必要參數。

ssl_insecure

  • 預設值 — 0

  • 資料類型 — 布林值

指定驅動程式是否會檢查 IdP 伺服器憑證真確性的布林值。

  • 1 | TRUE：驅動程式不會檢查 IdP 伺服器憑證的真實性。

  • 0 | FALSE：驅動程式會檢查 IdP 伺服器憑證的真實性

此為選用參數。

SSLMode

  • 預設值 — verify-ca

  • 資料類型 — 字串

連線至 Amazon Redshift 時要使用的SSL憑證驗證模式。可能的值如下：

  • verify-full：僅使用 SSL連線、受信任憑證授權機構，以及符合憑證的伺服器名稱。

  • verify-ca：僅限使用 SSL和受信任憑證授權機構進行連線。

  • require：僅使用 連線SSL。

  • prefer：SSL如果可用，請使用 連線。否則，不使用 連線SSL。

  • allow：根據預設，無需使用 即可連線SSL。如果伺服器需要SSL連線，請使用 SSL。

  • disable：不使用 連線SSL。

此為選用參數。

StsConnectionTimeout

  • 預設值 — 0

  • 資料類型 — 整數

IAM 連線的等待時間上限，以秒為單位。如果設定為 0 或未指定，則驅動程式會等待 60 秒進行每次 AWS STS 呼叫。

此為選用參數。

StsEndpointUrl

  • 預設值 — 無

  • 資料類型 — 字串

此選項會指定用來與 AWS Security Token Service (AWS STS) 進行通訊的覆寫端點。

此為選用參數。

token

  • 預設值 — 無

  • 資料類型 — 字串

Identity Center AWS IAM提供的存取權杖或由與 AWS IAM Identity Center 連結的 Web 身分提供者提供的 OpenID Connect （OIDC） JSON Web 權杖 （JWT）。您的應用程式必須透過使用 AWS IAM Identity Center 或與 Identity Center AWS IAM連結的身分提供者驗證應用程式的使用者來產生此權杖。

此參數適用於 IdpTokenAuthPlugin。

token_type

  • 預設值 — 無

  • 資料類型 — 字串

在 中使用的權杖類型IdpTokenAuthPlugin。

您可以指定下列值：

ACCESS_TOKEN

如果您使用 Identity Center 提供的存取權杖， AWS IAM請輸入此選項。

EXT_JWT

如果您使用與 AWS IAM Identity Center 整合的 Web 型身分提供者提供的 OpenID Connect （OIDC） JSON Web 權杖 （JWT），請輸入此選項。

此參數適用於 IdpTokenAuthPlugin。

UID | 使用者 | LogonID

  • 預設值 — 無

  • 資料類型 — 字串

您用來存取 Amazon Redshift 伺服器的使用者名稱。

若您使用資料庫身分驗證，則此為必要參數。

web_identity_token

  • 預設值 — 無

  • 資料類型 — 字串

身分提供者提供的OAUTH權杖。它用於 JWT 外掛程式。

如果您將 plugin_name 參數設定為 ，則需要此參數 BasicJwtCredentialsProvider。