接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
| プロパティ | 説明 |
| AuthScheme | Specifies the authentication scheme that the provider uses when connecting to the Apache Kafka broker. |
| User | Specifies the username used to authenticate to the Apache Kafka broker. |
| Password | Specifies the password used to authenticate to Apache Kafka for the selected authentication scheme. |
| BootstrapServers | Specifies the Kafka bootstrap servers that the provider uses to establish the initial connection to the Kafka cluster. |
| UseSSL | Specifies whether the provider negotiates SSL/TLS when connecting to the Apache Kafka broker. |
| プロパティ | 説明 |
| ConsumerGroupId | Specifies the consumer group that the provider uses when reading messages from Apache Kafka. |
| AutoCommit | Specifies whether the Apache Kafka consumer automatically commits read offsets. |
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されているApache Kafka テナントを識別します。テナントのドメイン名（例： contoso.onmicrosoft.com ）またはディレクトリ（テナント）ID のいずれかを受け付けます。 |
| AzureResource | 認証するAzure Active リソース（Azure OAuth 交換時に使用されます）。 |
| プロパティ | 説明 |
| InitiateOAuth | OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ） |
| OAuthAccessToken | データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。 |
| DelegatedServiceAccounts | 委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。 |
| RequestingServiceAccount | 委任されたリクエストを行うためのサービスアカウントのE メールを指定します。 |
| OAuthSettingsLocation | OAuth 値が保存される設定ファイルの場所を指定します。 |
| Scope | Specifies the scopes to request when obtaining an OAuth token from the OIDC token endpoint. |
| OAuthAccessTokenURL | OAuth アクセストークンを取得するURL。 |
| OAuthVerifier | OAuthAuthorizationURL から返された検証コードを指定します。ブラウザを起動できないヘッドレスサーバーでOAuth 認証を行う場合に使用します。 OAuthSettingsLocation および OAuthVerifier の両方が設定される必要があります。 |
| OAuthRefreshToken | 元のアクセストークンが期限切れになった後に新しいアクセストークンを要求するために使用される、OAuth リフレッシュトークンを指定します。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期間を秒単位で指定します。ユーザーが操作を続けている限り、アクセスを維持するためにトークンを再発行することができます。 |
| OAuthTokenTimestamp | 現在のアクセストークンがいつ作成されたかを示すUnix エポックタイムスタンプをミリ秒単位で表示します。 |
| プロパティ | 説明 |
| OAuthJWTCert | クライアント証明書のJWT 証明書ストアの名前を指定します。 |
| OAuthJWTCertType | JWT 証明書を格納しているキーストアの種類を指定します。 |
| OAuthJWTCertPassword | パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| プロパティ | 説明 |
| KerberosKeytabFile | Specifies the path to the keytab file that contains the Kerberos principals and encrypted keys used for authentication. |
| KerberosSPN | Specifies the full Kerberos service principal name (SPN) of the Kafka broker. |
| KerberosServiceName | Specifies the Kerberos service name used when authenticating to the Kafka broker. |
| UseKerberosTicketCache | Specifies whether the provider uses the Kerberos ticket cache for authentication instead of a keytab file. |
| プロパティ | 説明 |
| SSLServerCert | Specifies the SSL server certificate or certificate store used to verify the identity of the Apache Kafka broker. |
| SSLServerCertType | Specifies the format of the SSL server certificate used to verify the Apache Kafka broker. |
| SSLServerCertPassword | Specifies the password used to decrypt the server certificate provided in SSLServerCert . |
| SSLClientCert | Specifies the SSL client certificate used to authenticate with the Apache Kafka broker. |
| SSLClientCertType | Specifies the format of the SSL client certificate used to connect to the Apache Kafka broker. |
| SSLClientCertPassword | Specifies the password used to decrypt the certificate provided in SSLClientCert . |
| SSLIdentificationAlgorithm | Specifies the endpoint identification algorithm used to validate the server host name during SSL/TLS connections. |
| プロパティ | 説明 |
| RegistryURL | Specifies the endpoint of the schema registry. When this property is specified, the driver supports reading Avro and JSON schemas from the server. |
| RegistryService | Specifies the schema registry service that the provider uses to retrieve key and value schemas for Apache Kafka topics. |
| RegistryAuthScheme | Specifies the authentication scheme that the provider uses when connecting to the schema registry. |
| RegistryUser | Specifies the user name used when authenticating to the schema registry with the Basic authentication scheme. |
| RegistryPassword | Specifies the password used when authenticating to the schema registry with the Basic authentication scheme. |
| RegistryClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL) with the schema registry. |
| RegistryClientCertType | Specifies the type of key store used by the TLS/SSL client certificate given in RegistryClientCert . |
| RegistryClientCertPassword | Specifies the password for the client certificate store defined in RegistryClientCert. |
| RegistryClientCertSubject | Specifies the subject of the client certificate to select from the certificate store defined in RegistryClientCert. |
| RegistryVersion | Specifies which version of a schema the provider retrieves from the schema registry when resolving topic columns. |
| RegistryServerCert | The certificate to be accepted from the schema registry when connecting using TLS/SSL. |
| SchemaMergeMode | Specifies how the provider exposes schemas with multiple versions. |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| Logfile | provider が認証、クエリ実行、接続の詳細などのアクティビティを記録するログファイルのファイルパスを指定します。 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| MaxLogFileSize | 単一のログファイルの最大サイズをバイト単位で指定します。例えば、'10 MB' です。ファイルが上限に達すると、provider は日付と時刻を名前に付加した新しいログファイルを作成します。 |
| MaxLogFileCount | provider が保持するログファイルの最大数を指定します。上限に達すると、最も古いログファイルが削除され、新しいログファイルのためのスペースが作られます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの対象となるテーブルの内容が、指定されたキャッシュデータベースに自動的にキャッシュされるかどうかを指定します。 |
| CacheDriver | JDBC ドライバーのドライバークラス。指定されたドライバーは、すべてのキャッシュ操作のためにターゲットデータベースに接続するために使用されます。 |
| CacheConnection | 指定されたキャッシュデータベースの接続文字列を指定します。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | 指定されたキャッシュデータベース内の失効データに対する許容時間（秒単位）を指定します。AutoCache がTrue に設定されている必要があります。 |
| Offline | ライブApache Kafka データの代わりに、指定されたキャッシュデータベースからデータを取得します。 |
| CacheMetadata | provider がテーブルメタデータをファイルベースのキャッシュデータベースにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| AllowKeyOnlyRegistryTopics | Specifies whether the provider exposes key-only Schema Registry topics as tables. |
| AWSWorkloadIdentityConfig | AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| AzureWorkloadIdentityConfig | Azure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| BatchSize | バッチ操作中に送信される各バッチに含まれる行の最大数を指定します。バッチ全体を1つのリクエストとして送信するには、BatchSize を 0 に設定します。 |
| CompressionType | Specifies the compression algorithm that the provider uses when producing messages to Apache Kafka. |
| ConnectionLifeTime | 接続の最大有効期間を秒単位で指定します。指定した時間が経過すると、provider は接続を閉じます。 |
| ConnectOnOpen | プロバイダーが接続を開くと同時にApache Kafka への接続を確立するかどうかを指定します。すぐに接続性を検証する必要がある場合は、ConnectOnOpen をTrue に設定します。 |
| ConsumerProperties | Specifies additional Kafka consumer configuration options that the provider passes directly to the underlying Kafka client. |
| CreateTablePartitions | Specifies the number of partitions to assign to a topic created through a CREATE TABLE statement. |
| CreateTableReplicationFactor | Specifies the the number of replicas to assign to a topic created through a CREATE TABLE statement. |
| EnableIdempotence | Specifies whether the provider ensures that produced messages are delivered in order and without duplicates. |
| ExposeQueueMetadataColumns | Specifies whether the Partition, Offset, and Timestamp columns are exposed. |
| FlattenArrays | Specifies how many elements to return from nested arrays when TypeDetectionScheme is set to SchemaRegistry. |
| GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
| HideUnusedColumns | Determines whether to hide key or value colums when the topic has no associated schema information. |
| MaximumBatchSize | Specifies the maximum size, in bytes, of a batch of messages that the provider gathers before sending the batch to Apache Kafka. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| MessageKeyColumn | Specifies the name of the column where the provider stores the message key for each record. |
| MessageKeyType | The type of data stored in message keys. |
| NonRegistryTypeDetectionScheme | Specifies the TypeDetectionScheme to use for topics that do not have schemas in the schema registry. |
| OffsetResetStrategy | Specifies how the provider determines the starting offset when no committed offset exists for the consumer group. |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | Specifies the maximum number of rows that the provider retrieves from Apache Kafka in a single read operation. |
| PoolIdleTimeout | 接続が閉じられるまでのプール内の最大アイドル時間を秒単位で指定します。 UseConnectionPooling=True が必要です。 |
| PoolMaxSize | 接続プールで許容される接続の最大数を指定します。 |
| PoolMinSize | 接続プールで常に維持される接続の最小数を指定します。 |
| PoolWaitTime | 接続リクエストがプール内の利用可能な接続を待機する最大秒数を指定します。待ち時間がこの時間を超えるとエラーが返されます。 |
| ProducerProperties | Specifies additional Apache Kafka producer configuration options that the provider passes directly to the client. |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| ReadDuration | Specifies how long, in seconds, the provider waits for additional messages after a read operation begins. |
| Readonly | provider からApache Kafka への読み取り専用アクセスを切り替えます。 |
| RowScanDepth | Specifies the maximum number of messages that the provider scans to determine the columns and data types for a topic. |
| RTK | provider のライセンスを取得するためのランタイムキーを指定します。設定されていないか無効な場合、provider は標準のライセンス方法をデフォルトとして使用します。このプロパティは、標準のライセンス方法がサポートされていないか、ランタイムキーが必要な環境でのみ必要です。 |
| SASLOAuthExtensions | Specifies the extension values to send with OAuth auth schemes. |
| SchemaRegistryOnly | Specifies whether the provider connects only to the schema registry. |
| SerializationFormat | Specifies how to serialize/deserialize message contents. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| TypeDetectionScheme | Specifies how the provider determines the available fields and data types for each topic. |
| UseConfluentAvroFormat | Specifies how Avro data should be formatted during an INSERT. |
| UseConnectionPooling | 接続プーリング機能を有効にすると、provider がリクエストごとに新しい接続を作成する代わりに、既存の接続を再利用できます。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| ValidateRegistryTopics | Specifies whether or not to validate schema registry topics against the Apache Kafka broker. Only has an effect when TypeDetectionScheme =SchemaRegistry |
| WorkloadPoolId | Workload Identity Federation プールのID。 |
| WorkloadProjectId | Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。 |
| WorkloadProviderId | Workload Identity Federation プールプロバイダーのID。 |