impl

p := NewCloneProcessor(log.Nop())

exampleutil.RunExample(p, exampleutil.Example{
	Summary:     "Clone record into multiple records",
	Description: "This example takes a record and clones it once, producing 2 records, each containing the same data, except for the metadata field `clone.index`.",
	Config:      config.Config{"count": "1"},
	Have: opencdc.Record{
		Operation: opencdc.OperationCreate,
		Metadata:  map[string]string{"foo": "bar"},
		Key:       opencdc.StructuredData{"id": 123},
		Payload: opencdc.Change{After: opencdc.StructuredData{
			"name": "Alice",
			"age":  30,
		}},
	},
	Want: sdk.MultiRecord{
		opencdc.Record{
			Operation: opencdc.OperationCreate,
			Metadata: map[string]string{
				"foo":         "bar",
				"clone.index": "0",
			},
			Key: opencdc.StructuredData{"id": 123},
			Payload: opencdc.Change{After: opencdc.StructuredData{
				"name": "Alice",
				"age":  30,
			}},
		},
		opencdc.Record{
			Operation: opencdc.OperationCreate,
			Metadata: map[string]string{
				"foo":         "bar",
				"clone.index": "1",
			},
			Key: opencdc.StructuredData{"id": 123},
			Payload: opencdc.Change{After: opencdc.StructuredData{
				"name": "Alice",
				"age":  30,
			}},
		},
	},
})

Output:

processor transformed record:
--- before
+++ after
@@ -1,17 +1,38 @@
-{
+[
+  {
-  "position": null,
+    "position": null,
-  "operation": "create",
+    "operation": "create",
-  "metadata": {
+    "metadata": {
-    "foo": "bar"
+      "clone.index": "0",
+      "foo": "bar"
+    },
+    "key": {
+      "id": 123
+    },
+    "payload": {
+      "before": null,
+      "after": {
+        "age": 30,
+        "name": "Alice"
+      }
+    }
+  },
+  {
+    "position": null,
+    "operation": "create",
+    "metadata": {
+      "clone.index": "1",
+      "foo": "bar"
-  },
+    },
-  "key": {
+    "key": {
-    "id": 123
+      "id": 123
-  },
+    },
-  "payload": {
+    "payload": {
-    "before": null,
+      "before": null,
-    "after": {
+      "after": {
-      "age": 30,
+        "age": 30,
-      "name": "Alice"
+        "name": "Alice"
-    }
+      }
-  }
+    }
-}
+  }
+]

p := NewErrorProcessor(log.Nop())

exampleutil.RunExample(p, exampleutil.Example{
	Summary: `Error record with custom error message`,
	Description: `This example shows how to configure the error processor to
return a custom error message for a record using a Go template.`,
	Config: config.Config{
		"message": "custom error message with data from record: {{.Metadata.foo}}",
	},
	Have: opencdc.Record{
		Operation: opencdc.OperationCreate,
		Metadata:  map[string]string{"foo": "bar"},
		Payload:   opencdc.Change{After: opencdc.StructuredData{"foo": "bar"}, Before: opencdc.StructuredData{"bar": "baz"}},
	},
	Want: sdk.ErrorRecord{
		Error: cerrors.New("custom error message with data from record: bar"),
	},
})

Output:

processor returned error: custom error message with data from record: bar

p := NewFilterProcessor(log.Nop())

exampleutil.RunExample(p, exampleutil.Example{
	Summary: `Filter out the record`,
	Config:  config.Config{},
	Have: opencdc.Record{
		Operation: opencdc.OperationCreate,
		Metadata:  map[string]string{"key1": "val1"},
		Payload:   opencdc.Change{After: opencdc.StructuredData{"foo": "bar"}, Before: opencdc.StructuredData{"bar": "baz"}},
	},
	Want: sdk.FilterRecord{},
})

Output:

processor filtered record out

p := NewSplitProcessor(log.Nop())

exampleutil.RunExample(p, exampleutil.Example{
	Summary:     "Split array into multiple records",
	Description: "This example takes the array in field `.Payload.After.users` and splits it into separate records, each containing one element.",
	Config:      config.Config{"field": ".Payload.After.users"},
	Have: opencdc.Record{
		Operation: opencdc.OperationUpdate,
		Key:       opencdc.StructuredData{"id": 123},
		Payload: opencdc.Change{After: opencdc.StructuredData{
			"users": []map[string]any{
				{"name": "Alice", "age": 30},
				{"name": "Bob", "age": 25},
				{"name": "Charlie", "age": 35},
			},
		}},
	},
	Want: sdk.MultiRecord{
		opencdc.Record{
			Operation: opencdc.OperationUpdate,
			Metadata:  map[string]string{"split.index": "0"},
			Key:       opencdc.StructuredData{"id": 123},
			Payload: opencdc.Change{After: opencdc.StructuredData{
				"users": map[string]any{"name": "Alice", "age": 30},
			}},
		},
		opencdc.Record{
			Operation: opencdc.OperationUpdate,
			Metadata:  map[string]string{"split.index": "1"},
			Key:       opencdc.StructuredData{"id": 123},
			Payload: opencdc.Change{After: opencdc.StructuredData{
				"users": map[string]any{"name": "Bob", "age": 25},
			}},
		},
		opencdc.Record{
			Operation: opencdc.OperationUpdate,
			Metadata:  map[string]string{"split.index": "2"},
			Key:       opencdc.StructuredData{"id": 123},
			Payload: opencdc.Change{After: opencdc.StructuredData{
				"users": map[string]any{"name": "Charlie", "age": 35},
			}},
		},
	},
})

Output:

processor transformed record:
--- before
+++ after
@@ -1,27 +1,59 @@
-{
+[
+  {
-  "position": null,
+    "position": null,
-  "operation": "update",
+    "operation": "update",
-  "metadata": null,
+    "metadata": {
+      "split.index": "0"
+    },
-  "key": {
+    "key": {
-    "id": 123
+      "id": 123
-  },
+    },
-  "payload": {
-    "before": null,
-    "after": {
-      "users": [
-        {
-          "age": 30,
-          "name": "Alice"
-        },
-        {
-          "age": 25,
+    "payload": {
+      "before": null,
+      "after": {
+        "users": {
+          "age": 30,
+          "name": "Alice"
+        }
+      }
+    }
+  },
+  {
+    "position": null,
+    "operation": "update",
+    "metadata": {
+      "split.index": "1"
+    },
+    "key": {
+      "id": 123
+    },
+    "payload": {
+      "before": null,
+      "after": {
+        "users": {
+          "age": 25,
+          "name": "Bob"
+        }
+      }
+    }
+  },
+  {
+    "position": null,
+    "operation": "update",
+    "metadata": {
+      "split.index": "2"
+    },
+    "key": {
+      "id": 123
+    },
+    "payload": {
+      "before": null,
-          "name": "Bob"
+      "after": {
-        },
-        {
+        "users": {
           "age": 35,
           "name": "Charlie"
         }
-      ]
+      }
     }
   }
-}
+]