接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
| プロパティ | 説明 |
| AuthScheme | The scheme used for authentication with the Apache Kafka broker. |
| User | The user who is authenticating to Apache Kafka. |
| Password | The password used to authenticate to Apache Kafka. |
| BootstrapServers | The address of the Apache Kafka BootstrapServers to which you are connecting to. |
| UseSSL | This field sets whether SSL is enabled. Automatically enabled if AuthScheme is set to SSL. |
| プロパティ | 説明 |
| ConsumerGroupId | Specifies which group the consumers created by the driver should belong to. |
| AutoCommit | Specifies if the Apache Kafka consumer should automatically commit read offsets. |
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
| AzureResource | 認証するAzure Active リソース（Azure OAuth 交換時に使用されます）。 |
| プロパティ | 説明 |
| InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
| OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期限（秒単位）。 |
| OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ（ミリ秒）。 |
| プロパティ | 説明 |
| KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosServiceName | The name of the Kerberos service you want to authenticate with. |
| UseKerberosTicketCache | Set this to use a ticket cache with the logged in user instead of a keytab file. |
| プロパティ | 説明 |
| SSLServerCert | The SSL server certificate used to validate to the Apache Kafka broker. |
| SSLServerCertType | The format of the SSL server certificate used to verify the Apache Kafka broker. |
| SSLServerCertPassword | The password used to decrypt the certificate in SSLServerCert . |
| SSLClientCert | The SSL client certificate used to connect to the Apache Kafka broker. |
| SSLClientCertType | The format of the SSL client certificate used to connect to the Apache Kafka broker. |
| SSLClientCertPassword | The password used to decrypt the certificate in SSLClientCert . |
| SSLIdentificationAlgorithm | The endpoint identification algorithm used by the Apache Kafka data provider client app to validate server host name. |
| プロパティ | 説明 |
| RegistryUrl | The server for the schema registry. When this property is specified, the driver supports reading Avro and JSON schemas from the server. |
| RegistryService | The Schema Registry service used for working with topic schemas. |
| RegistryAuthScheme | The scheme used to authenticate to the schema registry. |
| RegistryUser | Username to authorize with the server specified in RegistryUrl . |
| RegistryPassword | Password to authorize with the server specified in RegistryUrl . |
| RegistryClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL) with the schema registry. |
| RegistryClientCertType | The type of key store used by the TLS/SSL client certificate given in RegistryClientCert . |
| RegistryClientCertPassword | The password for the TLS/SSL client certificate given in RegistryClientCert . |
| RegistryClientCertSubject | The subject of the TLS/SSL client certificate given in RegistryClientCert . |
| RegistryVersion | Version of the schema read from RegistryUrl for the specified topic. |
| RegistryServerCert | The certificate to be accepted from the schema registry when connecting using TLS/SSL. |
| プロパティ | 説明 |
| 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 です。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheDriver | データのキャッシュに使用されるデータベースドライバー。 |
| CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| BatchSize | 送信する各バッチ処理の最大サイズ。 |
| CompressionType | Data compression type. Batches of data will be compressed together. |
| ConnectionLifeTime | 接続の最大有効期間（秒単位）。その時間が経過すると、接続オブジェクトは削除されます。 |
| ConnectOnOpen | このプロパティは、接続が開かれたときにApache Kafka に接続するかどうかを指定します。 |
| ConsumerProperties | Additional options used to configure Kafka consumers. |
| CreateTablePartitions | The number of partitions assigned to a topic created with CREATE TABLE. |
| CreateTableReplicationFactor | The number of replicas assigned to a topic created with CREATE TABLE. |
| EnableIdempotence | If set to true, the Apache Kafka will ensure messages are delivered in the correct order, and without duplicates. |
| FlattenArrays | By default, nested arrays won't show up if TypeDetectionScheme is set to SchemaRegistry. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays. |
| GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
| MaximumBatchSize | Specifies maximum batch size to gather before sending a request. |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| MessageKeyColumn | The name of the column that message key data is stored in. |
| MessageKeyType | The type of data stored in message keys. |
| OffsetResetStrategy | Specifies an offset for the consumer group. |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | The maximum number of rows to fetch from Kafka at one time. |
| PoolIdleTimeout | 接続が閉じられる前に許容されたアイドル時間。 |
| PoolMaxSize | プールの最大接続数。 |
| PoolMinSize | プール内の最小接続数。 |
| PoolWaitTime | 使用可能な接続を待機する最大秒数。 |
| ProducerProperties | Additional options used to configure Kafka producers. |
| PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
| ReadDuration | The duration which additional messages are allowed. |
| Readonly | このプロパティを使用して、provider からApache Kafka へのアクセスを読み取り専用に設定できます。 |
| RowScanDepth | The maximum number of messages to scan for the columns available in the topic. |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| SerializationFormat | Specifies how to serialize/deserialize message contents. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| TypeDetectionScheme | Comma-separated list of options specifying how the provider will scan the data to determine the fields and datatypes for the topic. |
| UseConfluentAvroFormat | Specifies how Avro data should be formatted during an INSERT. |
| UseConnectionPooling | このプロパティは、コネクションプーリングを有効にします。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| ValidateRegistryTopics | Specifies whether or not to validate schema registry topics against the Apache Kafka broker. Only has an effect when TypeDetectionScheme =SchemaRegistry |