Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| 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. |
| Property | Description |
| 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. |
| Property | Description |
| AzureTenant | Identifies the Apache Kafka tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| AzureResource | The Azure Active resource to authenticate to (used during Azure OAuth exchange). |
| Property | Description |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| DelegatedServiceAccounts | Specifies a space-delimited list of service account emails for delegated requests. |
| RequestingServiceAccount | Specifies a service account email to make a delegated request. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| Scope | Specifies the scopes to use when requesting credentials from the OIDC token endpoint. |
| OAuthAccessTokenURL | The URL from which the OAuth access token is retrieved. |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
| Property | Description |
| 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. |
| Property | Description |
| 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. |
| Property | Description |
| 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. |
| SchemaMergeMode | How the provider exposes schemas with multiple versions. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheDriver | The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live Apache Kafka data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| AllowKeyOnlyRegistryTopics | Specifies whether key-only registry topics are exposed as tables. Only has an effect when TypeDetectionScheme =SchemaRegistry. |
| AWSWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via AWS. |
| AzureWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via Azure. |
| BatchSize | Specifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 . |
| CompressionType | Data compression type. Batches of data will be compressed together. |
| ConnectionLifeTime | Specifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. |
| ConnectOnOpen | Specifies whether the provider establishes a connection to Apache Kafka immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary. |
| 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. |
| ExposeQueueMetadataColumns | Specifies whether the Partition, Offset, and Timestamp columns are exposed. |
| 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 | Indicates the user preference as to when schemas should be generated and saved. |
| MaximumBatchSize | Specifies maximum batch size to gather before sending a request. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| 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 | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Pagesize | The maximum number of rows to fetch from Kafka at one time. |
| PoolIdleTimeout | Specifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True. |
| PoolMaxSize | Specifies the maximum number of connections allowed in the connection pool. |
| PoolMinSize | Specifies the minimum number of connections to be maintained in the connection pool at all times. |
| PoolWaitTime | Specifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned. |
| ProducerProperties | Additional options used to configure Kafka producers. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ReadDuration | The duration which additional messages are allowed. |
| Readonly | Toggles read-only access to Apache Kafka from the provider. |
| RowScanDepth | The maximum number of messages to scan for the columns available in the topic. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| SchemaRegistryOnly | Whether to connect only to the schema registry. |
| SerializationFormat | Specifies how to serialize/deserialize message contents. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| TypeDetectionScheme | Comma-separated list of options specifying how the provider scans the data to determine the fields and datatypes for the topic. |
| UseConfluentAvroFormat | Specifies how Avro data should be formatted during an INSERT. |
| UseConnectionPooling | Enables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| ValidateRegistryTopics | Specifies whether or not to validate schema registry topics against the Apache Kafka broker. Only has an effect when TypeDetectionScheme =SchemaRegistry. |
| WorkloadPoolId | The ID of your Workload Identity Federation pool. |
| WorkloadProjectId | The ID of the Google Cloud project that hosts your Workload Identity Federation pool. |
| WorkloadProviderId | The ID of your Workload Identity Federation pool provider. |