Skip to content

Commit 0a89877

Browse files
committed
document behavior of MultiRecord
1 parent 105cf0c commit 0a89877

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

processor.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,10 @@ func (e ErrorRecord) MarshalJSON() ([]byte, error) {
121121

122122
// MultiRecord is a record that contains multiple records. It is used to split a
123123
// record into multiple records in processors.
124+
// If the processor returns a MultiRecord with 0 records, it is the same as
125+
// returning a FilterRecord.
126+
// If the processor returns a MultiRecord with 1 record, it is the same as
127+
// returning a SingleRecord.
124128
type MultiRecord []opencdc.Record
125129

126130
func (MultiRecord) isProcessedRecord() {}

0 commit comments

Comments
 (0)