メニュー
Amazon Redshift
管理ガイド (API Version 2012年12月1日)

ODBC ドライバー設定オプション

次の表に示す設定オプションを使用して、Amazon Redshift ODBC ドライバーの動作をコントロールできます。

Microsoft Windows では、通常、データソース名 (DSN) を設定するときにドライバーオプションを設定します。プログラムによって接続するときに、または HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\使用する DSN でレジストリキーを追加または変更することによって、接続文字列でドライバーオプションを設定することもできます。DSN の設定の詳細については、「Microsoft Windows オペレーティングシステムに Amazon Redshift ODBC ドライバーをインストールして設定する」を参照してください。接続文字列でドライバーオプションを設定する例については、「クラスターにプログラムで接続する」を参照してください。

Linux および Mac OS X では、「Linux および Mac OS X オペレーティングシステムで ODBC ドライバーを設定する」で説明されているように、odbc.ini ファイルと amazon.redshiftodbc.ini ファイルでドライバー設定オプションを設定します。amazon.redshiftodbc.ini ファイルで設定されている設定オプションは、すべての接続に適用されます。これに対して、odbc.ini ファイルで設定されている設定オプションは接続に固有です。odbc.ini で設定されている設定オプションは amazon.redshiftodbc.ini で設定されている設定オプションよりも優先されます。

ODBC オプション 一致する PostgreSQL オプションの有無 デフォルト値 説明
AccessKeyID いいえ null IAM データベース認証用に設定された IAM ロールまたは IAM ユーザーのアクセスキー ID。AccessKeyID オプションは、IAM データベース認証を設定するために使用される一連のオプションの一部です。詳細については、「IAM 認証情報を提供するための JDBC および ODBC のオプション」を参照してください。AccessKeyID および SecretAccessKey は一緒に指定する必要があります。
AutoCreate いいえ false DbUser に指定した名前でデータベースユーザーを作成するには (存在しない場合)、true を指定します。AutoCreate オプションは、IAM データベース認証を設定するために使用される一連のオプションの一部です。詳細については、「データベースユーザー認証情報を作成するための JDBC および ODBC のオプション」を参照してください。
BoolsAsChar はい 0

このオプションが有効 (1) になっていると、ドライバーはブール値を長さが 5 文字の SQL_VARCHAR データ型として公開します。

このオプションが無効 (0) になっていると、ドライバーはブール値を SQL_BIT データ型として公開します。

データベース はい 接続が確立されるときに使用するデータベースの名前。
DbGroups いいえ null データベースユーザーが現在のセッションで参加する既存のデータベースグループの名前のカンマ区切りリスト。DbGroups オプションは、IAM データベース認証を設定するために使用される一連のオプションの一部です。詳細については、「データベースユーザー認証情報を作成するための JDBC および ODBC のオプション」を参照してください。
DbUser いいえ null データベースユーザーの名前。DbUser オプションは、IAM データベース認証を設定するために使用される一連のオプションの一部です。詳細については、「データベースユーザー認証情報を作成するための JDBC および ODBC のオプション」を参照してください。
ドライバー はい Amazon Redshift ODBC ドライバーの共有オブジェクトファイルの場所。
取得 はい 100 UseDeclareFetch が有効になっているときにドライバーが返す行数。
Iam はい IAM データベース認証を使用するには、1 を指定します。詳細については、「データベースユーザー認証情報を作成するための JDBC および ODBC のオプション」を参照してください。
KeepAlive いいえ。キープアライブが TCP/IP レベルで無効になっている場合、KeepAliveTime と KeepAliveInterval は 0 に設定されます。 1

このオプションが有効 (1) になっていると、ドライバーは TCP キープアライブを使用して接続がタイムアウトしないようにします。

このオプションが無効 (0) になっていると、ドライバーは TCP キープアライブを使用しません。

KeepAliveCount いいえ 0

接続が切断されていると見なされる前に失うことが許容される TCP キープアライブパケットの数。

このオプションが 0 に設定されていると、ドライバーはこの設定の代わりに TCP/IP システムデフォルトを使用します。

KeepAliveTime はい 0

ドライバーが TCP キープアライブパケットを送信する前にアイドル状態である秒数。

このオプションが 0 に設定されていると、ドライバーはこの設定の代わりに TCP/IP システムデフォルトを使用します。

KeepAliveInterval はい 0

TCP キープアライブを再送信する間隔の秒数。

いいえ en-US エラーメッセージに使用するロケール。
MaxBytea はい 255 BYTEA 列の最大データ長 (バイト単位)。
MaxLongVarChar はい 8190 LONG VARCHAR 列の最大データ長 (UTF-8 コード単位)。
MaxVarchar はい 255 VARCHAR 列の最大データ長 (UTF-8 コード単位)。
ポート はい

Amazon Redshift サーバー上の接続先のポート。

注記

デフォルトでは、Amazon Redshift はポート 5439 を使用します。

