ADO.NET Provider for Apache Kafka

Build 24.0.9060

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.
BatchSizeThe maximum size of each batch operation to submit.
CompressionTypeData compression type. Batches of data will be compressed together.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
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.
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.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of rows to fetch from Kafka at one time.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
ProducerPropertiesAdditional options used to configure Kafka producers.
PseudoColumnsSpecify a set of pseudocolumns to expose as columns.
ReadDurationThe duration which additional messages are allowed.
ReadonlyYou can use this property to enforce read-only access to Apache Kafka from the provider.
RowScanDepthThe maximum number of messages to scan for the columns available in the topic.
RTKThe runtime key used for licensing.
SerializationFormatSpecifies how to serialize/deserialize message contents.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionSchemeComma-separated list of options specifying how the provider will scan the data to determine the fields and datatypes for the topic.
UseConfluentAvroFormatSpecifies how Avro data should be formatted during an INSERT.
UseConnectionPoolingThis property enables connection pooling.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
ValidateRegistryTopicsSpecifies whether or not to validate schema registry topics against the Apache Kafka broker. Only has an effect when TypeDetectionScheme =SchemaRegistry.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060