All notable changes are documented in this file. Release numbers follow Semantic Versioning
November 15th, 2017 Detailed release notes
- Log current position in MySQL binlog to simplify debugging DBZ-401
- Support PostgreSQL 10 DBZ-424
- Create a Docker image for PostgreSQL 10 DBZ-426
- Add example for using Avro messages DBZ-430
- Make postGIS dependency optional DBZ-445
- Avro console-consumer example in docs DBZ-458
- Docker micro version tags (e.g., 0.6.1) DBZ-418
- Create a CI job for testing with PostgreSQL 10 DBZ-427
- Upgrade dependencies in Docker images to match Kafka 0.11.0.1 DBZ-450
- Timestamp field not handle time zone correctly DBZ-260
- This issue finally fixes a long standing bug in timestamp timezone handling. If there is a client that was depending on this bug to provide value without the correct offset then it has to be fixed.
- Connector fails and stops when coming across corrupt event DBZ-217
- [Postgres] Interval column causes exception during handling of DELETE DBZ-259
- The scope of the Kafka Connect dependency should be "provided" DBZ-285
- KafkaCluster#withKafkaConfiguration() does not work DBZ-323
- MySQL connector "initial_only" snapshot mode results in CPU spike from ConnectorTask polling DBZ-396
- Allow to omit COLUMN word in ALTER TABLE MODIFY/ALTER/CHANGE DBZ-412
- MySQL connector should handle stored procedure definitions DBZ-415
- Support constraints without name in DDL statement DBZ-419
- Short field not null throw an exception DBZ-422
- ALTER TABLE cannot change default value of column DBZ-425
- DDL containing text column with length specification cannot be parsed DBZ-428
- Integer column with negative default value causes MySQL connector to crash DBZ-429
- MySQL procedure parser handles strings and keywords as same tokens DBZ-437
- Mongo initial sync misses records with initial.sync.max.threads > 1 DBZ-438
- Can't parse DDL containing PRECISION clause without parameters DBZ-439
- Task restart triggers MBean to register twice DBZ-447
- Remove slowness in KafkaDatabaseHistoryTest DBZ-456
October 26th, 2017 Detailed release notes
- Support for UNSIGNED BIGINT to not be treated as byte[] DBZ-363
- Make Debezium build on Java 9 DBZ-227
- Add a test for "PAGE_CHECKSUM" DDL option DBZ-336
- Provide tutorial Docker Compose files for MongoDB and Postgres DBZ-361
- Upgrade to latest Kafka 0.11.x DBZ-367
- Prevent warning when building the plug-ins DBZ-370
- Replace hard-coded version references with variables DBZ-371
- Upgrade to latest version of mysql-binlog-connector-java DBZ-398
- Create wal2json CI job DBZ-403
- Travis jobs tests are failing due to Postgres DBZ-404
There should be no breaking changes in this relese.
- Avoid NullPointerException when closing MySQL connector after another error DBZ-378
- RecordsStreamProducer#streamChanges() can die on an exception without failing the connector DBZ-380
- Encoding to JSON does not support all MongoDB types DBZ-385
- MySQL connector does not filter out DROP TEMP TABLE statements from DB history topic DBZ-395
- Binlog Reader is registering MXBean when using "initial_only" snapshot mode DBZ-402
- A column named
column
, even when properly escaped, causes exception DBZ-408
September 21st, 2017 Detailed release notes
- Use new Kafka 0.10 properties for listeners and advertised listeners DBZ-39
- Add docker-compose handling for Debezium tutorial DBZ-127
- Topic configuration requirements are not clearly documented DBZ-241
- Upgrade Docker images to Kafka 0.11.0.0 DBZ-305
- Add SMT implementation to convert CDC event structure to more traditional row state structure DBZ-226
- Support SSL connection to Mongodb DBZ-343
- Support DEC and FIXED type for mysql ddl parser DBZ-359
This release includes the following change that affects existing installations that captures MongoDB
- Add support for different mongodb _id types in key struct DBZ-306
- MySQL snapshotter is not guaranteed to give a consistent snapshot DBZ-210
- MySQL connector stops consuming data from binlog after server restart DBZ-219
- Warnings and notifications from PostgreSQL are ignored by the connector DBZ-279
- BigDecimal has mismatching scale value for given Decimal schema error. DBZ-318
- Views in database stop PostgreSQL connector DBZ-319
- Don't pass database history properties to the JDBC connection DBZ-333
- Sanitize readings from database history topic DBZ-341
- Support UNION for ALTER TABLE DBZ-346
- Debezium fails to start when schema history topic contains unparseable SQL DBZ-347
- JDBC Connection is not closed after schema refresh DBZ-356
- MySQL integration tests should have completely isolated environment and configuration/setup files DBZ-304
August 17, 2017 Detailed release notes
- Mongo Connector: Add "database.whitelist" and "database.blacklist" configuration options DBZ-302
- Provide a Dockerfile to build images from latest released snapshot DBZ-320
- Support decimal handling mode for Postgres DBZ-337
- Enable and show usage of Avro converters DBZ-271
- Keep TCP connection alive for Postgres DBZ-286
- Support "PAGE_CHECKSUM=1" option for MySQL tables DBZ-324
There should be no breaking changes in this release.
- Images cannot run on OpenShift online DBZ-267
- NPE when processing null value in POINT column DBZ-284
- Postgres Connector: error of mismatching scale value for Decimal and Numeric data types DBZ-287
- Postgres connector fails with array columns DBZ-297
- Postgres connector fails with quoted type names DBZ-298
- LogicalTableRouter SMT uses wrong comparison for validation DBZ-326
- LogicalTableRouter SMT has a broken key replacement validation DBZ-327
- Pre-compile and simplify some regular expressions DBZ-311
- JMX metrics for MySQL connector should be documented DBZ-293
- PostgreSQL integration tests should have completely isolated environment and configuration/setup files DBZ-301
- Move snapshot Dockerfile into separated directory DBZ-321
- Cover ByLogicalTableRouter SMT in reference documentation DBZ-325
- Add documentation for JDBC url pass-through properties DBZ-330
June 9, 2017 - Detailed release notes
- MySQL Connector should support 'Point' data type DBZ-222
- Support tstzrange column type on Postgres DBZ-280
This release includes the following change that affect existing installations which capture system tables:
- MySQL connector should apply database and table filters to system dbs/tables DBZ-242
- Control how Debezium connectors maps tables to topics for sharding and other use cases DBZ-121
- MySqlConnector Table and Database recommenders cause timeouts on large instances DBZ-232
- Option to disable SSL certificate validation for PostgreSQL DBZ-244
- Let enum types implement EnumeratedValue DBZ-262
- The MySQL connector is failing with the DDL statements. DBZ-198
- Correct MongoDB build DBZ-213
- MongoDB connector should handle new primary better DBZ-214
- Validate that database.server.name and database.history.kafka.topic have different values DBZ-215
- When restarting Kafka Connect, we get io.debezium.text.ParsingException DBZ-216
- Postgres connector crash on a database managed by Django DBZ-223
- MySQL Connector doesn't handle any value above '2147483647' for 'INT UNSIGNED' types DBZ-228
- MySqlJdbcContext#userHasPrivileges() is broken for multiple privileges DBZ-229
- Postgres Connector does not work when "sslmode" is "require" DBZ-238
- Test PostgresConnectorIT.shouldSupportSSLParameters is incorrect DBZ-245
- Recommender and default value broken for EnumeratedValue type DBZ-246
- PG connector is CPU consuming DBZ-250
- MySQL tests are interdependent DBZ-251
- MySQL DDL parser fails on "ANALYZE TABLE" statement DBZ-253
- Binary fields with trailing "00" are truncated DBZ-254
- Enable Maven repository caching on Travis DBZ-274
- Memory leak and excessive CPU usage when using materialized views DBZ-277
- Postgres task should fail when connection to server is lost DBZ-281
- Fix some wrong textual descriptions of default values DBZ-282
- Apply consistent default value for Postgres port DBZ-237
- Make Docker images run on OpenShift DBZ-240
- Don't mention default value for "database.server.name" DBZ-243
March 27, 2017 - Detailed release notes
None
This release includes the following changes that are likely to affect existing installations:
- Upgraded from Kafka 0.10.1.1 to 0.10.2.0. DBZ-203
This release includes the following fixes, changes, or improvements since the 0.4.1 release:
- MySQL connector now better handles DDL statements with
BEGIN...END
blocks, especially those that useIF()
functions as well asCASE...WHEN
statements. DBZ-198 - MySQL connector handles 2-digit years in
DATETIME
,DATE
,TIMESTAMP
, andYEAR
columns in the same way as MySQL. DBZ-205
March 17, 2017 - Detailed release notes
- Improved support for Amazon RDS and Amazon Aurora (MySQL compatibility). DBZ-140
None
This release includes the following fixes, changes, or improvements since the 0.4.0 release:
- MySQL connector now allows filtering production of DML events by GTIDs. DBZ-188
- Support InnoDB savepoints. DBZ-196
- Corrected MySQL DDL parser. DBZ-193 DBZ-198
- Improved handling of MySQL connector's built-in tables. DBZ-194
- MySQL connector properly handles invalid/blank enum literal values. DBZ-197
- MySQL connector properly handles reserved names as column names. DBZ-200
- MongoDB connector properly generates event keys based upon ObjectID for updates. DBZ-201
February 7, 2017 - Detailed release notes
- New PostgreSQL connector. DBZ-3
- Preliminary support for Amazon RDS and Amazon Aurora (MySQL compatibility). DBZ-140
None
This release includes the following fixes, changes, or improvements since the 0.3.6 release:
- Update Kafka dependencies to 0.10.1.1. DBZ-173
- Update MySQL binary log client library to 0.9.0. DBZ-186
- MySQL should apply GTID filters to database history. DBZ-185
- Add names of database and table to the MySQL event metadata. DBZ-184
- Add the MySQL thread ID to the MySQL event metadata. DBZ-113
- Corrects MySQL connector to properly handle timezone information for
TIMESTAMP
. DBZ-183 - Correct MySQL DDL parser to handle
CREATE TRIGGER
command withDEFINER
clauses. DBZ-176 - Update MongoDB Java driver and MongoDB server versions. DBZ-187
- MongoDB connector should restart incomplete initial sync. DBZ-182
- MySQL and PostgreSQL connectors should load JDBC driver independently of DriverManager. DBZ-177
- Upgrade MySQL binlog client library to support new binlog events added with MySQL 5.7. DBZ-174
- EmbeddedEngine should log all errors. DBZ-178
- PostgreSQL containers' generated Protobuf source moved to separate directory. DBZ-179
December 21, 2016 - Detailed release notes
None
None
This release includes the following fixes since the 0.3.5 release:
- Deleting a Debezium connector in Kafka Connect no longer causes NPEs. DBZ-138
- MongoDB connector properly connects to a sharded cluster and the primaries for each replica set. DBZ-170, DBZ-167
- Stopping the MySQL connector while in the middle of a snapshot now cloasses all MySQL resources. DBZ-166
- MySQL connector properly parses with
ON UPDATE
timestamp values. DBZ-169 - MySQL connector ignores
CREATE FUNCTION
DDL statements. DBZ-162 - MySQL connector properly parses
CREATE TABLE
script with ENUM type and default value 'b'. [DBZ-160]https://issues.jboss.org/projects/DBZ/issues/DBZ-160) - MySQL connector now properly supports
NVARCHAR
columns. DBZ-142 - MySQL connector's snapshot process now uses
SHOW TABLE STATUS ...
rather thanSELECT COUNT(\*)
to obtain an estimate of the number of rows for each table, and can even forgo this step if all tables are to be streamed. DBZ-152 - MySQL connector's snaphot process ignores "artificial" database names exposed by MySQL. DBZ-164
- MySQL connector ignores XA statements appearing in the binlog. DBZ-168
- MySQL connector no longer expects GTID set information on older MySQL versions. DBZ-161
- Improved the EmbeddedEngine and fixed several issues. DBZ-156
November 9, 2016 - Detailed release notes
This release includes the following feature:
- MySQL connector now supports failover to MySQL masters that are slaves of multiple other MySQL servers/clusters. DBZ-143
None
This release includes the following significant fix, and all users are strongly encouraged to upgrade:
- Restarting MySQL connector may lose or miss events from the previous transaction that was incompletely processed prior to the easlier shutdown. This fix corrects this potential problem and slightly alters the offsets recorded by the connector. Production connectors should be stopped carefully to ensure transactions are processed atomically, if necessary by temporarily stopping updates on the MySQL server and letting the connector complete all transactions before stopping. DBZ-144
Additionally, this release includes the following fixes since the 0.3.4 release:
- Shutting down MySQL connector task database and quickly terminating the Kafka Connect process may cause connector to be restarted in a strange state when Kafka Connect is restarted, but this no longer results in a null pointer exception in the Kafka database history. DBZ-146
- MySQL connector now has option to treat
DECIMAL
andNUMERIC
columns as double values rather thanjava.math.BigDecimal
values that are encoded in the messages by Kafka Connect in binary form. DBZ-147 - MySQL connector tests now take into account daylight savings time in the expected results. DBZ-148
- MySQL connector now properly treats
BINARY
columns as binary values rather than string values. DBZ-149 - MySQL connector now handles updates to a row's primary/unique key by issuing
DELETE
and tombstone events for the row with the old key, and then anINSERT
event for the row with the new key. Previously, theINSERT
was emitted before theDELETE
. DBZ-150 - MySQL connector now handles
ENUM
andSET
literals with parentheses. DBZ-153
October 25, 2016 - Detailed release notes
- MySQL connector has new
SCHEMA_ONLY
snapshot mode. DBZ-133 - MySQL connector supports the MySQL
JSON
datatype. DBZ-126 - MySQL connector metrics exposed via JMX. DBZ-134
None
This release includes all of the fixes from the 0.3.3 release, and also includes the following fixes:
- MySQL connector's
ts_sec
field now shows correct time from MySQL server events. DBZ-139
October 18, 2016 - Detailed release notes
None
None
This release includes all of the fixes from the 0.3.2 release, and also includes the following fixes:
- MySQL connector now works with MySQL 5.5. DBZ-115
- MySQL connector now handles
BIT(n)
column values. DBZ-123 - MySQL connector supports failing over based on subset of GTIDs. DBZ-129
- MySQL connector processes GTIDs with line feeds and carriage returns. DBZ-135
- MySQL connector has improved output of GTIDs and status when reading the binary log. DBZ-130, DBZ-131
- MySQL connector properly handles multi-character
ENUM
andSET
values. DBZ-132
September 26, 2016 - Detailed release notes
None
None
This release includes all of the fixes from the 0.3.1 release, and also includes the following fixes:
- MySQL connector now handles zero-value dates. DBZ-114
- MySQL connector no longer prints out password-related configuration properties, though KAFKA-4171 for a similar issue with Kafka Connect. DBZ-122
- MySQL connector no longer causes "Error registering AppInfo mbean" warning in Kafka Connect. DBZ-124
- MySQL connector periodically outputs status when reading binlog. DBZ-116
- MongoDB connector periodically outputs status when reading binlog. DBZ-117
- MySQL connector correctly uses long for the
server.id
configuration property. DBZ-118 - MySQL connector fails or warns when MySQL is not using row-level logging. DBZ-128
August 30, 2016 - Detailed release notes
- Added support for secure (encrypted) connections to MySQL. DBZ-99
None
This release includes all of the fixes from the 0.2.4 release, and also includes the following fixes:
- MySQL connector now properly decodes string values from the binlog based upon the column's character set encoding as read by the DDL statement. Upon upgrade and restart, the connector will re-read the recorded database history and now associate the columns with their the character sets, and any newly processed events will use properly encoded strings values. As expected, previously generated events are never altered. Force a snapshot to regenerate events for the servers. DBZ-102
- Corrected how the MySQL connector parses some DDL statements. DBZ-106
- Corrected the MySQL connector to handle MySQL server GTID sets with newline characters. DBZ-107, DBZ-111
- Corrected the MySQL connector's startup logic properly compare the MySQL SSL-related system properties to prevent overwriting them. The connector no longer fails when the system properties are the same, which can happen upon restart or starting a second MySQL connector with the same keystore. DBZ-112
- Removed unused code and test case. DBZ-108
- Ensure that the MySQL error code and SQLSTATE are included in exceptions reported by the connector. DBZ-109
August 16, 2016 - Detailed release notes
- New MongoDB connector supports capturing changes from a MongoDB replica set or a MongoDB sharded cluster. See the documentation for details. DBZ-2
- Upgraded to Kafka 0.10.0.1, which means that the Debezium connectors can only be used with Kafka Connect 0.10.0.1. Check Kafka documentation for compatibility with other versions of Kafka brokers. DBZ-62, DBZ-80
- By default the MySQL connector now represents temporal values with millisecond, microsecond, or nanosecond precision based upon the precision of the source database columns. This changes the schema name of these fields to Debezium-specific constants, and the meaning/interpretation of the literal values now depends on this schema name. To enable previous behavior that always used millisecond precision using only Kafka Connect logical types, set
time.precision.mode
connector property toconnect
. DBZ-91 - Removed several methods in the
GtidSet
class inside the MySQL connector. The class was introduced in 0.2. This change will only affect applications explicitly using the class (by reusing the MySQL connector JAR), and will not affect how the MySQL connector works. Changed in 0.2.2. DBZ-79 - The
source
field within each MySQL change event now contains the binlog position of that event (rather than the next event). Events persisted by earlier versions of the connector are unaffected. This change may adversely clients that are directly using the position within thesource
field. Changed in 0.2.2. DBZ-76 - Correted the names of the Avro-compliant Kafka Connect schemas generated by the MySQL connector for the
before
andafter
fields in its data change events. Consumers that require knowledge (by name) of the particular schemas used in 0.2 events may have trouble consuming events produced by the 0.2.1 (or later) connector. Fixed in 0.2.1. DBZ-72
- MySQL snapshots records DDL statements as separate events on the schema change topic. DBZ-97
- MySQL connector tolerates binlog filename missing from ROTATE events in certain situations. DBZ-95
- Stream result set rows when taking snapshot of MySQL databases to prevent out of memory problems with very large databases. Fixed in 0.2.4. DBZ-94
- Add more verbose logging statements to the MySQL connector to show progress and activity. Fixed in 0.2.4. DBZ-92
- Corrected potential error during graceful MySQL connector shutdown. Fixed in 0.2.4. DBZ-103
- The Kafka Connect schema names used in the MySQL connector's change events are now always Avro-compatible schema names DBZ-86
- Corrected parsing errors when MySQL DDL statements are generated by Liquibase. Fixed in 0.2.3. DBZ-83
- Corrected support of MySQL
TINYINT
andSMALLINT
types. Fixed in 0.2.3. DBZ-84, DBZ-87 - Corrected support of MySQL temporal types, including
DATE
,TIME
, andTIMESTAMP
. Fixed in 0.2.3. DBZ-85 - Corrected support of MySQL
ENUM
andSET
types. DBZ-100 - Corrected call to MySQL
SHOW MASTER STATUS
so that it works on pre-5.7 versions of MySQL. Fixed in 0.2.3. DBZ-82 - Correct how the MySQL connector records offsets with multi-row MySQL events so that, even if the connector experiences a non-graceful shutdown (i.e., crash) after committing the offset of some of the rows from such an event, upon restart the connector will resume with the remaining rows in that multi-row event. Previously, the connector might incorrectly restart at the next event. Fixed in 0.2.2. DBZ-73
- Shutdown of the MySQL connector immediately after a snapshot completes (before another change event is reccorded) will now be properly marked as complete. Fixed in 0.2.2. DBZ-77
- The MySQL connector's plugin archive now contains the MySQL JDBC driver JAR file required by the connector. Fixed in 0.2.1. DBZ-71
August 16, 2016 - Detailed release notes
- Stream result set rows when taking snapshot of MySQL databases to prevent out of memory problems with very large databases. DBZ-94
- Add more verbose logging statements to the MySQL connector to show progress and activity during snapshots. DBZ-92
- Corrected potential error during graceful MySQL connector shutdown. DBZ-103
July 26, 2016 - Detailed release notes
None
- Corrected parsing errors when MySQL DDL statements are generated by Liquibase. DBZ-83
- Corrected support of MySQL
TINYINT
andSMALLINT
types. DBZ-84, DBZ-87 - Corrected support of MySQL temporal types, including
DATE
,TIME
, andTIMESTAMP
. DBZ-85 - Corrected call to MySQL
SHOW MASTER STATUS
so that it works on pre-5.7 versions of MySQL. DBZ-82
June 22, 2016 - Detailed release notes
- Removed several methods in the
GtidSet
class inside the MySQL connector. The class was introduced in 0.2. This change will only affect applications explicitly using the class (by reusing the MySQL connector JAR), and will not affect how the MySQL connector works. DBZ-79 - The
source
field within each MySQL change event now contains the binlog position of that event (rather than the next event). Events persisted by earlier versions of the connector are unaffected. This change may adversely clients that are directly using the position within thesource
field. DBZ-76
- Correct how the MySQL connector records offsets with multi-row MySQL events so that, even if the connector experiences a non-graceful shutdown (i.e., crash) after committing the offset of some of the rows from such an event, upon restart the connector will resume with the remaining rows in that multi-row event. Previously, the connector might incorrectly restart at the next event. DBZ-73
- Shutdown of the MySQL connector immediately after a snapshot completes (before another change event is reccorded) will now be properly marked as complete. DBZ-77
June 10, 2016 - Detailed release notes
- Correted the names of the Avro-compliant Kafka Connect schemas generated by the MySQL connector for the
before
andafter
fields in its data change events. Consumers that require knowledge (by name) of the particular schemas used in 0.2 events may have trouble consuming events produced by the 0.2.1 (or later) connector. (DBZ-72)
- The MySQL connector's plugin archive now contains the MySQL JDBC driver JAR file required by the connector.(DBZ-71)
June 8, 2016 - Detailed release notes
- MySQL connector supports high availability MySQL cluster topologies. See the documentation for details. (DBZ-37)
- MySQL connector now by default starts by performing a consistent snapshot of the schema and contents of the upstream MySQL databases in its current state. See the documentation for details about how this works and how it impacts other database clients. (DBZ-31)
- MySQL connector can be configured to exclude, truncate, or mask specific columns in events. (DBZ-29)
- MySQL connector events can be serialized using the Confluent Avro converter or the JSON converter. Previously, only the JSON converter could be used. (DBZ-29, DBZ-63, DBZ-64)
- Completely redesigned the structure of event messages produced by MySQL connector and stored in Kafka topics. Events now contain an envelope structure with information about the source event, the kind of operation (create/insert, update, delete, read), the time that Debezium processed the event, and the state of the row before and/or after the event. The messages written to each topic have a distinct Avro-compliant Kafka Connect schema that reflects the structure of the source table, which may vary over time independently from the schemas of all other topics. See the documentation for details. This envelope structure will likely be used by future connectors. (DBZ-50, DBZ-52, DBZ-45, DBZ-60)
- MySQL connector handles deletion of a row by recording a delete event message whose value contains the state of the removed row (and other metadata), followed by a tombstone event message with a null value to signal Kafka's log compaction that all prior messages with the same key can be garbage collected. See the documentation for details. (DBZ-44)
- Changed the format of events that the MySQL connector writes to its schema change topic, through which consumers can access events with the DDL statements applied to the database(s). The format change makes it possible for consumers to correlate these events with the data change events. (DBZ-43, DBZ-55)
- DDL parsing framework identifies table affected by statements via a new listener callback. (DBZ-38)
- The
database.binlog
configuration property was required in version 0.1 of the MySQL connector, but in 0.2 it is no longer used because of the new snapshot feature. If provided, it will be quietly ignored. (DBZ-31)
- MySQL connector now properly parses
COMMIT
statements, theREFERENCES
clauses ofCREATE TABLE
statements, and statements withCHARSET
shorthand ofCHARACTER SET
. (DBZ-48, DBZ-49, DBZ-57) - MySQL connector properly handles binary values that are hexadecimal strings (DBZ-61)
March 17, 2016 - Detailed release notes
- MySQL connector for ingesting change events from MySQL databases. (DBZ-1)
- Kafka Connect plugin archive for MySQL connector. (DBZ-17)
- Simple DDL parsing framework that can be extended and used by various connectors. (DBZ-1)
- Framework for embedding a single Kafka Connect connector inside an application. (DBZ-8)