このページでは、CData Cloud でのAmazon Redshift への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Amazon Redshift への接続

接続の確立 は、CData Cloud にデータベースを作成するためのAmazon Redshift への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してAmazon Redshift からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Amazon Redshift に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Amazon Redshift への接続

Amazon Redshift に接続するには、通常次の接続プロパティが必要です。

• Server：Amazon Redshift データベースをホスティングしているサーバーのホスト名またはIP アドレス。
• Database：Amazon Redshift クラスター用に作成したデータベース。
• Port（オプション）：Amazon Redshift データベースをホスティングしているサーバーのポート。デフォルトは5439です。

以下の手順に従って、これらの値をAWS マネージメントコンソールで取得できます。

1. Amazon Redshift コンソールを開きます（http://console.aws.amazon.com/redshift）。
2. Clusters ページで、クラスターの名前をクリックします。
3. Configuration タブで"Cluster Database Properties" セクションからプロパティを取得します。接続プロパティの値は、ODBC URL で設定された値と同じになります。

Cloud は、SSL 暗号化を使用してAmazon Redshift サーバーとのセキュアな通信を提供します。オプションで、UseSSL をfalse に設定して、SSL 暗号化をオフにすることができます。

SSL 認証を活用してAmazon Redshift データに接続することもできます。そのためには、次の接続プロパティを設定してください。

• SSLClientCert：クライアント証明書のための証明書ストア名に設定。クライアントとサーバーの両方のマシンでトラストストアとキーストアが保持される2-way SSL の場合に使用されます。
• SSLClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
• SSLClientCertType：クライアントストアの証明書タイプ。
• SSLServerCert：サーバーが受け入れ可能な証明書。

次の例では、通常のユーザー名とパスワードのペア、および非アクティブなSSL 暗号化を使用してAmazon Redshift に接続します。

User=username;Password=password;Server=example.us-west-2.redshift.amazonaws.com;Database=your_database;UseSSL=false;"

Amazon Redshift への認証

Azure Active Directory

前提条件

• B2C 以外のAzure テナントのみがAzure AD 認証スキームを完了できます。
• 有効なAzure AD アカウントが必要です。有効なアカウントがない場合は、このプロセスを始める前にアカウントを作成してください。

認証

Azure AD の認証を行うには、以下のタスクを完了する必要があります。

1. OAuth アプリケーションの作成と登録
2. Redshift Client Application の作成と設定
3. 新しいId プロバイダーを定義
4. 接続プロパティを指定

以下のセクションでは、これらのタスクについて詳しく説明します。

OAuth アプリケーションの作成と登録

以下の手順で、Azure 経由でAmazon Redshift データベースにログインするためのOAuth アプリを作成します。

1. Azure Active Directory 概要 ページにある左のナビゲーションバーで、アプリの登録を選択します。
2. アプリの登録ページ上部の新規登録をクリックします。
3. アプリの登録ページで、必要事項を入力し、ページ下部の登録をクリックします。CallbackURL プロパティ値を保存します。
4. アプリケーションを作成すると、アプリの概要ページが表示されます。左のナビゲーションバーで：
   1. 証明書とシークレットをクリックします。
   2. 新しいクライアントシークレットをクリックします。
   3. クライアントシークレットの追加ウィンドウで、必要事項を追加してウィンドウ下部の追加をクリックします。
   4. OAuthClientSecret を控えておきます（表示されるOAuth シークレットの値フィールド）。

5. 新規に登録したアプリケーションで、左のナビゲーションバーにあるAPI の公開をクリックします。
6. App ID URI の横の設定をクリックします。
7. 登録時に入力した情報を含むSet the App ID URI ダイアログが表示されます。保存をクリックします。
8. Add a scope をクリックします。
9. 必要事項を入力し、フォーム下部のスコープの追加をクリックします。

Redshift Client Application の作成と設定

以下の手順に従って、もう1つアプリケーションを作成します。このアプリは、Amazon Redshift データベースのクライアントアプリケーションとして機能します。

1. Azure Active Directory 管理ページに移動して、アプリの登録をクリックします。
2. ページ上部の新規登録をクリックします。
3. アプリケーションの登録ページで、必要事項を入力し、ページ下部の登録をクリックします。
4. アプリを作成すると、アプリの概要ページが表示されます。左のナビゲーションバーで：
   1. 証明書とシークレットをクリックします。
   2. 新しいクライアントシークレットをクリックします。
   3. クライアントシークレットの追加ウィンドウで、必要事項を追加してウィンドウ下部の追加をクリックします。
   4. OAuthClientSecret を控えておきます（表示されるOAuth シークレットの値フィールド）。

5. クライアントアプリの管理ページの左のナビゲーションバーで：
   1. API のアクセス許可をクリックします。
   2. アクセス許可の追加をクリックします。
   3. Microsoft Graph API を選択します。
   4. アプリケーションの許可をクリックします。
   5. Directory -> "Directory.Read.All" を選択します。
   6. 下部の追加をクリックします。
   7. 管理者の同意を与えますをクリックします。
   8. はいをクリックします。

6. Azure Active Directory の左のナビゲーションバーで：
   1. グループをクリックします。
   2. グループページで、新しいグループをクリックして必要事項を入力します。
   3. 所有者が選択されていませんをクリックします。
   4. 所有者を追加ウィンドウが表示されます。ユーザーを選択します。
   5. 作成をクリックします。

新しいId プロバイダーを定義

次の手順で、新しいId プロバイダーを定義します。

1. Azure Active Directory 概要 ページで、
   1. 左のナビゲーションペインからアプリの登録を選択します。
   2. すべてのアプリケーションタブを選択し、最初のOAuth アプリケーションを選択します。

