View a markdown version of this page

ODBC 驅動器選項 - Amazon Redshift
AccessKeyIDapp_idApplicationNameapp_nameAuthProfileAuthTypeAutoCreateCaFileclient_idclient_ secretClusterId壓縮資料庫DatabaseMetadataCurrentDbOnlydbgroups_filter驅動程式DSNEndpointUrlForceLowercasegroup_federationhttps_proxy_hosthttps_proxy_passwordhttps_proxy_porthttps_proxy_usernameIAMidc_client_display_nameidc_regionidp_hostidp_portidp_response_timeoutidp_tenantidp_partitionidp_use_https_proxyInstanceProfileissuer_urlKeepAliveKeepAliveCountKeepAliveIntervalKeepAliveIdlelisten_portlogin_urlloginToRpLogLevelLogPathLoginTimeoutMaxLongVarcharSizeMaxVarcharSizeMin_TLSpartner_spid密碼 | PWDplugin_namePort | PortNumberpreferred_role設定檔provider_nameProxyHostProxyPortProxyPwdProxyUidReadOnlyregionSecretAccessKeySessionTokenServer | HostName | Hostssl_insecureSSLModeStreamingCursorRowsStsConnectionTimeoutStsEndpointUrltokentoken_typeUID | User | LogonIDUseUnicodeweb_identity_token

Amazon Redshift 將不再支援在 2026 年 6 月 30 日之後使用 Python UDFs。我們將開始分階段強制執行。如需 Python 生命週期結束和遷移選項的詳細資訊，請參閱 2025 年 6 月 30 日發佈的部落格文章。

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

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 ODBC 2.x 版驅動程式指定之選項的描述。

AccessKeyID

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

app_id

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

ApplicationName

  • 預設值 — 無

  • 資料類型 — 字串

要傳遞至 Amazon Redshift 以進行稽核的用戶端應用程式名稱。您提供的應用程式名稱會出現在 SYS_CONNECTION_LOG 資料表的 'application_name' 欄中。此名稱有助於在偵錯問題時，追蹤連線來源並進行故障診斷。

此為選用參數。

app_name

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

AuthProfile

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

AuthType

  • 預設值 — 標準

  • 資料類型 — 字串

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

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

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

  • AWS IAM 登入資料：使用 IAM 登入資料的 IAM 身分驗證。

  • 身分提供者：AD FS：使用 Active Directory Federation Services (AD FS) 進行 IAM 身分驗證。

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

  • 身分提供者：Azure AD：使用 Azure AD 入口網站進行 IAM 身分驗證。

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

  • 身分提供者：Okta：使用 Okta 進行 IAM 身分驗證。

  • 身分提供者：PingFederate：使用 PingFederate 進行 IAM 身分驗證。

只有當您使用 Windows 驅動程式中的 [Amazon Redshift ODBC 驅動程式 DSN 設定] 對話方塊設定 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。

此為選用參數。

壓縮

  • 預設值 - off

  • 資料類型 — 字串

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

您可以指定下列值：

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

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

  • off：不要對與 Amazon Redshift 進行的有線通訊協定通訊使用壓縮。

此為選用參數。

資料庫

  • 預設值 — 無

  • 資料類型 — 字串

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

此為必要參數。

DatabaseMetadataCurrentDbOnly

  • 預設值 — 1

  • 資料類型 — 布林值

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

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

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

此為選用參數。

dbgroups_filter

  • 預設值 — 無

  • 資料類型 — 字串

當您使用 Azure、瀏覽器 Azure 和瀏覽器 SAML 身分驗證類型時，可指定來篩選出從 Amazon Redshift 的 SAML 回應收到之 DbGroups 的規則運算式。

此為選用參數。

驅動程式

  • 預設值 — Amazon Redshift ODBC 驅動程式 (x64)

  • 資料類型 — 字串

驅動程式的名稱。唯一支援的值是 Amazon Redshift ODBC 驅動程式 (x64)。

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

DSN

  • 預設值 — 無

  • 資料類型 — 字串

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

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

EndpointUrl

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

ForceLowercase

  • 預設值 — 0

  • 資料類型 — 布林值

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

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

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

此為選用參數。

