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. |
| Topic | The topic used for read and write operations. |
| 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 autocommit after each poll. |
| 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 will read Apache Avro schema from the server. |
| RegistryType | Type of the schema specified for the a specific topic. |
| 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. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheDriver | The database driver used to cache data. |
| CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| AggregateMessages | Specifies whether or not to return the message as a whole string. |
| BatchSize | The maximum size of each batch operation to submit. |
| CompressionType | Data compression type. Batches of data will be compressed together. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| ConnectOnOpen | This property specifies whether to connect to the Apache Kafka when the connection is opened. |
| 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 | 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 | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| MessageKeyColumn | If specified, the message key sent to Apache Kafka will be read from this column. |
| MessageKeyType | If MessageKeyColumn is specified, this property must be set to the expected type for the pertinent column. |
| OffsetResetStrategy | Specifies an offset for the consumer group. |
| Other | These hidden properties are used only in specific use cases. |
| PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
| PoolMaxSize | The maximum connections in the pool. |
| PoolMinSize | The minimum number of connections in the pool. |
| PoolWaitTime | The max seconds to wait for an available connection. |
| ProduceMeta | Specifies whether or not to send a meta message while producing the outgoing message. |
| ProducerProperties | Additional options used to configure Kafka producers. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| ReadDuration | The duration which additional messages are allowed. |
| Readonly | You can use this property to enforce 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 | The runtime key used for licensing. |
| SerializationFormat | Specifies how to serialize/deserialize the incoming or outgoing message. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| TypeDetectionScheme | Comma-separated list of options specifying how the provider will scan the data to determine the fields and datatypes for the bucket. |
| UseConfluentAvroFormat | Specifies how Avro data should be formatted during an INSERT. |
| UseConnectionPooling | This property enables connection pooling. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| ValidateRegistryTopics | Specifies whether or not to validate schema registry topics against the Apache Kafka broker. Only has an effect when TypeDetectionScheme =SchemaRegistry. |