ADO.NET Provider for Apache Kafka

Build 21.0.7940

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.
AggregateMessagesSpecifies whether or not to return the message as a whole string.
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.
EnableIdempotenceIf set to true, the Apache Kafka will ensure messages are delivered in the correct, and without duplicates.
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 rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
MessageKeyColumnIf specified, the message key sent to Apache Kafka will be read from this column.
MessageKeyTypeIf MessageKeyColumn is specified, this property must be set to the expected type for the pertinent column.
OffsetResetStrategySpecifies an offset for the consumer group.
OtherThese hidden properties are used only in specific use cases.
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.
ProduceMetaSpecifies whether or not to send a meta message while producing the outgoing message.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
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 the incoming or outgoing message.
SupportEnhancedSQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
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 bucket.
UseConnectionPoolingThis property enables connection pooling.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7940