ADO.NET Provider for Apache Kafka

Build 23.0.8839

SerializationFormat

Specifies how to serialize/deserialize message contents.

Possible Values

NONE, AUTO, JSON, CSV, XML, AVRO

Data Type

string

Default Value

"AUTO"

Remarks

The provider uses this property differently based on the value of TypeDetectionScheme:

  • None, RowScan: The provider samples messages from the topic to determine their columns. If SerializationFormat is AUTO, then the format is determined based on the message content. Otherwise, the format is just the value of this property.
  • SchemaRegistry: The provider uses SerializationFormat, a fallback, if it cannot determine the format from the registry. This is rare as it only happens when the registry does not specify a format and the schema cannot be inferred to be a JSON or Avro schema.
  • MessageOnly: SerializationFormat determines how the message column is surfaced. If the format is AUTO, AVRO, or NONE, the message column is treated as binary and uses base64 encoded values. Otherwise, the message column is treated as text.

Available formats:

NONE Message will be always BASE64 encoded on both the consume and produce operations.
AUTO Attempt to automatically figure out the current topic's serialization format.
JSON Message will be serialized using the JSON format.
CSV Message will be serialized using the CSV format.
XML Message will be serialized using the XML format.
AVRO Message will be serialized using the Avro format.

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