2. OAuth ページで、左のナビゲーションバーにあるマニフェストをクリックします。エディターでaccessTokenAcceptedVersion を検索します。値がNULL の場合、v1.0 トークンです。値が2の場合はv2.0 トークンです。
3. Amazon Redshift インスタンスのクエリボックスから、以下の例に従ってId プロバイダのクエリを送信します。
   

       CREATE IDENTITY PROVIDER oauth_standard TYPE azure
       NAMESPACE 'mynamespace'
       PARAMETERS '{
       "issuer":"https://sts.windows.net/your_tenant_here/",
       "client_id":"YourClientId",
       "client_secret":"YourClientSecret",
       "audience":["your_application_id_uri_here"]
       }' 

   用語説明

   • issuer ID： トークンを受け取る際に信頼する発行者ID。発行者には、tenant_id の一意な識別子が付加されます。v1.0 トークンを使用する場合、https://sts.windows.net/<your_tenant_id_here>/ を使用します。V2.0 トークンを使用する場合、https://login.microsoftonline.com/<your_tenant_id_here>/v2.0 を使用します。
   • client_id： Id プロバイダーに登録されたアプリケーションの一意の公開識別子。これをアプリケーションID と呼びます。2つ目のアプリケーション（Amazon Redshift クライアントアプリケーション）用に生成されたクライアントID です。
   • client_secret： ID プロバイダーおよび登録されたアプリケーションにのみ知られている秘密の識別子、またはパスワード。2つ目のアプリケーション（Amazon Redshift アプリケーション）用に生成されたクライアントシークレットです。
   • audience： 1つ目のアプリケーション（OAuth アプリケーション）に割り当てられたアプリケーションID（URI）。

   NAMESPACE には好きな名前を使用できます。

4. Amazon Redshift で、CREATE IDENTITY PROVIDER クエリ（例として上記）をクエリテキストボックスに配置します。
5. クエリボックスの下部にあるRun をクリックします。
6. クエリテキストボックスで、以下の形式でRedshift データベース上にロールを作成します。
   

   create role "mynamespace:myazuregroup";

   CREATE IDENTITY PROVIDER クエリで提供されたID プロバイダーの名前空間と、先に作成したAzure グループの名前に置き換えてください。クエリボックスの下部にあるRun をクリックします。
7. クエリテキストボックスで、この新しいロールに以下のようにテーブルアクセス権を付与します。
   

   grant select on all tables in schema public to role "mynamespace:myazuregroup";

8. 上記の例を、自分の名前空間とAzure グループ名に置き換えてください。
9. クエリボックスの下部にあるRun をクリックします。

接続プロパティを設定します。

次の接続プロパティを指定します。

• AuthScheme：AzureAD に設定。
• Server：Amazon Redshift サーバーエンドポイントの名前に設定。
• Database：接続するAmazon Redshift データベースの名前に設定。
• User：認証するAmazon Redshift ユーザーの名前に設定します。
• AzureTenant：OAuth およびクライアントアプリが作成されたAzure テナントのID に設定。アプリの1つの概要ページにあるディレクトリ（テナント）ID を確認してください。
• SSOLoginURL：OAuth アプリの概要ページで確認できるアプリケーションID のURI の値に設定。
• Scope：v1.0 OAuth トークンの場合、OAuth アプリのAPI の公開ページにあるスコープフィールド名に設定。v2.0 OAuth トークンの場合は、OAuth アプリのクライアントID と同じです。
• OAuthClientId：作成したAmazon Redshift クライアントアプリケーションの概要ページにある、1つ目のOAuth アプリケーションのクライアントID に設定。
• OAuthClientSecret：クライアントアプリケーションの証明書とシークレットページにある、1つ目のOAuth アプリケーションのOAuth クライアントシークレットの値に設定。
• CallbackURL：OAuth アプリのコールバックURL に設定。

トラブルシューティング： "Azure JWT token does not have 'upn' field" エラーが発生した場合、以下の手順に従います。

1. Azure Active Directory の管理ページで、アプリの登録に移動し、自身のOAuth アプリケーションを選択します。
2. 左のナビゲーションバーでトークン構成をクリックします。
3. Add optional claim をクリックします。
4. Add optional claim 画面で、Token type の下のAccess をクリックします。
5. Claim カラムの下のupn を選択します。
6. 下部の追加をクリックします。
7. Turn on the Microsoft Graph profile permission (required for claims to appear in the token) を選択します。
8. 追加をクリックします。
9. このプロセスをクライアントアプリでも繰り返します。
10. 再度接続を試みてください。

Azure Active Directory PKCE

Azure AD PKCE で認証するには、以下のタスクを完了する必要があります。

1. OAuth アプリケーションの作成と登録
2. Redshift Client Application の作成と設定
3. 新しいId プロバイダーを定義
4. 接続プロパティを指定

以下のセクションでは、これらのタスクについて詳しく説明します。

OAuth アプリケーションの作成と登録

以下の手順で、Azure 経由でAmazon Redshift データベースにログインするためのOAuth アプリケーションを作成します。

1. Azure Active Directory 概要 ページにある左のナビゲーションバーで、アプリの登録をクリックします。
2. アプリの登録ページ上部の新規登録をクリックします。
3. アプリケーションの登録ページで、必要事項を入力します。
   1. Name に名前を入力します（例："oauth_application"）。
   2. Redirect URI にPublic client/native (mobile and desktop) を選択し、有効なURL（例：http://localhost:33333/）を入力します。

4. ページ下部の登録をクリックします。CallbackURL プロパティ値を保存します。
5. 新規に登録したアプリケーションで、左のナビゲーションバーにあるAPI の公開をクリックします。
6. アプリケーションID URI の横の設定をクリックします。
7. 登録時に入力した情報を含むSet the App ID URI ダイアログが表示されます。保存をクリックします。
8. スコープの追加をクリックします。
9. 必要事項を入力し、フォーム下部のスコープの追加をクリックします。
10. 生成されたApplication ID URI およびAPI scope を保存します（例：api://6256f0b1-2284-43e4-8501-6e53dec4444f およびapi://6256f0b1-2284-43e4-8501-6e53dec4444f/jdbc_login）。

Redshift Client Application の作成と設定

以下の手順に従って、もう1つアプリケーションを作成します。このアプリは、Amazon Redshift データベースのクライアントアプリケーションとして機能します。