group_federation

  • 預設值 — 0

  • 資料類型 — 布林值

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

  • 1 | TRUE：驅動器使用 getClusterCredentialsWithIAM API 在佈建叢集中取得臨時叢集憑證。

  • 0 | FALSE：驅動器使用預設 getClusterCredentials API 在佈建叢集中取得臨時叢集憑證。

此為選用參數。

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

  • 預設值 — 無

  • 資料類型 — 字串

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

只有在 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_partition

  • 預設值 — 無

  • 資料類型 — 字串

指定設定身分提供者 (IdP) 的雲端分割區。這會決定驅動程式連線到哪個 IdP 身分驗證端點。

如果此參數保留空白，驅動程式會預設為商業分割區。可能值為：

  • us-gov：如果您的 IdP 是在 Azure Government 中設定，請使用此值。例如，Azure AD Government 會使用端點 login.microsoftonline.us。

  • cn：如果您的 IdP 是在中國雲端分割區中設定，請使用此值。例如，Azure AD 中國使用端點 login.chinacloudapi.cn。

此為選用參數。

idp_use_https_proxy

  • 預設值 — 0

  • 資料類型 — 布林值

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

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

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

此為選用參數。

InstanceProfile

  • 預設值 — 0

  • 資料類型 — 布林值

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

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

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

此為選用參數。

issuer_url

  • 預設值 — 無

  • 資料類型 — 字串

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

只有在 plugin_name 組態選項中使用 BrowserIdcAuthPlugin 進行身分驗證時，才需要此參數。

KeepAlive

  • 預設值 — 1

  • 資料類型 — 布林值

指定驅動程式是否會使用 TCP 保持連線來防止連線逾時的布林值。

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

  • 0 | FALSE。驅動程式不會使用 TCP 保持連線。

此為選用參數。

KeepAliveCount

  • 預設值 — 0

  • 資料類型 — 整數

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

此為選用參數。

KeepAliveInterval

  • 預設值 — 0

  • 資料類型 — 整數

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

此為選用參數。

KeepAliveIdle

  • 預設值 — 0

  • 資料類型 — 整數

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

此為選用參數。

listen_port

  • 預設值 — 7890

  • 資料類型 — 整數

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

此為選用參數。

login_url

  • 預設值 — 無

  • 資料類型 — 字串

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

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

loginToRp

  • 預設值 — urn:amazon:webservices

  • 資料類型 — 字串

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

此為選用字串。

LogLevel

  • 預設值 — 0

  • 資料類型 — 整數

注意

LogLevel 和 LogPath 是全域設定。驅動程式會依下列優先順序讀取：

  1. 連線字串 (LogLevel=6;LogPath=/path;) — 最高優先順序，在連線時間覆寫所有其他設定。

  2. 在 Windows 上：DSN 設定對話方塊 （進階索引標籤）。

    在 Linux 和 macOS 上： odbc.ini 檔案中的 [ODBC]區段。

  3. amazon.redshiftodbc.ini 檔案中的 [DRIVER]區段 — 如果未從上述來源啟用記錄，則用作備用。

在個別 DSN 區段 （例如 [MyDSN]) LogPath中設定 LogLevel或 沒有效果。這些選項不會從每個 DSN 區段讀取。

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

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

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

  • 1：嚴重。保留為嚴重錯誤。

  • 2：錯誤。記錄錯誤事件，例如連線失敗和身分驗證錯誤。

  • 3：WARN。除了錯誤之外，還會記錄警告和非預期條件。

  • 4：INFO。記錄一般進度資訊，例如連線狀態和伺服器參數。

  • 5：DEBUG。記錄所有驅動程式活動，包括具有引數和傳回值的 ODBC API 函數呼叫。

  • 6：TRACE。記錄所有驅動程式活動，包括其他低階通訊協定和內部狀態詳細資訊。

重要

日誌層級 5 (DEBUG) 或更高版本會擷取所有驅動程式活動，其中可能包含敏感資訊，例如連線憑證和查詢資料。僅暫時啟用這些日誌層級以擷取問題，並確保在與支援或任何第三方共用日誌之前，所有敏感資訊都已修訂。

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

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

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

此為選用參數。

LogPath

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

  • 資料類型 — 字串

注意

