ADO.NET Provider for Apache Kafka

Build 25.0.9539

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
NativeLibPathSpecifies the absolute path of the .NET Confluent Kafka 'librdkafka' native library to load at runtime.
AllowKeyOnlyRegistryTopicsSpecifies whether the provider exposes key-only Schema Registry topics as tables.
AWSWorkloadIdentityConfigConfiguration properties to provide when using Workload Identity Federation via AWS.
AzureWorkloadIdentityConfigConfiguration properties to provide when using Workload Identity Federation via Azure.
BatchSizeSpecifies 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 .
CompressionTypeSpecifies the compression algorithm that the provider uses when producing messages to Apache Kafka.
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection.
ConsumerPropertiesSpecifies additional Kafka consumer configuration options that the provider passes directly to the underlying Kafka client.
CreateTablePartitionsSpecifies the number of partitions to assign to a topic created through a CREATE TABLE statement.
CreateTableReplicationFactorSpecifies the the number of replicas to assign to a topic created through a CREATE TABLE statement.
EnableIdempotenceSpecifies whether the provider ensures that produced messages are delivered in order and without duplicates.
ExposeQueueMetadataColumnsSpecifies whether the Partition, Offset, and Timestamp columns are exposed.
FlattenArraysSpecifies how many elements to return from nested arrays when TypeDetectionScheme is set to SchemaRegistry.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
HideUnusedColumnsDetermines whether to hide key or value colums when the topic has no associated schema information.
MaximumBatchSizeSpecifies the maximum size, in bytes, of a batch of messages that the provider gathers before sending the batch to Apache Kafka.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MessageKeyColumnSpecifies the name of the column where the provider stores the message key for each record.
MessageKeyTypeThe type of data stored in message keys.
NonRegistryTypeDetectionSchemeSpecifies the TypeDetectionScheme to use for topics that do not have schemas in the schema registry.
OffsetResetStrategySpecifies how the provider determines the starting offset when no committed offset exists for the consumer group.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PagesizeSpecifies the maximum number of rows that the provider retrieves from Apache Kafka in a single read operation.
PoolIdleTimeoutSpecifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool.
PoolMinSizeSpecifies the minimum number of connections to be maintained in the connection pool at all times.
PoolWaitTimeSpecifies 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.
ProducerPropertiesSpecifies additional Apache Kafka producer configuration options that the provider passes directly to the client.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ReadDurationSpecifies how long, in seconds, the provider waits for additional messages after a read operation begins.
ReadonlyToggles read-only access to Apache Kafka from the provider.
RowScanDepthSpecifies the maximum number of messages that the provider scans to determine the columns and data types for a topic.
RTKSpecifies 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.
SASLOAuthExtensionsSpecifies the extension values to send with OAuth auth schemes.
SchemaRegistryOnlySpecifies whether the provider connects only to the schema registry.
SerializationFormatSpecifies how to serialize/deserialize message contents.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
TypeDetectionSchemeSpecifies how the provider determines the available fields and data types for each topic.
UseConfluentAvroFormatSpecifies how Avro data should be formatted during an INSERT.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
ValidateRegistryTopicsSpecifies whether or not to validate schema registry topics against the Apache Kafka broker. Only has an effect when TypeDetectionScheme =SchemaRegistry.
WorkloadPoolIdThe ID of your Workload Identity Federation pool.
WorkloadProjectIdThe ID of the Google Cloud project that hosts your Workload Identity Federation pool.
WorkloadProviderIdThe ID of your Workload Identity Federation pool provider.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539