1. Azure Active Directory 概要 ページで、左のナビゲーションバーからアプリの登録を選択します。
2. アプリの登録ページ上部の新規登録をクリックします。
3. アプリケーションの登録ページで、必要事項を入力し、ページ下部の登録をクリックします。
4. アプリケーションを作成すると、アプリの概要ページが表示されます。左のナビゲーションバーで：
   1. 証明書とシークレットをクリックします。
   2. 新しいクライアントシークレットをクリックします。
   3. クライアントシークレットの追加ウィンドウで、必要事項を追加してウィンドウ下部の追加をクリックします。
   4. OAuthClientSecret を控えておきます（表示されるOAuth シークレットの値フィールド）。

5. クライアントアプリの管理ページの左のナビゲーションバーで：
   1. API のアクセス許可をクリックします。
   2. アクセス許可の追加をクリックします。
   3. Microsoft Graph API を選択します。
   4. アプリケーションの許可をクリックします。
   5. Directory -> "Directory.Read.All" を選択します。
   6. 下部の追加をクリックします。
   7. 管理者の同意を与えますをクリックします。
   8. はいをクリックします。

6. Azure Active Directory の左のナビゲーションバーで：
   1. グループをクリックします。
   2. グループページで、新しいグループをクリックして必要事項を入力します。
   3. 所有者が選択されていませんをクリックします。
   4. 所有者を追加ウィンドウが表示されます。ユーザーを選択します。
   5. 作成をクリックします。

新しいId プロバイダーを定義

次の手順で、新しいId プロバイダーを定義します。

1. Azure Active Directory の左のナビゲーションバーでアプリの登録をクリックします。
2. すべてのアプリケーションタブを選択し、最初のOAuth アプリケーションを選択します。
3. OAuth 画面で、左のナビゲーションバーにあるマニフェストをクリックします。エディターでaccessTokenAcceptedVersion を探します。値がNULL または1の場合、v1.0 トークンです。値が2の場合はv2.0 トークンです。
4. Amazon Redshift インスタンスのクエリボックスから、以下の例に従ってId プロバイダのクエリを送信します。
   

       CREATE IDENTITY PROVIDER oauth_standard TYPE azure
       NAMESPACE 'mynamespace'
       PARAMETERS '{
       "issuer":"https://sts.windows.net/your_tenant_here/",
       "client_id":"YourRedshiftApplicationClientId",
       "client_secret":"YourRedshiftApplicationClientSecret"
       ,"audience":["your_oauth_application_id_uri_here"]
       }'

   v2.0 トークン発行者の場合、この値が必要です。
   

       "issuer":"https://login.microsoftonline.com/your_tenant_here/v2.0",

5. 用語説明
   1. issuer ID：トークンを受け取る際に信頼する発行者ID。発行者には、tenant_id の一意な識別子が付加されます。v1.0 トークンを使用する場合、https://sts.windows.net<your_tenant_id_here> を指定します。v2.0 トークンを使用する場合、https://login.microsoftonline.com<your_tenant_id_here>/v2.0. を指定します。
   2. client_id：Id プロバイダーに登録されたアプリケーションの一意の公開識別子。これをアプリケーションID と呼びます。2つ目のアプリケーション（Amazon Redshift アプリケーション）用に生成されたクライアントID です。
   3. client_secret：ID プロバイダーおよび登録されたアプリケーションにのみ知られている秘密の識別子、またはパスワード。2つ目のアプリケーション（Amazon Redshift アプリケーション）用に生成されたクライアントシークレットです。
   4. audience：1つ目のアプリケーション（OAuth アプリケーション）に割り当てられたアプリケーションID（URI）。
   5. NAMESPACE には好きな名前を使用できます。

6. Amazon Redshift で、CREATE IDENTITY PROVIDER クエリ（例として上記）をクエリテキストボックスに配置します。
7. クエリボックスの下部にあるRun をクリックします。
8. クエリテキストボックスで、以下の形式でRedshift データベース上にロールを作成します。
   

   create role "mynamespace:myazuregroup";

9. CREATE IDENTITY PROVIDER クエリで提供されたID プロバイダーの名前空間と、先に作成したAzure グループの名前に置き換えてください。
10. クエリボックスの下部にあるRun をクリックします。
11. クエリテキストボックスで、この新しいロールに以下のようにテーブルアクセス権を付与します。
    

    grant select on all tables in schema public to role "mynamespace:myazuregroup";

12. 上記の例を、自分の名前空間とAzure グループ名に置き換えてください。
13. クエリボックスの下部にあるRun をクリックします。

接続プロパティを設定します。

上記の設定を終えたら、Amazon Redshift に接続するドライバーに以下のプロパティを指定します。

• AuthScheme：AzureADPKCE に設定。
• Server：Amazon Redshift サーバーエンドポイントの名前に設定。
• Database：接続するAmazon Redshift データベースの名前に設定。
• Scope：v1.0 OAuth トークンの場合、OAuth アプリケーションのAPI の公開ページにあるスコープフィールドに設定（例：api://d3cb3521-6c20-4e41-b16d-e48c8444ee11/jdbc_login）。v2.0 OAuth トークンの場合は、OAuth アプリケーションのクライアントID と同じです（例：d3cb3521-6c20-4e41-b16d-e48c8444ee11）。
• OAuthClientId：作成したOAuth アプリケーションの概要ページにある、アプリケーション（クライアント）ID に設定。
• CallbackURL：OAuth アプリのコールバックURL に設定。

トラブルシューティング

"Azure JWT token does not have 'upn' field" エラーが発生した場合、以下の手順に従います。

1. Azure Active Directory 管理ページで、アプリの登録に移動し、自身のOAuth アプリケーションを選択します。
2. 左のナビゲーションバーでトークン構成 -> Add Optional claim を選択します。
3. Add optional claim 画面で、"Token type" の下のAccess をクリックします。
4. Claim カラムの下のupn を選択します。
5. 下部の追加をクリックします。
6. トークンにクレームが表示されるために必要な、Turn on the Microsoft Graph profile permission を選択します。
7. 追加をクリックします。
8. このプロセスをクライアントアプリでも繰り返します。
9. 再度接続を試みてください。

標準認証

Amazon Redshift にログイン資格情報で接続するには、AuthScheme をBasic に設定します。 加えて、以下の接続プロパティを設定します。

