Protocol
Set annotations inside a transaction using the functionpg_logical_emit_message
:
Message prefixes
Prefix | Description |
---|---|
sequin:transaction_annotations.set | Sets annotations for all following changes in the current transaction |
sequin:transaction_annotations.clear | Clears annotations for all following changes in the current transaction |
Behavior
Scope
- Annotations are transaction-scoped
- They apply to all changes following the annotation within the transaction
- Setting new annotations overwrites previous annotations in the same transaction
Limitations
- Must be valid JSON
- Cannot be set outside a transaction
Message format
Annotations appear in themetadata.transaction_annotations
field of messages:
null
.