ADO.NET Provider for Apache Kafka

Build 25.0.9434

Miscellaneous

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


PropertyDescription
NativeLibPathThe absolute path of the .NET Confluent Kafka 'librdkafka' native library to load on the runtime.
AllowKeyOnlyRegistryTopicsSpecifies whether key-only registry topics are exposed as tables. Only has an effect when TypeDetectionScheme =SchemaRegistry.
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 .
CompressionTypeData compression type. Batches of data will be compressed together.
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection.
ConsumerPropertiesAdditional options used to configure Kafka consumers.
CreateTablePartitionsThe number of partitions assigned to a topic created with CREATE TABLE.
CreateTableReplicationFactorThe number of replicas assigned to a topic created with CREATE TABLE.
EnableIdempotenceIf set to true, the Apache Kafka will ensure messages are delivered in the correct order, and without duplicates.
ExposeQueueMetadataColumnsSpecifies whether the Partition, Offset, and Timestamp columns are exposed.
FlattenArraysBy 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.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
MaximumBatchSizeSpecifies maximum batch size to gather before sending a request.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MessageKeyColumnThe name of the column that message key data is stored in.
MessageKeyTypeThe type of data stored in message keys.
OffsetResetStrategySpecifies an offset for the consumer group.
OtherSpecifies 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.
PagesizeThe maximum number of rows to fetch from Kafka at one time.
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.
ProducerPropertiesAdditional options used to configure Kafka producers.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ReadDurationThe duration which additional messages are allowed.
ReadonlyToggles read-only access to Apache Kafka from the provider.
RowScanDepthThe maximum number of messages to scan for the columns available in the 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.
SchemaRegistryOnlyWhether to connect 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.
TypeDetectionSchemeComma-separated list of options specifying how the provider scans the data to determine the fields and datatypes for the 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) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434