• User：Amazon Redshift サーバーに認証する際に使われるユーザー。
• Password：Amazon Redshift サーバーに認証する際に使われるパスワード。

次は接続文字列の例です。

AuthScheme=Basic;User=user;Password=password;Server=example.us-west-2.redshift.amazonaws.com;Database=your_database;

IAM credentials

AuthScheme をIAMCredentials に設定します。次は接続文字列の例です。

AuthScheme=IAMCredentials;Server=example.us-west-2.redshift.amazonaws.com;Database=your_database;User=your_user;AWSAccessKey=your_access_key;AWSSecretKey=your_secretkey;

一時的な資格情報を使用してIAM ロールで接続している場合は、AWSSessionToken も適用する必要があります。

オプションで以下を適用できます。

• AutoCreate：接続中にデータベースユーザーが存在しない場合は、User に指定した名前でデータベースユーザーを作成します。
• DbGroups：データベースユーザーが現在のセッションに参加するデータベースグループ。

ADFS

ADFS に接続するには、AuthScheme をADFS に設定し、次のプロパティを設定します。

• User：ADFS ユーザー。
• Password：ADFS ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。

接続文字列の例：

AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';

ADFS 統合

ADFS 統合フローでは、現在ログインしているWindows ユーザーの資格情報で接続します。 ADFS 統合フローを使用するには、User およびPassword を指定せず、それ以外の設定は上記のADFS ガイドと同じ手順を実行してください。

PingFederate に接続するには、AuthScheme をPingFederate に設定し、次のプロパティを設定します。

• User：PingFederate ユーザー。
• Password：PingFederate ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。
• AWSRoleARN（オプション）：複数のロールARN がある場合は、認可に使用するARN を指定します。
• AWSPrincipalARN（オプション）：複数のプリンシパルARN がある場合は、認可に使用するARN を指定します。
• SSOProperties（オプション）：Amazon S3へのリクエストにユーザー名とパスワードを認可ヘッダーとして含める場合は、Authscheme=Basic。

SSOLoginURL 用の相互SSL 認証（WS-Trust STS エンドポイント）を有効化するには、次の SSOProperties を設定します。

• SSLClientCert
• SSLClientCertType
• SSLClientCertSubject
• SSLClientCertPassword

接続文字列の例：

Server=redshift-cluster-1.xxxxxxxxxxxx.us-east-1.redshift.amazonaws.com;Database=dev;Port=5439;UseSSL=true;SSLServerCert=*;AuthScheme=PingFederate;AutoCreate=TRUE;SSOLoginURL=https://mycustomserver.com:9033/idp/sts.wst;SSOExchangeUrl=https://us-east-1.signin.aws.amazon.com/platform/saml/acs/764ef411-xxxxxx;User=admin;Password=PassValue;AWSRegion=NORTHERNVIRGINIA;

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

クライアントSSL 証明書

Amazon Redshift Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データ型のマッピング

Cloud は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

Amazon Redshift	CData スキーマ
abstime	string
aclitem	string
bigint	long
bigserial	long
bit varying	string
bit	string
boolean	bool
box	string
bytea	binary
char	string
character varying	string
character	string
cid	string
cidr	string
circle	string
date	date
daterange	string
double precision	float
gtsvector	string
inet	string
int2vector	string
int4range	string
int8range	string
integer	int
json	string
jsonb	binary
line	string
lseg	string
macaddr8	string
macaddr	string
money	decimal
name	string
numeric	decimal
numrange	string
oid	string
oidvector	string
path	string
pg_dependencies	string
pg_lsn	string
pg_ndistinct	string
pg_node_tree	string
point	string
polygon	string
real	float
refcursor	string
regclass	string
regconfig	string
regdictionary	string
regnamespace	string
regoper	string
regoperator	string
regproc	string
regprocedure	string
regrole	string
regtype	string
reltime	string
serial	int
smallint	int
smallserial	int
smgr	string
text	string
tid	string
time with time zone	string
time without time zone	time
timestamp with time zone	datetime
timestamp without time zone	datetime
tinterval	string
tsquery	string
tsrange	string
tstzrange	string
tsvector	string
txid_snapshot	string
uuid	string
xid	string
xml	string

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication

---

プロパティ	説明
AuthScheme	Amazon Redshift に接続する際に使用する認証の種類。
Server	Amazon Redshift クラスターのホスト名またはIP アドレス。
Port	Amazon Redshift サーバーのポート番号。
Database	Amazon Redshift データベース名。
User	認証で使用されるAmazon Redshift ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。
UseSSL	このフィールドはSSL が有効化されているかどうかを設定します。
Visibility	Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for current user. For example 'SELECT,INSERT' filter is restricting metatdata visibility only for those tables which may be accessed by current user for SELECT and INSERT operations. Supported privilege values are SELECT, INSERT, UPDATE, DELETE, REFERENCES.

AWS Authentication

---

プロパティ	説明
AWSAccessKey	Your AWS account access key or the access key for an authorized IAM user.
AWSSecretKey	Your AWS account secret key or the secret key for an authorized IAM user.
AutoCreate	Specify true to create a database user with the name specified for User if one does not exist while connecting with IAM credentials. See AuthScheme .
DbGroups	A comma-delimited list of the names of one or more existing database groups the database user joins for the current session when connecting with IAM credentials. See AuthScheme .
AWSRoleARN	認証時に使用するロールのAmazon リソースネーム。
AWSPrincipalARN	AWS アカウントのSAML ID プロバイダーのARN。
AWSRegion	Amazon Web サービスのホスティングリージョン。
AWSSessionToken	AWS のセッショントークン。

Azure Authentication

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

SSO

---

プロパティ	説明
SSOLoginURL	ID プロバイダーのログインURL。
SSOProperties	セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。
SSOExchangeUrl	SAML 応答を処理してサービスの資格情報と交換するために使用するURL。

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
Scope	初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSH

---

