[Schemas] Add subject, version to metadata, remove ID (#67)

opencdc/errors.go

@@ -25,7 +25,6 @@ var (
 	// ErrUnknownOperation is returned when trying to parse an Operation string
 	// and encountering an unknown operation.
 	ErrUnknownOperation = errors.New("unknown operation")
-
 	// ErrInvalidProtoDataType is returned when trying to convert a proto data
 	// type to raw or structured data.
 	ErrInvalidProtoDataType = errors.New("invalid proto data type")

opencdc/metadata.go

@@ -43,12 +43,20 @@ const (
 	// MetadataCollection is a Record.Metadata key for the name of the collection
 	// where the record originated from and/or where it should be stored.
 	MetadataCollection = "opencdc.collection"
-	// MetadataSchemaID is a Record.Metadata key for the ID of the schema of
-	// the record's .Payload.After field.
-	MetadataSchemaID = "opencdc.schema.id"
-	// MetadataSchemaType is a Record.Metadata key for the type of the schema of
-	// the record's .Payload.After field.
-	MetadataSchemaType = "opencdc.schema.type"
+
+	// MetadataKeySchemaSubject is a Record.Metadata key for the subject of the schema of
+	// the record's .Key field.
+	MetadataKeySchemaSubject = "opencdc.key.schema.subject"
+	// MetadataKeySchemaVersion is a Record.Metadata key for the version of the schema of
+	// the record's .Key field.
+	MetadataKeySchemaVersion = "opencdc.key.schema.version"
+
+	// MetadataPayloadSchemaSubject is a Record.Metadata key for the subject of the schema of
+	// the record's .Payload field.
+	MetadataPayloadSchemaSubject = "opencdc.payload.schema.subject"
+	// MetadataPayloadSchemaVersion is a Record.Metadata key for the version of the schema of
+	// the record's .Payload field.
+	MetadataPayloadSchemaVersion = "opencdc.payload.schema.version"
 
 	// MetadataConduitSourcePluginName is a Record.Metadata key for the name of
 	// the source plugin that created this record.
@@ -241,26 +249,68 @@ func (m Metadata) SetConduitDLQNackNodeID(id string) {
 	m[MetadataConduitDLQNackNodeID] = id
 }
 
-// GetSchemaID returns the value for key MetadataSchemaID.
+// GetKeySchemaSubject returns the value for key MetadataKeySchemaSubject.
+// If the value does not exist or is empty the function returns ErrMetadataFieldNotFound.
+func (m Metadata) GetKeySchemaSubject() (string, error) {
+	return m.getValue(MetadataKeySchemaSubject)
+}
+
+// SetKeySchemaSubject sets the metadata value for key MetadataKeySchemaSubject.
+func (m Metadata) SetKeySchemaSubject(subject string) {
+	m[MetadataKeySchemaSubject] = subject
+}
+
+// GetKeySchemaVersion returns the value for key MetadataKeySchemaVersion.
+// If the value does not exist or is empty the function returns ErrMetadataFieldNotFound.
+func (m Metadata) GetKeySchemaVersion() (int, error) {
+	vs, err := m.getValue(MetadataKeySchemaVersion)
+	if err != nil {
+		return 0, err
+	}
+
+	v, err := strconv.Atoi(vs)
+	if err != nil {
+		return 0, fmt.Errorf("invalid version %q: %w", vs, err)
+	}
+
+	return v, nil
+}
+
+// SetKeySchemaVersion sets the metadata value for key MetadataKeySchemaVersion.
+func (m Metadata) SetKeySchemaVersion(version int) {
+	m[MetadataKeySchemaVersion] = strconv.Itoa(version)
+}
+
+// GetPayloadSchemaSubject returns the value for key MetadataPayloadSchemaSubject.
 // If the value does not exist or is empty the function returns ErrMetadataFieldNotFound.
-func (m Metadata) GetSchemaID() (string, error) {
-	return m.getValue(MetadataSchemaID)
+func (m Metadata) GetPayloadSchemaSubject() (string, error) {
+	return m.getValue(MetadataPayloadSchemaSubject)
 }
 
-// SetSchemaID sets the metadata value for key MetadataSchemaID.
-func (m Metadata) SetSchemaID(id string) {
-	m[MetadataSchemaID] = id
+// SetPayloadSchemaSubject sets the metadata value for key MetadataPayloadSchemaSubject.
+func (m Metadata) SetPayloadSchemaSubject(subject string) {
+	m[MetadataPayloadSchemaSubject] = subject
 }
 
-// GetSchemaType returns the value for key MetadataSchemaType.
+// GetPayloadSchemaVersion returns the value for key MetadataPayloadSchemaVersion.
 // If the value does not exist or is empty the function returns ErrMetadataFieldNotFound.
-func (m Metadata) GetSchemaType() (string, error) {
-	return m.getValue(MetadataSchemaType)
+func (m Metadata) GetPayloadSchemaVersion() (int, error) {
+	vs, err := m.getValue(MetadataPayloadSchemaVersion)
+	if err != nil {
+		return 0, err
+	}
+
+	v, err := strconv.Atoi(vs)
+	if err != nil {
+		return 0, fmt.Errorf("invalid version %q: %w", vs, err)
+	}
+
+	return v, nil
 }
 
-// SetSchemaType sets the metadata value for key MetadataSchemaType.
-func (m Metadata) SetSchemaType(typeStr string) {
-	m[MetadataSchemaType] = typeStr
+// SetPayloadSchemaVersion sets the metadata value for key MetadataPayloadSchemaVersion.
+func (m Metadata) SetPayloadSchemaVersion(version int) {
+	m[MetadataPayloadSchemaVersion] = strconv.Itoa(version)
 }
 
 // getValue returns the value for a specific key. If the value does not exist or

opencdc/metadata_test.go

@@ -25,13 +25,15 @@ import (
 
 func TestMetadataConstants(t *testing.T) {
 	wantMapping := map[string]*protoimpl.ExtensionInfo{
-		OpenCDCVersion:         opencdcv1.E_OpencdcVersion,
-		MetadataOpenCDCVersion: opencdcv1.E_MetadataVersion,
-		MetadataCreatedAt:      opencdcv1.E_MetadataCreatedAt,
-		MetadataReadAt:         opencdcv1.E_MetadataReadAt,
-		MetadataCollection:     opencdcv1.E_MetadataCollection,
-		MetadataSchemaID:       opencdcv1.E_MetadataSchemaId,
-		MetadataSchemaType:     opencdcv1.E_MetadataSchemaType,
+		OpenCDCVersion:               opencdcv1.E_OpencdcVersion,
+		MetadataOpenCDCVersion:       opencdcv1.E_MetadataVersion,
+		MetadataCreatedAt:            opencdcv1.E_MetadataCreatedAt,
+		MetadataReadAt:               opencdcv1.E_MetadataReadAt,
+		MetadataCollection:           opencdcv1.E_MetadataCollection,
+		MetadataKeySchemaSubject:     opencdcv1.E_MetadataKeySchemaSubject,
+		MetadataKeySchemaVersion:     opencdcv1.E_MetadataKeySchemaVersion,
+		MetadataPayloadSchemaSubject: opencdcv1.E_MetadataPayloadSchemaSubject,
+		MetadataPayloadSchemaVersion: opencdcv1.E_MetadataPayloadSchemaVersion,
 
 		MetadataConduitSourcePluginName:         metadatav1.E_MetadataConduitSourcePluginName,
 		MetadataConduitSourcePluginVersion:      metadatav1.E_MetadataConduitSourcePluginVersion,