接続文字列オプション
接続プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続設定で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
| プロパティ | 説明 |
| 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. |
| プロパティ | 説明 |
| 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 のセッショントークン。 |
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
| プロパティ | 説明 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 |
| SSOExchangeUrl | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
| プロパティ | 説明 |
| InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
| OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
| CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
| Scope | 初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| PKCEVerifier | PKCE 認証スキームにGetOAuthAuthorizationUrl ストアドプロシージャを実行することで生成されるPKCE code verifier。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期限（秒単位）。 |
| OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ（ミリ秒）。 |
| プロパティ | 説明 |
| SSLClientCert | SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。 |
| SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
| SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
| SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| 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 を使用します。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | この接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | プロキシサーバー（ ProxyServer 接続プロパティで指定）が起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| Logfile | ログファイルの名前と場所を指定するファイルパス。 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| LogModules | ログファイルに含めるコアモジュール。 |
| MaxLogFileSize | ログファイルの最大バイトサイズ（例えば、10MB）を指定する文字列。 |
| MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| IgnoredSchemas | メタデータクエリによってスキーマのリストを非表示にするために使用される可視性制限フィルタ。例えば、'information_schema, pg_catalog' です。スキーマ名は、大文字・小文字が区別されます。 |
| プロパティ | 説明 |
| 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. |
| IncludeTableTypes | If set to true, the provider will query for the types of individual tables and views. |
| InsertMode | Specifies what method to use when inserting bulk data. By default DML mode is used. |
| LZ4Compression | When set the driver notifies the server to compress data packets with lz4 compression algorithm. |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| QueryPassthrough | このオプションは、クエリをAmazon Redshift サーバーにas-is で渡します。 |
| Readonly | このプロパティを使用して、provider からAmazon Redshift へのアクセスを読み取り専用に設定できます。 |
| RedshiftToS3RoleARN | The Amazon Resource Name of the role to use when authenticating S3 with IAM role by the COPY command for the bulk inserts. |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| 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. |