プロパティ	説明
SSHAuthMode	サービスへのSSH トンネルを確立する際に使用される認証方法。
SSHClientCert	SSHUser の認証に使用する証明書。
SSHClientCertPassword	SSHClientCert キーのパスワード（ある場合）。
SSHClientCertSubject	SSH クライアント証明書のサブジェクト。
SSHClientCertType	SSHClientCert 秘密鍵の種類。
SSHServer	SSH サーバー。
SSHPort	SSH ポート。
SSHUser	SSH ユーザー。
SSHPassword	SSH パスワード。
SSHServerFingerprint	SSH サーバーのフィンガープリント。
UseSSH	Amazon Redshift 接続をSSH 経由でトンネリングするかどうか。 SSH を使用します。

Logging

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

Schema

---

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
IgnoredSchemas	メタデータクエリによってスキーマのリストを非表示にするために使用される可視性制限フィルタ。例えば、'information_schema, pg_catalog' です。スキーマ名は、大文字・小文字が区別されます。

Miscellaneous

---

プロパティ	説明
AllowPreparedStatement	クエリステートメントを実行前に準備します。
COPYConversionParameters	Specifies the coma separated list of parameter to use in the COPY command when InsertMode is S3Staging or S3StagingWithIAM. Supported parameters are: BLANKSASNULL DELIMITER EMPTYASNULL EXPLICIT_IDS NULL AS TRIMBLANKS TRUNCATECOLUMNS
FetchResultSetMetadata	This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server.
InsertMode	Specifies what method to use when inserting bulk data. By default DML mode is used.
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
RedshiftToS3RoleARN	The Amazon Resource Name of the role to use when authenticating S3 with IAM role by the COPY command for the bulk inserts.
S3Bucket	Specifies the name of AWS S3 bucket to upload bulk data for staging.
S3BucketFolder	Specifies the name of the folder in AWS S3 bucket to upload bulk data for staging. By default bulk data are staged in the root folder.
StripOutNulls	When set the null characters are stripped out from character values in bulk operations.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TimeZone	現在のセッションのタイムゾーンを設定します。
UseUIDForStaging	Use this property in combination with InsertMode assigned with S3Staging or S3StagingWithIAM. By default the the driver creates staging files with names that prepend the targeted table's name, so the files are overwritten between sessions. When the property is set to True , the provider additionally attaches temporary unique identifiers to these names. It may be required if you use parallel jobs to insert rows into the same table. Thus, the staging files are not overwritten by the jobs. A caveat is that using this property adds to the number of staging files put onto S3 bucket, since the file names are not controlled by the driver between different sessions. In this case you may want to define an AWS S3 policy on the bucket to remove staging files that were stored in a bucket automatically.

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
AuthScheme	Amazon Redshift に接続する際に使用する認証の種類。
Server	Amazon Redshift クラスターのホスト名またはIP アドレス。
Port	Amazon Redshift サーバーのポート番号。
Database	Amazon Redshift データベース名。
User	認証で使用されるAmazon Redshift ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。
UseSSL	このフィールドはSSL が有効化されているかどうかを設定します。
Visibility	Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for current user. For example 'SELECT,INSERT' filter is restricting metatdata visibility only for those tables which may be accessed by current user for SELECT and INSERT operations. Supported privilege values are SELECT, INSERT, UPDATE, DELETE, REFERENCES.

Amazon Redshift に接続する際に使用する認証の種類。

Possible Values

AzureAD, Basic, ADFS, IAMCredentials, PingFederate

データ型

string

デフォルト値

"Auto"

解説

• Auto：設定された他の接続プロパティに基づいてドライバーが自動的に決定。
• Basic：BASIC ユーザー / パスワード認証を使用する場合に設定。
• ADFS：Active Directory Federated Services 認証を実行する場合に設定。
• PingFederate：認証を実行するためにPingFederate SSO ID プロバイダーを使用する場合に設定。
• IAMCredentials：Redshift のGetClusterCredentials API で認証を実行する場合に設定。
• AzureAD：Azure Active Directory OAuth 認証を使用する場合に設定。
• AzureADPKCE：Microsoft Azure AD でネイティブIdP フェデレーションを使用する場合に設定。

Amazon Redshift クラスターのホスト名またはIP アドレス。

データ型

string

デフォルト値

""

解説

Amazon Redshift クラスターDatabase のホスト名またはIP。この値はAWS マネージメントコンソールから取得できます。

