Debezium connector for JDBC
This connector is currently in an incubating state. In future versions, we might change the exact semantics, configuration options, and so forth, depending on the feedback that we receive. Please let us know if you encounter any problems. |
Overview
The Debezium JDBC connector is a Kafka Connect sink connector implementation that can consume events from multiple source topics, and then write those events to a relational database by using a JDBC driver. This connector supports a wide variety of database dialects, including Db2, MySQL, Oracle, PostgreSQL, and SQL Server.
How the JDBC connector works
The Debezium JDBC connector is a Kafka Connect sink connector, and therefore requires the Kafka Connect runtime. The connector periodically polls the Kafka topics that it subscribes to, consumes events from those topics, and then writes the events to the configured relational database. The connector supports idempotent write operations by using upsert semantics and basic schema evolution.
The following features are supported:
Consuming complex Debezium change events
By default, Debezium source connectors produce complex, hierarchical change events.
When Debezium connectors are used with other JDBC sink connector implementations, you might need to apply the ExtractNewRecordState
single message transformation (SMT) to flatten the payload of change events, so that they can be consumed by the sink implementation.
If you run the Debezium JDBC sink connector, it’s not necessary to deploy the SMT, because the Debezium sink connector can consume native Debezium change events directly, without the use of a transformation.
When the JDBC sink connector consumes a complex change event from a Debezium source connector, it extracts the values from the after
section of the original insert
or update
event.
When a delete event is consumed by the sink connector, no part of the event’s payload is consulted.
At-least-once delivery
The Debezium JDBC sink connector guarantees that events that is consumes from Kafka topics are processed at least once.
Multiple tasks
You can run the Debezium JDBC sink connector across multiple Kafka Connect tasks.
To run the connector across multiple tasks, set the tasks.max
configuration property to the number of tasks that you want the connector to use.
The Kafka Connect runtime starts the specified number of tasks, and runs one instance of the connector per task.
Multiple tasks can improve performance by reading and processing changes from multiple source topics in parallel.
Data and column type mappings
To enable the Debezium JDBC sink connector to correctly map the data type from an inbound message field to an outbound message field, the connector requires information about the data type of each field that is present in the source event.
The connector supports a wide range of column type mappings across different database dialects.
To correctly convert the destination column type from the type
metadata in an event field, the connector applies the data type mappings that are defined for the source database.
You can enhance the way that the connector resolves data types for a column by setting the column.propagate.source.type
or datatype.propagate.source.type
options in the source connector configuration.
When you enable these options, Debezium includes extra parameter metadata, which assists the JDBC sink connector in more accurately resolving the data type of destination columns.
For the Debezium JDBC sink connector to process events from a Kafka topic, the Kafka topic message key, when present, must be a primitive data type or a Struct
.
In addition, the payload of the source message must be a Struct
that has either a flattened structure with no nested struct
types, or a nested struct
layout that conforms to Debezium’s complex, hierarchical structure.
If the structure of the events in the Kafka topic do not adhere to these rules, you must implement a custom single message transformation to convert the structure of the source events into a usable format.
Primary key handling
By default, the Debezium JDBC sink connector does not transform any of the fields in the source event into the primary key for the event. Unfortunately, the lack of a stable primary key can complicate event processing, depending on your business requirements, or when the sink connector uses upsert semantics. To define a consistent primary key, you can configure the connector to use one of the primary key modes described in the following table:
Mode | Description |
---|---|
|
No primary key fields are specified when creating the table. |
|
The primary key consists of the following three columns:
The values for these columns are sourced from the coordinates of the Kafka event. |
|
The primary key is composed of the Kafka event’s key. |
|
The primary key is composed of the Kafka event’s value. |
Some database dialects might throw an exception if you set the
|
Delete mode
The Debezium JDBC sink connector can delete rows in the destination database when a DELETE
or tombstone event is consumed.
By default, the JDBC sink connector does not enable delete mode.
If you want to support removal of rows, explicitly enable it in the connector configuration by setting delete.enabled=true
in the connector configuration.
However, to use this mode you must set primary.key.fields
to a value other than none
.
The preceding configuration is necessary, because deletes are executed based on the primary key mapping, so if a destination table has no primary key mapping, the connector is unable to delete rows.
Idempotent writes
The Debezium JDBC sink connector supports idempotent writes, allowing the same records to be replayed repeatedly and the final database state to remain consistent.
In order to support idempotent writes, the JDBC sink connector must be explicitly configured with the insert.mode
set to upsert
.
An upsert
operation is applied as either an update
or an insert
, depending on whether the specified primary key already exists.
If the primary key value already exists, the operation updates values in the row.
If the specified primary key value doesn’t exist, an insert
adds a new row.
Each database dialect handles idempotent writes differently, because there is no SQL standard for upsert operations. The following illustrates the upsert database-specific DML syntax that is used by the supported database dialects:
Dialect | Upsert Syntax |
---|---|
Db2 |
|
MySQL |
|
Oracle |
|
PostgreSQL |
|
SQL Server |
|
Schema evolution
The Debezium JDBC sink connector supports the following schema evolution modes:
Mode | Description |
---|---|
|
The connector does not perform any DDL schema evolution. |
|
The connector automatically detects fields that are in the event payload but that do not exist in the destination table. The connector alters the destination table to add the new fields. |
When schema.evolution
is set to basic
, the connector automatically creates or alters the destination database table according to the structure of the incoming event.
When an event is received from a topic for the first time, and the destination table does not yet exist, the Debezium JDBC sink connector uses the event’s key, or the schema structure of the record to resolve the column structure of the table.
If schema evolution is enabled, the connector prepares and executes a CREATE TABLE
SQL statement before it applies the DML event to the destination table.
When the Debezium JDBC connector receives an event from a topic, if the schema structure of the record differs from the schema structure of the destination table, the connector uses either the event’s key or its schema structure to identify which columns are new, and must be added to the database table.
If schema evolution is enabled, the connector prepares and executes an ALTER TABLE
SQL statement before it applies the DML event to the destination table.
Because changing column data types, dropping columns, and adjusting primary keys can be considered dangerous operations, the connector is prohibited from performing these operations.
The schema of each field determines whether a column is NULL
or NOT NULL
.
The schema also defines the default values for each column.
If the connector attempts to create a table with a nullability setting or a default value that don’t want, you must either create the table manually, ahead of time, or adjust the schema of the associated field before the sink connector processes the event.
To adjust nullability settings or default values, you can introduce a custom single message transformation that applies changes in the pipeline, or modifies the column state defined in the source database.
A field’s data type is resolved based on a predefined set of mappings. For more information, see Data type mappings.
When you introduce new fields to the event structure of tables that already exist in the destination database, you must define the new fields as optional, or the fields must have a default value specified in the database schema. If you want a field to be removed from the destination table, use one of the following options:
|
Quoting and case sensitivity
The Debezium JDBC sink connector consumes Kafka messages by constructing either DDL (schema changes) or DML (data changes) SQL statements that are executed on the destination database. By default, the connector uses the names of the source topic and the event fields as the basis for the table and column names in the destination table. The constructed SQL does not automatically delimit identifiers with quotes to preserve the case of the original strings. As a result, by default, the text case of table or column names in the destination database depends entirely on how the database handles name strings when the case is not specified.
For example, if the destination database dialect is Oracle and the event’s topic is orders
, the destination table will be created as ORDERS
because Oracle defaults to upper-case names when the name is not quoted.
Similarly, if the destination database dialect is PostgreSQL and the event’s topic is ORDERS
, the destination table will be created as orders
because PostgreSQL defaults to lower-case names when the name is not quoted.
By setting quote.identifiers
to true
in the connector configuration, you can explicitly set the case of the table and field names to preserve the case that is present in the Kafka event.
So if the incoming event is for a topic called orders
and the destination database dialect is Oracle, if quoting is enabled — that is, if quote.identifiers
is set to true
— the connector creates a table with the name orders
, because the constructed SQL defines the name of the table as "orders"
.
When quoting is enabled, the behavior for creating column names works in the same manner.
Data type mappings
The Debezium JDBC sink connector resolves a column’s data type by using a logical or primitive type-mapping system.
Primitive types include values such as integers, floating points, Booleans, strings, and bytes.
Typically, these types are represented with a specific Kafka Connect Schema
type code only.
Logical data types are more often complex types, including values such as Struct
-based types that have a fixed set of field names and schema, or values that are represented with a specific encoding, such as number of days since epoch.
The following examples show representative structures of primitive and logical data types:
{
"schema": {
"type": "INT64"
}
}
[
"schema": {
"type": "INT64",
"name": "org.apache.kafka.connect.data.Date"
}
]
Kafka Connect is not the only source for these complex, logical types. In fact, Debezium source connectors generate change events that have fields with similar logical types to represent a variety of different data types, including but not limited to, timestamps, dates, and even JSON data.
The Debezium JDBC sink connector uses these primitive and logical types to resolve a column’s type to a JDBC SQL code, which represents a column’s type. These JDBC SQL codes are then used by the underlying Hibernate persistence framework to resolve the column’s type to a logical data type for the dialect in use. The following tables illustrate the primitive and logical mappings between Kafka Connect and JDBC SQL types, and between Debezium and JDBC SQL types. The actual final column type varies with for each database type.
Primitive Type | JDBC SQL Type |
---|---|
INT8 |
Types.TINYINT |
INT16 |
Types.SMALLINT |
INT32 |
Types.INTEGER |
INT64 |
Types.BIGINT |
FLOAT32 |
Types.FLOAT |
FLOAT64 |
Types.DOUBLE |
BOOLEAN |
Types.BOOLEAN |
STRING |
Types.CHAR, Types.NCHAR, Types.VARCHAR, Types.NVARCHAR |
BYTES |
Types.VARBINARY |
Logical Type | JDBC SQL Type |
---|---|
org.apache.kafka.connect.data.Decimal |
Types.DECIMAL |
org.apache.kafka.connect.data.Date |
Types.DATE |
org.apache.kafka.connect.data.Time |
Types.TIMESTAMP |
org.apache.kafka.connect.data.Timestamp |
Types.TIMESTAMP |
Logical Type | JDBC SQL Type |
---|---|
io.debezium.time.Date |
Types.DATE |
io.debezium.time.Time |
Types.TIMESTAMP |
io.debezium.time.MicroTime |
Types.TIMESTAMP |
io.debezium.time.NanoTime |
Types.TIMESTAMP |
io.debezium.time.ZonedTime |
Types.TIME_WITH_TIMEZONE |
io.debezium.time.Timestamp |
Types.TIMESTAMP |
io.debezium.time.MicroTimestamp |
Types.TIMESTAMP |
io.debezium.time.NanoTimestamp |
Types.TIMESTAMP |
io.debezium.time.ZonedTimestamp |
Types.TIMESTAMP_WITH_TIMEZONE |
io.debezium.data.VariableScaleDecimal |
Types.DOUBLE |
If the database does not support time or timestamps with time zones, the mapping resolves to its equivalent without timezones. |
Logical Type | MySQL SQL Type | PostgreSQL SQL Type | SQL Server SQL Type |
---|---|---|---|
io.debezium.data.Bits |
|
|
|
io.debezium.data.Enum |
|
Types.VARCHAR |
n/a |
io.debezium.data.Json |
|
|
n/a |
io.debezium.data.EnumSet |
|
n/a |
n/a |
io.debezium.time.Year |
|
n/a |
n/a |
io.debezium.time.MicroDuration |
n/a |
|
n/a |
io.debezium.data.Ltree |
n/a |
|
n/a |
io.debezium.data.Uuid |
n/a |
|
n/a |
io.debezium.data.Xml |
n/a |
|
|
In addition to the primitive and logical mappings above, if the source of the change events is a Debezium source connector, the resolution of the column type, along with its length, precision, and scale, can be further influenced by enabling column or data type propagation. To enforce propagation, one of the following properties must be set in the source connector configuration:
-
column.propagate.source.type
-
datatype.propagate.source.type
The Debezium JDBC sink connector applies the values with the higher precedence.
For example, let’s say the following field schema is included in a change event:
{
"schema": {
"type": "INT8",
"parameters": {
"__debezium.source.column.type": "TINYINT",
"__debezium.source.column.length": "1"
}
}
}
In the preceding example, if no schema parameters are set, the Debezium JDBC sink connector would map this field to a column type of Types.SMALLINT
.
Types.SMALLINT
can have different logical database types, depending on the database dialect.
For MySQL, the example would convert to a TINYINT
column type with no specified length.
If column or data type propagation is enabled for the source connector, the Debezium JDBC sink connector uses the mapping information to refine the data type mapping process and create a column with the type TINYINT(1)
.
Typically, the effect of using column or data type propagation is much greater when the same type of database is used for both the source and sink database. We are continually looking at ways to improve this mapping across heterogeneous databases and the current type system allows us to continue to refine these mappings based on feedback. If you find a mapping could be improved, please let us know. |
Deployment
To deploy a Debezium JDBC connector, you install the Debezium JDBC connector archive, configure the connector, and start the connector by adding its configuration to Kafka Connect.
-
Apache ZooKeeper, Apache Kafka, and Kafka Connect are installed.
-
Destination database is installed and configured to accept JDBC connections.
-
Download the Debezium JDBC connector plug-in archive.
-
Extract the files into your Kafka Connect environment.
-
Optionally download the JDBC driver from Maven Central and extract the downloaded driver file to the directory that contains the JDBC sink connector JAR file.
Drivers for Oracle and Db2 are not automatically shipped with the JDBC sink connector and must be manually installed. -
Add the driver JAR files to the path where the JDBC sink connector has been installed.
-
Make sure that the path where the JDBC sink connector is installed is part of Kafka Connect’s
plugin.path
. -
Restart your Kafka Connect process to pick up the new JAR files.
Debezium JDBC connector configuration
Typically, you register a Debezium JDBC connector by submitting a JSON request that specifies the configuration properties for the connector.
The following example shows a JSON request for registering an instance of the Debezium JDBC sink connector that consumes events from a topic called orders
with the most common configuration settings:
{
"name": "jdbc-connector", (1)
"config": {
"connector.class": "io.debezium.connector.jdbc.JdbcSinkConnector", (2)
"tasks.max": "1", (3)
"connection.url": "jdbc:postgresql://localhost/db", (4)
"connection.username": "pguser", (5)
"connection.password": "pgpassword", (6)
"insert.mode": "upsert", (7)
"delete.enabled": "true", (8)
"primary.key.mode": "record_key", (9)
"schema.evolution": "basic", (10)
"database.time_zone": "UTC" (11)
}
}
1 | The name that is assigned to the connector when you register it with Kafka Connect service. |
2 | The name of the JDBC sink connector class. |
3 | The maximum number of tasks to create for this connector. |
4 | The JDBC URL that the connector uses to connect to the sink database that it writes to. |
5 | The name of the database user used for authentication. |
6 | The password of the database user used for authentication. |
7 | The insert.mode that the connector uses. |
8 | Enables the deletion of records in the database. For more information, see the delete.enabled configuration property. |
9 | Specifies the method used to resolve primary key columns. For more information, see the primary.key.mode configuration property. |
10 | Enables the connector to evolve the destination database’s schema. For more information, see the schema.evolution configuration property. |
11 | Specifies the timezone used when writing temporal field types. |
For a complete list of configuration properties that you can set for the Debezium JDBC connector, see JDBC connector properties.
You can send this configuration with a POST
command to a running Kafka Connect service.
The service records the configuration and starts a sink connector task(s) that performs the following operations:
-
Connects to the database.
-
Consumes events from subscribed Kafka topics.
-
Writes the events to the configured database.
Connector properties
The Debezium JDBC sink connector has several configuration properties that you can use to achieve the connector behavior that meets your needs. Many properties have default values. Information about the properties is organized as follows:
Property | Default | Description |
---|---|---|
No default |
The JDBC connection URL used to connect to the database. |
|
No default |
The name of the database user account that the connector uses to connect to the database. |
|
No default |
The password that the connector uses to connect to the database. |
|
|
Specifies the minimum number of connections in the pool. |
|
|
Specifies the maximum number of concurrent connections that the pool maintains. |
|
|
Specifies the number of connections that the connector attempts to acquire if the connection pool exceeds its maximum size. |
|
|
Specifies the number of seconds that an unused connection is kept before it is discarded. |
Property | Default | Description |
---|---|---|
|
Specifies the timezone used when inserting JDBC temporal values. |
|
|
Specifies whether the connector processes |
|
|
Specifies the strategy used to insert events into the database. The following options are available:
|
|
|
Specifies how the connector resolves the primary key columns from the event.
|
|
No default |
Either the name of the primary key column or a comma-separated list of fields to derive the primary key from. |
|
|
Specifies whether generated SQL statements use quotation marks to delimit table and column names. See the Quoting and case sensitivity section for more details. |
|
|
Specifies how the connector evolves the destination table schemas. For more information, see Schema evolution. The following options are available:
|
|
|
Specifies a string that determines how the destination table name is formatted, based on the topic name of the event.
The placeholder, |
Property | Default | Description |
---|---|---|
|
Specifies the fully-qualified class name of a |
|
|
Specifies the fully-qualified class name of a
|
Frequently asked questions
- Is the
ExtractNewRecordState
single message transformation required? -
No, that is actually one of the differentiating factors of the Debezium JDBC connector from other implementations. While the connector is capable of ingesting flattened events like its competitors, it can also ingest Debezium’s complex change event structure natively, without requiring any specific type of transformation.
- If a column’s type is changed, or if a column is renamed or dropped, is this handled by schema evolution?
-
No, the Debezium JDBC connector does not make any changes to existing columns. The schema evolution supported by the connector is quite basic. It simply compares the fields in the event structure to the table’s column list, and then adds any fields that are not yet defined as columns in the table. If a column’s type or default value change, the connector does not adjust them in the destination database. If a column is renamed, the old column is left as-is, and the connector appends a column with the new name to the table; however existing rows with data in the old column remain unchanged. These types of schema changes should be handled manually.
- If a column’s type does not resolve to the type that I want, how can I enforce mapping to a different data type?
-
The Debezium JDBC connector uses a sophisticated type system to resolve a column’s data type. For details about how this type system resolves a specific field’s schema definition to a JDBC type, see the Data and column type mappings section. If you want to apply a different data type mapping, define the table manually to explicitly obtain the preferred column type.
- How do you specify a prefix or a suffix to the table name without changing the Kafka topic name?
-
In order to add a prefix or a suffix to the destination table name, adjust the table.name.format connector configuration property to apply the prefix or suffix that you want. For example, to prefix all table names with
jdbc_
, specify thetable.name.format
configuration property with a value ofjdbc_${topic}
. If the connector is subscribed to a topic calledorders
, the resulting table is created asjdbc_orders
. - Why are some columns automatically quoted, even though identifier quoting is not enabled?
-
In some situations, specific column or table names might be explicitly quoted, even when
quote.identifiers
is not enabled. This is often necessary when the column or table name starts with or uses a specific convention that would otherwise be considered illegal syntax. For example, when the primary.key.mode is set tokafka
, some databases only permit column names to begin with an underscore if the column’s name is quoted. Quoting behavior is dialect-specific, and varies among different types of database.