接続プロパティ
接続プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続設定で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、はじめにを参照してください。
| プロパティ | 説明 |
| AthenaVPCEndpoint | Your Athena VPC Endpoint. It will override the default athena.{region}.amazonaws.com endpoint. |
| S3StagingDirectory | Specifies the location Amazon Athena will use to store the results of a query. |
| EncryptionType | Specifies the encryption option for query results in Athena. |
| EncryptionKey | Specifies the encryption key when encrypting results stored in S3. |
| DataSource | The name of the Athena Data Source. |
| Database | The name of the Athena database. |
| プロパティ | 説明 |
| CrossAccountId | The Account Id to use when retrieving metadata from Glue. Default is current account id. |
| SimpleUploadLimit | この設定はしきい値をバイト単位で設定します。このしきい値を超えると、provider は1つのリクエストですべてをアップロードするのではなく、マルチパートでアップロードを実行します。 |
| UseLakeFormation | このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。 |
| プロパティ | 説明 |
| AuthScheme | 認証で使用されるスキーム。許容されるエンティティは：Auto、、AwsRootKeys 、AwsIAMRoles 、AwsEC2Roles 、AwsMFA 、ADFS、Okta、PingFederate 、AwsCredentialsFile 、AwsCognitoBasic 、AwsCognitoSrpです。 |
| AWSAccessKey | AWS アカウントのアクセスキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。 |
| AWSSecretKey | AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。 |
| AWSRoleARN | 認証時に使用するロールのAmazon リソースネーム。 |
| AWSPrincipalARN | AWS アカウントのSAML ID プロバイダーのARN。 |
| AWSRegion | Amazon Web サービスのホスティングリージョン。 |
| AWSCredentialsFile | 認証に使用するAWS クレデンシャルファイルへのパス。 |
| AWSCredentialsFileProfile | 提供されたAWSCredentialsFile から使用されるプロファイルの名前。 |
| AWSSessionToken | AWS のセッショントークン。 |
| AWSExternalId | 他のアカウントでロールを引き受ける際に必要となる一意の識別子。 |
| MFASerialNumber | MFA デバイスが使用されている場合は、そのシリアル番号。 |
| MFAToken | MFA デバイスから利用できる一時トークン。 |
| CredentialsLocation | MFA クレデンシャルが保存される設定ファイルの場所。 |
| TemporaryTokenDuration | 一時トークンが持続する時間（秒単位）。 |
| AWSCognitoRegion | AWS Cognito のホスティングリージョン。 |
| AWSUserPoolId | ユーザープールのID。 |
| AWSUserPoolClientAppId | ユーザープールのアプリクライアントID。 |
| AWSUserPoolClientAppSecret | ユーザープールのアプリクライアントシークレット。（オプション） |
| AWSIdentityPoolId | ID プールのID。 |
| プロパティ | 説明 |
| User | SSO 経由でIDP の認証に使用するIDP ユーザー。 |
| Password | SSO 経由でIDP ユーザーの認証に使用するパスワード。 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。 |
| SSOExchangeUrl | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
| プロパティ | 説明 |
| InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
| CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| 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 です。 |
| FlattenArrays | By default, arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from arrays. |
| FlattenObjects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheProvider | データのキャッシュに使用されるプロバイダーの名前。 |
| CacheDriver | データのキャッシュに使用されるデータベースドライバー。 |
| CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| BatchSize | 送信する各バッチ処理の最大サイズ。 |
| CleanQueryResults | Amazon Athena produces cache files with every query, in the folder specified in S3StagingDirectory . CleanQueryResults specifies whether these files should be deleted once the connection is closed. |
| DefaultDomain | このプロパティは、Oracle Database Gateway for ODBC で使用されます。 |
| EnableFIPSMode | A boolean indicating if FIPS URLs should be enabled. |
| EnableForeignKeyDetection | ODBC で外部キーを検出するかどうか。 |
| IncludeDualTable | Oracle データベースとの互換性を向上するためにOracle DUAL テーブルのモックを作成するには、このプロパティを設定します。 |
| IncludeTableTypes | If set to true, the provider will query for the types of individual tables. |
| LimitKeySize | 主キーカラムの最大長。 |
| MapBigintToVarchar | このプロパティは、bigint 型がSQL_BIGINT の代わりにSQL_VARCHAR にマップされるかどうかをコントロールします。デフォルトはfalse です。 |
| MapToInt | このプロパティは、Long 型がSQL_BIGINT の代わりにSQL_INTEGER にマップされるかどうかをコントロールします。デフォルトはfalse です。 |
| MapToLongVarchar | このプロパティは、カラムをSQL_LONGVARCHAR として返すかどうかを制御します。 |
| MapToWVarchar | このプロパティは、文字列型をSQL_VARCHAR ではなくSQL_WVARCHAR にマッピングするかどうかを制御します。デフォルトではSQL_WVARCHAR が設定されます。 |
| MaximumColumnSize | The maximum column size. |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| MetadataDiscoveryMethod | API to use to retrieve the metadata for Amazon Athena. |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PageSize | The number of results to return per page of data retrieved from Amazon Athena. |
| PollingInterval | This determines the polling interval in milliseconds to check whether the result is ready to be retrieved. |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| PushEmptyValuesAsNull | Indicates whether to read the empty values as empty or as null. |
| QueryCachingLevel | Modifies the usage of query results stored in S3StagingDirectory . Cached queries will not be scanned again by Amazon Athena until the amount of seconds specified in QueryTolerance has passed. |
| QueryPassthrough | このオプションは、クエリをAmazon Athena サーバーにas-is で渡します。 |
| QueryTimeout | The timeout in seconds for requests issued by the provider to download large result sets. |
| QueryTolerance | Specifies the amount of time in seconds queries cache for if QueryCachingLevel is not set to None. |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| ShowS3Filepath | Whether or not to expose the _S3Path column for the Amazon Athena tables. |
| SkipHeaderLineCount | Specifies the number of header rows to skip for SELECT queries. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UpperCaseIdentifiers | このプロパティは、大文字で設定されているすべての識別子を報告します。これは、Oracle データベースのデフォルト設定で、Oracle Database Gateway のようなOracle ツールとの統合を向上します。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| Workgroup | Work group of the executed queries. |