package
0.4.0
Repository: https://github.com/conduitio/conduit-commons.git
Documentation: pkg.go.dev

# Functions

WithJSONMarshalOptions attaches JSONMarshalOptions to a context.

# Constants

MetadataCollection is a Record.Metadata key for the name of the collection where the record originated from and/or where it should be stored.
MetadataConduitDestinationPluginName is a Record.Metadata key for the name of the destination plugin that has written this record (only available in records once they are written by a destination).
MetadataConduitDestinationPluginVersion is a Record.Metadata key for the version of the destination plugin that has written this record (only available in records once they are written by a destination).
MetadataConduitDLQNackError is a Record.Metadata key for the error that caused a record to be nacked and pushed to the dead-letter queue.
MetadataConduitDLQNackNodeID is a Record.Metadata key for the ID of the internal node that nacked the record.
MetadataConduitSourceConnectorID is a Record.Metadata key for the ID of the source connector that produced this record.
MetadataConduitSourcePluginName is a Record.Metadata key for the name of the source plugin that created this record.
MetadataConduitSourcePluginVersion is a Record.Metadata key for the version of the source plugin that created this record.
MetadataCreatedAt is a Record.Metadata key for the time when the record was created in the 3rd party system.
MetadataKeySchemaSubject is a Record.Metadata key for the subject of the schema of the record's .Key field.
MetadataKeySchemaVersion is a Record.Metadata key for the version of the schema of the record's .Key field.
MetadataOpenCDCVersion is a Record.Metadata key for the version of the OpenCDC format (e.g.
MetadataPayloadSchemaSubject is a Record.Metadata key for the subject of the schema of the record's .Payload field.
MetadataPayloadSchemaVersion is a Record.Metadata key for the version of the schema of the record's .Payload field.
MetadataReadAt is a Record.Metadata key for the time when the record was read from the 3rd party system.
OpenCDCVersion is a constant that should be used as the value in the metadata field MetadataVersion.
create.
delete.
snapshot.
update.

# Variables

ErrInvalidProtoDataType is returned when trying to convert a proto data type to raw or structured data.
ErrMetadataFieldNotFound is returned in metadata utility functions when a metadata field is not found.
ErrUnknownOperation is returned when trying to parse an Operation string and encountering an unknown operation.

# Structs

No description provided by the author
JSONMarshalOptions can customize how a record is serialized to JSON.
Record represents a single data record produced by a source and/or consumed by a destination connector.

# Interfaces

Data is a structure that contains some bytes.
RecordSerializer is a type that can serialize a record to bytes.

# Type aliases

JSONSerializer is a RecordSerializer that serializes records to JSON using the configured options.
No description provided by the author
Operation defines what triggered the creation of a record.
Position is a unique identifier for a record being processed.
RawData contains unstructured data in form of a byte slice.
StructuredData contains data in form of a map with string keys and arbitrary values.