LogLevel 和 LogPath 是全域設定。驅動程式會依下列優先順序讀取：

  1. 連線字串 (LogLevel=6;LogPath=/path;) — 最高優先順序，在連線時間覆寫所有其他設定。

  2. 在 Windows 上：DSN 設定對話方塊 （進階索引標籤）。

    在 Linux 和 macOS 上： odbc.ini 檔案中的 [ODBC]區段。

  3. amazon.redshiftodbc.ini 檔案中的 [DRIVER]區段 — 如果未從上述來源啟用記錄，則用作備用。

在個別 DSN 區段LogPath中設定 LogLevel或 （例如 [MyDSN]) 沒有效果。這些選項不會從每個 DSN 區段讀取。

LogLevel 大於 0 時，驅動程式用來儲存日誌檔案之資料夾的完整路徑。

此為選用參數。

LoginTimeout

  • 預設值 — 0

  • 資料類型 — 整數

在逾時之前，驅動程式等待與伺服器的連線建立的秒數。值 0 表示沒有逾時 （驅動程式無限期等待）。

您可以在連線字串 （使用 LoginTimeout或短別名 LT)、DSN 組態中設定此選項，或以程式設計方式使用 SQLSetConnectAttr搭配 SQL_ATTR_LOGIN_TIMEOUT。在 Windows 上，此選項也可以在 DSN 設定對話方塊中使用 （進階索引標籤）。

此為選用參數。

MaxLongVarcharSize

  • 預設值 – 65535

  • 資料類型 — 整數

驅動程式針對資料欄回報的資料欄大小，由 MaxVarcharSize 重新分類為大型文字 (SQL_LONGVARCHAR)。此值會取代中繼資料回應中資料欄的實際宣告大小。

建議使用預設值 65，535，因為某些中介軟體層，例如 MSDASQL，拒絕報告大小介於 8，001 和 32，768 個位元組之間的大型文字資料欄。透過報告 65，535，驅動程式可確保接受重新分類的資料欄，而不會發生錯誤。大多數使用者不需要變更此值。

當 MaxVarcharSize 設為 0（停用重新分類） 時，此參數沒有作用。

此為選用參數。它適用於驅動程式 2.1.16 版和更新版本。

MaxVarcharSize

  • 預設值 – 255

  • 資料類型 — 整數