1. Amazon Redshift コンソールを開きます。(http://console.aws.amazon.com/redshift)
2. ［Clusters］ページで、クラスターの名前をクリックします。
3. クラスターの［Configuration］タブで、表示されている接続文字列からクラスターURL をコピーします。

Amazon Redshift サーバーのポート番号。

データ型

string

デフォルト値

"5439"

解説

Amazon Redshift Database をホスティングしているServer サーバーのポート番号。指定されない場合は、デフォルトのポート番号5439 が使われます。

Amazon Redshift データベース名。

データ型

string

デフォルト値

""

解説

Amazon Redshift Server に接続する場合のデータベース。データベースが提供されていない場合は、ユーザーのデフォルトデータベースが使用されます。

認証で使用されるAmazon Redshift ユーザーアカウント。

データ型

string

デフォルト値

""

解説

このフィールドは、Password とともに、Amazon Redshift サーバーに対して認証をするために使われます。

ユーザーの認証で使用されるパスワード。

データ型

string

デフォルト値

""

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

このフィールドはSSL が有効化されているかどうかを設定します。

データ型

bool

デフォルト値

true

解説

このフィールドは、Cloud がサーバーとのTLS/SSL 接続をネゴシエートするかどうかを設定します。デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合します。別の証明書を指定するには、SSLServerCert を設定します。

Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for current user. For example 'SELECT,INSERT' filter is restricting metatdata visibility only for those tables which may be accessed by current user for SELECT and INSERT operations. Supported privilege values are SELECT, INSERT, UPDATE, DELETE, REFERENCES.

データ型

string

デフォルト値

""

解説

By default visibility filtering is not applied. Filtering values are case insensitive.

このセクションでは、本プロバイダーの接続文字列で設定可能なAWS Authentication プロパティの全リストを提供します。

---

プロパティ	説明
AWSAccessKey	Your AWS account access key or the access key for an authorized IAM user.
AWSSecretKey	Your AWS account secret key or the secret key for an authorized IAM user.
AutoCreate	Specify true to create a database user with the name specified for User if one does not exist while connecting with IAM credentials. See AuthScheme .
DbGroups	A comma-delimited list of the names of one or more existing database groups the database user joins for the current session when connecting with IAM credentials. See AuthScheme .
AWSRoleARN	認証時に使用するロールのAmazon リソースネーム。
AWSPrincipalARN	AWS アカウントのSAML ID プロバイダーのARN。
AWSRegion	Amazon Web サービスのホスティングリージョン。
AWSSessionToken	AWS のセッショントークン。

Your AWS account access key or the access key for an authorized IAM user.

データ型

string

デフォルト値

""

解説

To authorize Amazon Redshift requests, provide the credentials for an administrator account or for an IAM user with custom permissions. Set this property along with AWSSecretKey.

Note: Though you can connect as the AWS account administrator, it is recommended to use IAM user credentials to access AWS services.

Obtaining the Access Key

To obtain the credentials for an IAM user, follow the steps below:

1. Sign into the IAM console.
2. In the navigation pane, select Users.
3. To create or manage the access keys for a user, select the user and then select the Security Credentials tab.

To obtain the credentials for your AWS root account, follow the steps below:

1. Sign into the AWS Management console with the credentials for your root account.
2. Select your account name or number and select My Security Credentials in the menu that is displayed.
3. Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.

Your AWS account secret key or the secret key for an authorized IAM user.

データ型

string

デフォルト値

""

解説

Your AWS account secret key or the secret key for an authorized IAM user. See AWSAccessKey to obtain the secret key and access key.

Specify true to create a database user with the name specified for User if one does not exist while connecting with IAM credentials. See AuthScheme .

データ型

bool

デフォルト値

false

解説

The default is false.

A comma-delimited list of the names of one or more existing database groups the database user joins for the current session when connecting with IAM credentials. See AuthScheme .

データ型

string

デフォルト値

""

解説

The group names must match the dbgroup resources ARNs specified in the IAM policy attached to the IAM user or role.

By default, the new user is added only to PUBLIC.

認証時に使用するロールのAmazon リソースネーム。

データ型

string

デフォルト値

""

解説

AWS の外部で認証する場合は、AWS アカウント認証情報ではなく、ロールを認証に使用するのが 一般的です。AWSRoleARN を入力すると、CData Cloud はAWSAccessKey とAWSSecretKey を直接 使用する代わりに、ロールベースの認証を実行します。この認証を実行するためには、AWSAccessKey と AWSSecretKey を指定する必要があります。RoleARN を設定するときは、AWS ルートユーザーの 認証情報を使用できません。AWSAccessKey およびAWSSecretKey はIAM ユーザーのものである必要があります。

AWS アカウントのSAML ID プロバイダーのARN。

データ型

string

デフォルト値

""

解説

AWS アカウントのSAML ID プロバイダーのARN。

Amazon Web サービスのホスティングリージョン。

Possible Values

OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, JAKARTA, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, STOCKHOLM, ZURICH, BAHRAIN, UAE, SAOPAULO, GOVCLOUDEAST, GOVCLOUDWEST

データ型

string

デフォルト値

"NORTHERNVIRGINIA"

解説

Amazon Web サービスのホスティングリージョン。利用可能な値はOHIO、NORTHERNVIRGINIA、NORTHERNCALIFORNIA、OREGON、CAPETOWN、HONGKONG、JAKARTA、MUMBAI、OSAKA、SEOUL、SINGAPORE、SYDNEY、TOKYO、CENTRAL、BEIJING、NINGXIA、FRANKFURT、IRELAND、LONDON、MILAN、PARIS、STOCKHOLM、ZURICH、BAHRAIN、UAE、SAOPAULO、GOVCLOUDEAST、GOVCLOUDWEST です。

AWS のセッショントークン。

データ型

string

デフォルト値

""

解説

AWS のセッショントークン。この値はさまざまな方法で取得できます。詳しくは、this link を参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

データ型

string

デフォルト値

""

解説

データにアクセスするために使用されるMicrosoft Online テナント。例えば、contoso.onmicrosoft.com です。あるいは、 テナントId を指定します。この値は［Azure ポータル］->［Azure Active Directory］->［プロパティ］のディレクトリId です。

通常、Tenant を指定する必要はありません。OAuthGrantType をCODE（デフォルト）に設定している場合は、Microsoft が自動的に決定します。 ただし、ユーザーがマルチテナントに所属している場合は失敗する可能性があります。 例えば、ドメインA の管理者がドメインB のユーザーをゲストユーザーとして招待した場合。ユーザーは両方のテナントに属していることになります。 Tenant を指定するのはグッドプラクティスですが、一般的には指定しなくてもうまく動作するはずです。

OAuthGrantType をCLIENT に設定する場合は、AzureTenant が必須です。クライアント資格情報を使用する場合、ユーザーコンテキストはありません。 資格情報は、アプリ自体のコンテキストから取得されます。Microsoft ではTenant を指定せずにクライアント資格情報を取得することを許容していますが、使用する特定のテナントを選択する可能性ははるかに低くなっています。 このため、接続するドメインに適用される資格情報を確実に取得するために、すべてのクライアント資格情報接続に対してAzureTenant を明示的に指定する必要があります。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSO プロパティの全リストを提供します。

---

プロパティ	説明
SSOLoginURL	ID プロバイダーのログインURL。
SSOProperties	セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。
SSOExchangeUrl	SAML 応答を処理してサービスの資格情報と交換するために使用するURL。

ID プロバイダーのログインURL。

データ型

string

デフォルト値

""

解説

ID プロバイダーのログインURL。

セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。

データ型

string

デフォルト値

""

解説

セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。SSOLoginURL と一緒に使われます。

SSO 設定については、 で詳しく説明します。

SAML 応答を処理してサービスの資格情報と交換するために使用するURL。

データ型

string

デフォルト値

""

解説

CData Cloud はここで指定されたURL を使用してSAML 応答を処理し、サービスの資格情報と交換します。 取得した資格情報はSSO 接続時の最後の情報であり、Amazon Redshift との通信に使用されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
Scope	初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

データ型

string

デフォルト値

""

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

データ型

string

デフォルト値

""

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。

データ型

string

デフォルト値

""

解説

初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSH プロパティの全リストを提供します。

---

プロパティ	説明
SSHAuthMode	サービスへのSSH トンネルを確立する際に使用される認証方法。
SSHClientCert	SSHUser の認証に使用する証明書。
SSHClientCertPassword	SSHClientCert キーのパスワード（ある場合）。
SSHClientCertSubject	SSH クライアント証明書のサブジェクト。
SSHClientCertType	SSHClientCert 秘密鍵の種類。
SSHServer	SSH サーバー。
SSHPort	SSH ポート。
SSHUser	SSH ユーザー。
SSHPassword	SSH パスワード。
SSHServerFingerprint	SSH サーバーのフィンガープリント。
UseSSH	Amazon Redshift 接続をSSH 経由でトンネリングするかどうか。 SSH を使用します。

サービスへのSSH トンネルを確立する際に使用される認証方法。

Possible Values

None, Password, Public_Key

データ型

string

デフォルト値

"Password"

解説

• None：認証は行われません。現在のUser の値は無視され、接続は匿名でログインされます。
• Password：Cloud は、User とPassword の値を使用してユーザーを認証します。
• Public_Key：Cloud は、User とSSHClientCert の値を使用してユーザーを認証します。SSHClientCert には、この認証方法を成功させるために使用可能な秘密鍵が必要です。

SSHUser の認証に使用する証明書。

データ型

string

デフォルト値

""

解説

公開鍵認証を使用するには、SSHClientCert に有効な秘密鍵が含まれている必要があります。 公開鍵はオプションで、含まれていない場合はCloud が秘密鍵から生成します。 Cloud は公開鍵をサーバーに送信し、ユーザーが公開鍵を認証した場合に接続が許可されます。

SSHClientCertType フィールドは、SSHClientCert により指定されたキーストアの種類を指定します。 ストアがパスワードで保護されている場合は、SSHClientCertPassword でパスワードを指定します。

一部の種類のキーストアは、複数のキーを含むことができるコンテナです。 デフォルトでは、Cloud はストアの最初のキーを選択しますが、SSHClientCertSubject を使用して特定のキーを指定することも可能です。

SSHClientCert キーのパスワード（ある場合）。

データ型

string

デフォルト値

""

解説

このプロパティは、SSHAuthMode がPublicKey に設定され、SSHClientCert が秘密鍵に設定されているSFTP サーバーに認証する場合にのみ使用されます。

SSH クライアント証明書のサブジェクト。

データ型

string

デフォルト値

"*"

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	Eメールアドレス

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

SSHClientCert 秘密鍵の種類。

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PPKFILE, PPKBLOB, XMLFILE, XMLBLOB

データ型

string

デフォルト値

"PEMKEY_FILE"

解説

このプロパティには次の値の1つを設定できます。

種類	説明	許容されるBlob 値
MACHINE/USER		Blob 値はサポートされていません。
JKSFILE/JKSBLOB		base64のみ
PFXFILE/PFXBLOB	PKCS12形式（.pfx）のファイル。証明書と秘密鍵の両方を含む必要があります。	base64のみ
PEMKEY_FILE/PEMKEY_BLOB	PEM 形式のファイル。RSA、DSA、またはOPENSSH の秘密鍵を含む必要があります。オプションで、秘密鍵と一致する証明書を含むことができます。	base64またはプレーンテキスト。blob をテキストとして入力する場合、改行をスペースに置き換えることができます。
PPKFILE/PPKBLOB	puttygen ツールで作成されたPuTTY 形式の秘密鍵。	base64のみ
XMLFILE/XMLBLOB	.NET のRSA クラスによって生成される形式のXML キー：RSA.ToXmlString(true)。	base64またはプレーンテキスト。

SSH サーバー。

データ型

string

デフォルト値

""

解説

SSH サーバー。

SSH ポート。

データ型

string

デフォルト値

"22"

解説

SSH ポート。

SSH ユーザー。

データ型

string

デフォルト値

""

解説

SSH ユーザー。

SSH パスワード。

データ型

string

デフォルト値

""

解説

SSH パスワード。

SSH サーバーのフィンガープリント。

データ型

string

デフォルト値

""

解説

SSH サーバーのフィンガープリント。

Amazon Redshift 接続をSSH 経由でトンネリングするかどうか。 SSH を使用します。

データ型

bool

デフォルト値

false

解説

デフォルトでは、Cloud はAmazon Redshift に直接接続しようとします。 このオプションを有効にすると、Cloud は代わりにSSHServer とのSSH 接続を確立し、その接続を経由してAmazon Redshift への接続をトンネリングします。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

データ型

string

デフォルト値

"1"

解説

Verbosity レベルは、Cloud がLogfile にどの程度の詳細さで記載するかを決定します。1 から5 までのVerbosity レベルがサポートされています。より詳しい説明は、ログ ページに記載されています。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
IgnoredSchemas	メタデータクエリによってスキーマのリストを非表示にするために使用される可視性制限フィルタ。例えば、'information_schema, pg_catalog' です。スキーマ名は、大文字・小文字が区別されます。

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

メタデータクエリによってスキーマのリストを非表示にするために使用される可視性制限フィルタ。例えば、'information_schema, pg_catalog' です。スキーマ名は、大文字・小文字が区別されます。

データ型

string

デフォルト値

""

解説

デフォルトでは、制限は適用されません。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
AllowPreparedStatement	クエリステートメントを実行前に準備します。
COPYConversionParameters	Specifies the coma separated list of parameter to use in the COPY command when InsertMode is S3Staging or S3StagingWithIAM. Supported parameters are: BLANKSASNULL DELIMITER EMPTYASNULL EXPLICIT_IDS NULL AS TRIMBLANKS TRUNCATECOLUMNS
FetchResultSetMetadata	This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server.
InsertMode	Specifies what method to use when inserting bulk data. By default DML mode is used.
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
RedshiftToS3RoleARN	The Amazon Resource Name of the role to use when authenticating S3 with IAM role by the COPY command for the bulk inserts.
S3Bucket	Specifies the name of AWS S3 bucket to upload bulk data for staging.
S3BucketFolder	Specifies the name of the folder in AWS S3 bucket to upload bulk data for staging. By default bulk data are staged in the root folder.
StripOutNulls	When set the null characters are stripped out from character values in bulk operations.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TimeZone	現在のセッションのタイムゾーンを設定します。
UseUIDForStaging	Use this property in combination with InsertMode assigned with S3Staging or S3StagingWithIAM. By default the the driver creates staging files with names that prepend the targeted table's name, so the files are overwritten between sessions. When the property is set to True , the provider additionally attaches temporary unique identifiers to these names. It may be required if you use parallel jobs to insert rows into the same table. Thus, the staging files are not overwritten by the jobs. A caveat is that using this property adds to the number of staging files put onto S3 bucket, since the file names are not controlled by the driver between different sessions. In this case you may want to define an AWS S3 policy on the bucket to remove staging files that were stored in a bucket automatically.

クエリステートメントを実行前に準備します。

データ型

bool

デフォルト値

true

解説

AllowPreparedStatement プロパティがfalse に設定されている場合は、ステートメントは実行されるたびに解析されます。たくさんの異なるクエリを一回だけ実行する場合は、このプロパティをfalse に設定すると便利です。

同じクエリを繰り返し実行する場合は、このプロパティをデフォルトのtrue のままにしておくとパフォーマンスが向上します。クエリを準備することで、同じクエリを何度も繰り返しコンパイルすることを避けられます。ただし、プリペアドステートメントの場合、ステートメントが準備される間Cloud は接続をアクティブかつオープンに保つ必要があります。

Specifies the coma separated list of parameter to use in the COPY command when InsertMode is S3Staging or S3StagingWithIAM. Supported parameters are: BLANKSASNULL DELIMITER EMPTYASNULL EXPLICIT_IDS NULL AS TRIMBLANKS TRUNCATECOLUMNS

データ型

string

デフォルト値

""

解説

All parameteres are optional. By default all but 'NULL AS' and 'DELIMITER' are inactive. Default 'DELIMITER' is comma char. See also UseUIDForStaging for more details about the value used as a null mark.

This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server.

データ型

bool

デフォルト値

false

解説

By default, the Cloud will not request that the server provides detailed information about resultset columns like the table name or schema name. It requires issuing additional metadata queries via Cloud , and it may affect query performance essentially in some scenarios. Consider setting this property to True when you need such detailed descriptive information for the resultset columns.

Specifies what method to use when inserting bulk data. By default DML mode is used.

Possible Values

DML, S3Staging, S3StagingWithIAM

データ型

string

デフォルト値

"DML"

解説

When this is set to DML the Cloud uses Insert SQL statements to upload bulk data.

When this is set to S3Staging the Cloud uses the bulk upload API to upload data to the AWS S3 staging folder.

Bulk Insertion

InsertMode provides the following options for executing a bulk insert operation by the driver:

1. DML: This is the default option for sending multiple INSERT statements to the server by the driver in bulk. In this case, the driver issues a multi-row INSERT statement with respective syntax supported by the server. See Use a multi-row insert in the Amazon Redshift documentation.
2. S3Staging: This option involves two steps. Initially, multiple rows are streamed to the Amazon S3 bucket in CSV format. A staging CSV file is then created in the bucket. In the second step, Redshift's COPY FROM command copies the staged CSV file to a database. See COPY in the Amazon Redshift documentation for more information.

   The minimum set of policies required to connect AWS S3 by an IAM user, or a role assumed by it, are:

   • S3:ListBucket
   • S3:GetObject
   • S3:PutObject.

   Note that this mode uses your AWSAccessKey and AWSSecretKey in COPY commands that are sent to the server. This could present a security concern. If you want to hide sensitive information, use the S3StagingWithIAM mode instead.

3. S3StagingWithIAM: This option is similar to S3Staging, but it uses an IAM role parameter for the COPY command.

   The AWSAccessKey and AWSSecretKey are still required to connect in this mode, but they are not be included in the COPY commands sent to Redshift.

NOTE:If you choose the S3Staging or S3StagingWithIAM insert mode, and if you set the UseUIDForStaging connection property to True, you may want to define an AWS S3 policy on the bucket to remove staging files that are automatically stored in the bucket.

See also:

• AllowPreparedStatement
• RedshiftToS3RoleARN

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

データ型

int

デフォルト値

-1

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

The Amazon Resource Name of the role to use when authenticating S3 with IAM role by the COPY command for the bulk inserts.

データ型

string

デフォルト値

"default"

解説

By default, if this property is not set, the COPY command uses 'default' value for the IAM role.

Specifies the name of AWS S3 bucket to upload bulk data for staging.

データ型

string

デフォルト値

""

解説

Specifies the name of the folder in AWS S3 bucket to upload bulk data for staging. By default bulk data are staged in the root folder.

データ型

string

デフォルト値

""

解説

When set the null characters are stripped out from character values in bulk operations.

データ型

bool

デフォルト値

false

解説

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

データ型

int

デフォルト値

10

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。

現在のセッションのタイムゾーンを設定します。

データ型

string

デフォルト値

""

解説

TimeZone プロパティが設定されない場合は、プロバイダーはクライアントシステムのタイムゾーンを使用します。このプロパティを設定すると、タイムゾーンとtimestamp with timezone の値を、クライアントシステムのタイムゾーンとは異なる特定のタイムゾーンに変換する必要がある場合に便利です。

Use this property in combination with InsertMode assigned with S3Staging or S3StagingWithIAM. By default the the driver creates staging files with names that prepend the targeted table's name, so the files are overwritten between sessions. When the property is set to True , the provider additionally attaches temporary unique identifiers to these names. It may be required if you use parallel jobs to insert rows into the same table. Thus, the staging files are not overwritten by the jobs. A caveat is that using this property adds to the number of staging files put onto S3 bucket, since the file names are not controlled by the driver between different sessions. In this case you may want to define an AWS S3 policy on the bucket to remove staging files that were stored in a bucket automatically.

データ型

bool

デフォルト値

false

解説