Important
You are viewing documentation for an older version of Confluent Platform. For the latest, click here.
TombstoneHandler¶
The following provides usage information for the Confluent SMT
io.confluent.connect.transforms.TombstoneHandler.
Description¶
Manage tombstone records. A tombstone record is defined as a record with the entire value field being null, whether or not it has ValueSchema.
Installation¶
This transformation is developed by Confluent and does not ship by default with Kafka or Confluent Platform. You can install this transformation via the Confluent Hub Client:
confluent-hub install confluentinc/connect-transforms:latest
Examples¶
The configuration snippets below show how to use and configure the Tombstone
SMT.
transforms=tombstoneHandlerExample
# Use the default (warn) behavior to handle tombstone records, which
# ignores the tombstone silently and writes a WARN message to log.
transforms.tombstoneHandlerExample.type=io.confluent.connect.transforms.TombstoneHandler
# Use the ignore behavior to handle tombstone records, which ignores
# the tombstone silently and writes a DEBUG message to log.
transforms.tombstoneHandlerExample.type=io.confluent.connect.transforms.TombstoneHandler
transforms.tombstoneHandlerExample.behavior=ignore
# Use the fail behavior to handle tombstone records, which fails the
# execution, throws a ``DataException``, and writes a DEBUG message to log.
transforms.tombstoneHandlerExample.type=io.confluent.connect.transforms.TombstoneHandler
transforms.tombstoneHandlerExample.behavior=fail
Properties¶
| Name | Description | Type | Default | Valid Values | Importance |
|---|---|---|---|---|---|
behavior |
If set to ignore, the tombstone
record is ignored silently, with a DEBUG message written to log.
If set to warn, the tombstone record is ignored silently,
with a WARN message written to log. If set to fail, the execution
fails, a DataException is thrown, and a DEBUG message is
written to log. |
string | warn | [ignore, warn, fail] | medium |