驅動程式報告為一般文字資料欄 () 的資料欄大小上限SQL_VARCHAR。驅動程式會將大於此值的任何 CHAR和 VARCHAR資料欄重新分類為大型文字 (SQL_LONGVARCHAR 或 UseUnicode 啟用SQL_WLONGVARCHAR時）。

此重新分類可防止應用程式或中介軟體層中無法處理超過特定大小之一般文字資料欄的錯誤。例如，透過 MSDASQL (OLE 資料庫） 存取 Amazon Redshift 的 SQL Server 連結伺服器無法處理大於大約 8，000 個位元組SQL_VARCHAR的資料欄，因此將過大的資料欄重新分類為大型文字可避免轉換失敗。

  • 255 （預設）：大於 255 個字元的資料欄報告為 SQL_LONGVARCHAR。

  • 0：停用重新分類。無論大小SQL_VARCHAR為何，所有資料欄都會報告為 。

  • 自訂值：任何正整數。大於指定值的資料欄會報告為 SQL_LONGVARCHAR。

重新分類資料欄時，驅動程式會使用 MaxLongVarcharSize 中指定的值來報告其大小。

此為選用參數。它適用於驅動程式 2.1.16 版和更新版本。

Min_TLS

  • 預設值 – 1.2

  • 資料類型 — 字串

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

Min_TLS 接受以下值：

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

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

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

此為選用參數。

partner_spid

  • 預設值 — 無

  • 資料類型 — 字串

使用 PingFederate 服務驗證連線時，要使用的合作夥伴 SPID (服務提供者 ID) 值。

此為選用參數。

密碼 | PWD

  • 預設值 — 無

  • 資料類型 — 字串

與您在 [使用者] 欄位 (UID | User | 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：使用 SAML 服務 (例如 Okta 或 Ping) 的瀏覽器外掛程式進行身分驗證。

  • IdpTokenAuthPlugin：從連結至 AWS IAM Identity Center 的任何 Web 身分提供者接受 IAM Identity Center 字符或 OpenID Connect (OIDC) JSON 型身分字符 (JWT) AWS 的授權外掛程式。

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

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

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

此為選用參數。

Port | PortNumber

  • 預設值 — 5439

  • 資料類型 — 整數

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

此為選用參數。

preferred_role

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

設定檔

  • 預設值 — 無

  • 資料類型 — 字串

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

  • 如果 Use Instance Profile 參數 (InstanceProfile 屬性) 設為 1 | TRUE，則該設定會優先，而且驅動程式會改用 Amazon EC2 執行個體設定檔。

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

此為選用參數。

provider_name

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

ProxyHost

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

ProxyPort

  • 預設值 — 無

  • 資料類型 — 整數

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

此為選用參數。

ProxyPwd

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

ProxyUid

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

ReadOnly

  • 預設值 — 0

  • 資料類型 — 布林值

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

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

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

此為選用參數。

region

  • 預設值 — 無

  • 資料類型 — 字串

叢集所在的 AWS 區域。

此為選用參數。

SecretAccessKey

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

SessionToken

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

Server | HostName | Host

  • 預設值 — 無

  • 資料類型 — 字串

要連線到的端點伺服器。

此為必要參數。

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 的方式進行連線。

此為選用參數。

StreamingCursorRows

  • 預設值 — 0

  • 資料類型 — 整數

使用串流游標模式時，驅動程式每個批次擷取的資料列數。設定為正整數且游標類型為向前時，驅動程式會以指定大小的批次從伺服器讀取資料列，而不是將整個結果集載入記憶體。

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

  • 0：已停用。驅動程式會將整個結果集載入記憶體 （預設）。

  • 正整數：每個串流批次的資料列數。

串流游標模式需要僅向前游標。如果用戶端游標 (CSC) 選項已啟用，則會優先考慮並停用串流游標模式。

注意

此選項會取代 ODBC 驅動程式 1.x 版中的 UseDeclareFetch和 Fetch（快取大小） 選項。與先前的伺服器端游標方法不同，串流游標模式不需要交易包裝或多個伺服器往返。

此為選用參數。

StsConnectionTimeout

  • 預設值 — 0

  • 資料類型 — 整數

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

此為選用參數。

StsEndpointUrl

  • 預設值 — 無

  • 資料類型 — 字串

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

此為選用參數。

token

  • 預設值 — 無

  • 資料類型 — 字串

IAM Identity Center AWS 提供存取字符或與 IAM Identity Center 連結的 Web 身分提供者提供的 OpenID Connect (OIDC) JSON Web Token AWS (JWT)。您的應用程式必須透過使用 IAM Identity Center AWS 或與 IAM Identity Center 連結的身分提供者來驗證應用程式的使用者來產生此字符 AWS 。

此參數適用於 IdpTokenAuthPlugin。

token_type

  • 預設值 — 無

  • 資料類型 — 字串

IdpTokenAuthPlugin 中使用的權仗類型。

您可以指定下列值：

ACCESS_TOKEN

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

EXT_JWT

如果您使用與 AWS IAM Identity Center 整合的 Web 型身分提供者所提供的 OpenID Connect (OIDC) JSON Web Token (JWT)，請輸入此項。

此參數適用於 IdpTokenAuthPlugin。

UID | User | LogonID

  • 預設值 — 無

  • 資料類型 — 字串

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

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

UseUnicode

  • 預設值 — 0

  • 資料類型 — 布林值

布林值，指定驅動程式是將 Redshift 資料傳回為 Unicode 還是一般 SQL 類型。

  • 1 | TRUE：驅動程式會傳回字元資料類型的廣泛 SQL 類型。

    • SQL_WCHAR 會傳回，而不是 SQL_CHAR。

    • SQL_WVARCHAR 會傳回，而不是 SQL_VARCHAR。

    • SQL_WLONGVARCHAR 會傳回，而不是 SQL_LONGVARCHAR。

  • 0 | FALSE：驅動程式會傳回字元資料類型的一般 SQL 類型。

    • SQL_CHAR 會傳回，而不是 SQL_WCHAR。

    • SQL_VARCHAR 會傳回，而不是 SQL_WVARCHAR。

    • SQL_LONGVARCHAR 會傳回，而不是 SQL_WLONGVARCHAR。

此為選用參數。它適用於驅動程式 2.1.15 版和更新版本。

web_identity_token

  • 預設值 — 無

  • 資料類型 — 字串

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

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