プロフィール いいえ null JDBC 接続オプションの値を含む AWS 認証情報または設定ファイルのプロファイル名。Plugin_Name オプションは、IAM データベース認証を設定するために使用される一連のオプションの一部です。詳細については、「設定プロファイルを使用する」を参照してください。
PWD または Password はい Amazon Redshift サーバーに接続するために使用するパスワード。
SecretAccessKey いいえ null IAM データベース認証用に設定された IAM ロールまたは IAM ユーザーのシークレットアクセスキー。SecretAccessKey オプションは、IAM データベース認証を設定するために使用される一連のオプションの一部です。詳細については、「IAM 認証情報を提供するための JDBC および ODBC のオプション」を参照してください。AccessKeyID および SecretAccessKey は一緒に指定する必要があります。
Server または Servername はい Amazon Redshift サーバーの IP アドレスまたはホスト名。
SessionToken いいえ null IAM データベース認証用に設定された IAM ロールの一時セッショントークン。SessionToken は、IAM データベース認証が IAM ユーザーに対して設定されている場合は必要ありません。SessionToken オプションは、IAM データベース認証を設定するために使用される一連のオプションの一部です。詳細については、「IAM 認証情報を提供するための JDBC および ODBC のオプション」を参照してください。SessionToken を使用する場合、AccessKeyID および SecretAccessKey も指定する必要があります。
SingleRowMode いいえ 0

このオプションが有効 (1) になっていると、ドライバーはクエリの結果を一度に 1 行ずつ返します。このオプションは、大規模な結果のクエリを実行するため、結果全体をメモリに取り込みたくない場合に有効にします。

このオプションと UseDeclareFetch の両方が無効 (0) になっていると、ドライバーはクエリの結果全体をメモリに取り込みます。

注記

UseDeclareFetch が有効 (1) になっていると、それは SingleRowMode よりも優先されます。SingleRowMode が有効 (1) になっており、UseDeclareFetch が無効 (0) になっていると、SingleRowMode は UseMultipleStatements よりも優先されます。

SSLCertPath はい デフォルトのファイル名は root.crt で、デフォルトのパスはドライバーの DLL ファイルの場所です。 サーバー証明書を認証するための認証機関バンドルを含むファイルの完全パス。このオプションが設定されていない場合、ドライバーはドライバーの DLL ファイルが格納されているフォルダー内を探します。
SSLMode はい require 接続するときに使用する SSL 証明書認証モード。使用できる SSL モードの詳細については、「ODBC で SSL および信頼 CA 証明書を使用する」を参照してください。

重要

Amazon Redshift の SSL 証明書の管理方法が変わりました。1.3.7.1000 より前のバージョンの ODBC ドライバーを使用する場合は、現在の信頼ルート CA 証明書を更新して、引き続き SSL でクラスターに接続する必要があります。詳細については、「SSL 接続用 ACM 証明書への移行」を参照してください。

TextAsLongVarchar はい 0

このオプションが有効 (1) になっていると、ドライバーは LONG VARCHAR データとして TEXT 列を返します。

このオプションが無効 (0) になっていると、ドライバーは TEXT データとして TEXT 列を返します。

UID はい Amazon Redshift サーバーに接続するために使うユーザー名。
UseDeclareFetch はい 0

このオプションが有効 (1) になっていると、ドライバーは一度に特定の数の行を返します。行数を設定するには、Fetch オプションを使用します。

このオプションが無効 (0) になっており、SingleRowMode が有効 (1) になっていると、ドライバーはクエリの結果を一度に 1 行ずつ返します。SingleRowMode も無効 (0) になっていると、ドライバーはクエリの結果全体をメモリに取り込みます。

注記

UseDeclareFetch が有効になっていると、UseDeclareFetch は SingleRowMode および UseMultipleStatements よりも優先されます。

UseMultipleStatements いいえ 0

このオプションが有効 (1) になっていると、ドライバーは複数のステートメントに分割されたクエリを実行できます。

このオプションが無効 (0) になっていると、ドライバーはクエリを 1 つのステートメントとして実行します。

注記

UseDeclareFetch が有効 (1) になっていると、UseDeclareFetch は UseMultipleStatements よりも優先されます。UseDeclareFetch が無効 (0) になっており、SingleRowMode が有効 (1) になっていると、SingleRowMode は UseMultipleStatements よりも優先されます。

Username はい UID (Amazon Redshift サーバーに接続するために使用するユーザー名) と同じ情報。UID が定義されていると、UID はユーザー名よりも優先されます。
UseUnicode いいえ 0

このオプションが有効 (1) になっていると、ドライバーはデータを Unicode 文字型として返します。

  • CHAR は SQL_WCHAR として返されます。

  • VARCHAR は SQL_WVARCHAR として返されます。

  • テキストは SQL_WLONGVARCHAR として返されます。

このオプションが無効 (0) になっていると、ドライバーはデータを通常の SQL の型として返します。

  • CHAR は SQL_CHAR として返されます。

  • VARCHAR は SQL_VARCHAR として返されます。

  • TEXT は SQL_LONGVARCHAR として返されます。