Debezium connector for Informix

Table of Contents

• Overview

• How the connector works

  • Snapshots
  • Chunk-based parallel snapshots
  • Ad hoc snapshots
  • Incremental snapshots
  • Custom snapshotter SPI
  • Blocking snapshots
  • Change stream records
  • Topic names
  • Schema history topic
  • Schema change topic
  • Transaction metadata

• Data change events

  • Change event keys
  • Change event values
  • create events
  • update events
  • delete events

• Data type mappings

  • Basic types
  • Temporal types
  • Timestamp types
  • Decimal types

• Setting up Informix

• Deployment

  • Informix connector configuration example
  • Adding connector configuration
  • Connector properties

• Monitoring

  • Customized MBean names
  • Snapshot metrics
  • Streaming metrics
  • Schema history metrics

• Schema evolution

  • Offline schema update

The Debezium Informix connector can capture row-level changes in the tables of a Informix database. For information about the Informix Database versions that are compatible with this connector, see the Debezium release overview.

This connector is strongly inspired by the Debezium implementation of IBM Db2, but uses the Informix Change Streams API for Java to capture transactional data. The Change Data Capture API captures data from databases that have full row logging enabled and captures transactions from the current logical log. The API processes all transactions sequentially.

The first time that a Debezium Informix connector connects to an Informix database, the connector reads a consistent snapshot of the tables for which the connector is configured to capture changes. By default, the connector captures changes from all non-system tables. To customize snapshot behavior, you can set configuration properties to specify the tables to include or exclude in the snapshot.

After the snapshot completes, the connector begins to emit change events for updates that are committed to tables that are in capture mode. By default, change events for a particular table go to a Kafka topic that has the same name as the table. Applications and services can then consume change event records from these topics.

The Informix connector has been tested with Informix for Linux. It is expected that the connector would also work on other platforms such as Windows, and we’d love to get your feedback if you can confirm this to be the case.

Overview

The Debezium Informix connector is based on the Informix Change Data Capture API that enables Change Data Capture in Informix.

The database administrator must prepare the database and the database server for using the Change Data Capture API. See Preparing to use the Change Data Capture API.

After you place tables in capture mode, the connector can read change stream records for each table update and generate change events from them. The connector emits a change event record for each row-level insert, update, and delete operation. By default, change events records are sent to a Kafka topic that has the same name as the source table. Optionally, you can customize the name of the target topic. Client applications read the Kafka topics that correspond to the database tables of interest and can react to each row-level change event.

Typically, the database administrator puts a table into capture mode in the middle of the life of a table. This means that the connector does not have the complete history of all changes that have been made to the table. Therefore, when the Informix connector first connects to a particular Informix database, it starts by performing a consistent snapshot of each table that is in capture mode. After the connector completes the snapshot, the connector streams change events from the point at which the snapshot was made. In this way, the connector starts with a consistent view of the tables that are in capture mode, and does not drop any changes that were made while it was performing the snapshot.

Debezium connectors are tolerant of failures. As the connector reads and produces change events, it records the log sequence number (LSN) of the change stream record. The LSN is the position of the change event in the database log. If the connector stops for any reason, including communication failures, network problems, or crashes, upon restarting it continues reading the change stream where it left off. This behavior also applies to snapshots. That is, if the snapshot was not complete when the connector stopped, after a restart, the connector begins a new snapshot.

How the connector works

To optimally configure and run a Debezium Informix connector, it is helpful to understand how the connector performs snapshots, streams change events, determines Kafka topic names, and handles schema changes.

Snapshots

The Informix replication feature is not designed to store the complete history of database changes. As a result, the Debezium Informix connector cannot retrieve the entire history of the database from the logs. To enable the connector to establish a baseline for the current state of the database, the first time that the connector starts, it performs an initial consistent snapshot of the tables that are in capture mode. For each change that the snapshot captures, the connector emits a read event to the Kafka topic for the captured table.

Default workflow that the Debezium Informix connector uses to perform an initial snapshot

The following workflow lists the steps that Debezium takes to create a snapshot. These steps describe the process for a snapshot when the snapshot.mode configuration property is set to its default value, which is initial. You can customize the way that the connector creates snapshots by changing the value of the snapshot.mode property. If you configure a different snapshot mode, the connector completes the snapshot by using a modified version of this workflow.

1. Establish a connection to the database.

2. Determine which tables are in capture mode and should be included in the snapshot. By default, the connector captures the data for all non-system tables. After the snapshot completes, the connector continues to stream data for the specified tables. If you want the connector to capture data only from specific tables, you can configure the connector to capture the data for a subset of tables or table elements by setting properties such as table.include.list or table.exclude.list.

3. Obtain a lock on each of the tables in capture mode. This lock ensures that no schema changes can occur in those tables until the snapshot completes. The level of the lock is determined by the value of the snapshot.isolation.mode connector configuration property.

4. Read the highest (most recent) LSN position in the server’s transaction log.

5. Capture the schema of all tables or all tables that are designated for capture. The connector persists schema information in its internal database schema history topic. The schema history provides information about the structure that is in effect when a change event occurs.

   By default, the connector captures the schema of every table in the database that is in capture mode, including tables that are not configured for capture. If tables are not configured for capture, the initial snapshot captures only their structure; it does not capture any table data.

   For more information about why snapshots persist schema information for tables that you did not include in the initial snapshot, see Understanding why initial snapshots capture the schema for all tables.

6. Release any locks obtained in Step 3. Other database clients can now write to any previously locked tables.

7. At the LSN position read in Step 4, the connector scans the tables that are designated for capture. During the scan, the connector completes the following tasks:

   1. Confirms that the table was created before the snapshot began. If the table was created after the snapshot began, the connector skips the table. After the snapshot is complete, and the connector transitions to streaming, it emits change events for any tables that were created after the snapshot began.
   2. Produces a read event for each row that is captured from a table. All read events contain the same LSN position, which is the LSN position that was obtained in step 4.
   3. Emits each read event to the Kafka topic for the source table.
   4. Releases data table locks, if applicable.

8. Record the successful completion of the snapshot in the connector offsets.

The resulting initial snapshot captures the current state of each row in the captured tables. From this baseline state, the connector captures subsequent changes as they occur.

After the snapshot process begins, if the process is interrupted due to connector failure, rebalancing, or other reasons, the process restarts after the connector restarts.

After the connector completes the initial snapshot, it continues streaming from the position that it read in Step 4 so that it does not miss any updates.

If the connector stops again for any reason, after it restarts, it resumes streaming changes from where it previously left off.

Table 1. Settings for snapshot.mode connector configuration property

Setting Description

always

The connector performs a snapshot every time that it starts. After the snapshot completes, the connector begins to stream event records for subsequent database changes.

initial

The connector performs a database snapshot as described in the default workflow for creating an initial snapshot. After the snapshot completes, the connector begins to stream event records for subsequent database changes.

initial_only

The connector performs a database snapshot. After the snapshot completes, the connector stops, and does not stream event records for subsequent database changes.

schema_only

Deprecated, see no_data.

no_data

The connector captures the structure of all relevant tables, performing all the steps described in the default snapshot workflow, except that it does not create READ events to represent the data set at the point of the connector’s start-up (Step 7.b).

recovery

Set this option to restore a database schema history topic that is lost or corrupted. After a restart, the connector runs a snapshot that rebuilds the topic from the source tables. You can also set the property to periodically prune a database schema history topic that experiences unexpected growth.

when_needed

After the connector starts, it performs a snapshot only if it detects one of the following circumstances:

• It cannot detect any topic offsets.
• A previously recorded offset specifies a log position that is not available on the server.

configuration_based

Set the snapshot mode to configuration_based to control snapshot behavior through the set of connector properties that have the prefix 'snapshot.mode.configuration.based'.

custom

The custom snapshot mode lets you inject your own implementation of the io.debezium.spi.snapshot.Snapshotter interface. Set the snapshot.mode.custom.name configuration property to the name provided by the name() method of your implementation. The name is specified on the classpath of your Kafka Connect cluster. If you use the DebeziumEngine, the name is included in the connector JAR file. For more information, see custom snapshotter SPI.

For more information, see snapshot.mode in the table of connector configuration properties.

Understanding why initial snapshots capture the schema history for all tables

The initial snapshot that a connector runs captures two types of information:

Table data

Information about INSERT, UPDATE, and DELETE operations in tables that are named in the connector’s table.include.list property.

Schema data

DDL statements that describe the structural changes that are applied to tables. Schema data is persisted to both the internal schema history topic, and to the connector’s schema change topic, if one is configured.

After you run an initial snapshot, you might notice that the snapshot captures schema information for tables that are not designated for capture. By default, initial snapshots are designed to capture schema information for every table that is present in the database, not only from tables that are designated for capture. Connectors require that the table’s schema is present in the schema history topic before they can capture a table. By enabling the initial snapshot to capture schema data for tables that are not part of the original capture set, Debezium prepares the connector to readily capture event data from these tables should that later become necessary. If the initial snapshot does not capture a table’s schema, you must add the schema to the history topic before the connector can capture data from the table.

In some cases, you might want to limit schema capture in the initial snapshot. This can be useful when you want to reduce the time required to complete a snapshot. Or when Debezium connects to the database instance through a user account that has access to multiple logical databases, but you want the connector to capture changes only from tables in a specific logic database.

Additional information

• Capturing data from tables not captured by the initial snapshot (no schema change)
• Capturing data from tables not captured by the initial snapshot (schema change)
• Setting the schema.history.internal.store.only.captured.tables.ddl property to specify the tables from which to capture schema information.
• Setting the schema.history.internal.store.only.captured.databases.ddl property to specify the logical databases from which to capture schema changes.

Capturing data from tables not captured by the initial snapshot (no schema change)

In some cases, you might want the connector to capture data from a table whose schema was not captured by the initial snapshot. Depending on the connector configuration, the initial snapshot might capture the table schema only for specific tables in the database. If the table schema is not present in the history topic, the connector fails to capture the table, and reports a missing schema error.

You might still be able to capture data from the table, but you must perform additional steps to add the table schema.

Prerequisites

• You want to capture data from a table with a schema that the connector did not capture during the initial snapshot.
• No schema changes were applied to the table between the LSNs of the earliest and latest change table entry that the connector reads. For information about capturing data from a new table that has undergone structural changes, see Capturing data from tables not captured by the initial snapshot (schema change).

Procedure

1. Stop the connector.

2. Remove the internal database schema history topic that is specified by the schema.history.internal.kafka.topic property.

3. Clear the offsets in the configured Kafka Connect offset.storage.topic. For more information about how to remove offsets, see the Debezium community FAQ.

   	Removing offsets should be performed only by advanced users who have experience in manipulating internal Kafka Connect data. This operation is potentially destructive, and should be performed only as a last resort.

4. Apply the following changes to the connector configuration:

   1. (Optional) Set the value of schema.history.internal.captured.tables.ddl to false.

      This setting causes the snapshot to capture the schema for all tables, and guarantees that, in the future, the connector can reconstruct the schema history for all tables.

      	Snapshots that capture the schema for all tables require more time to complete.

   2. Add the tables that you want the connector to capture to table.include.list.

   3. Set the snapshot.mode to one of the following values:

      initial

      When you restart the connector, it takes a full snapshot of the database that captures the table data and table structures. If you select this option, consider setting the value of the schema.history.internal.captured.tables.ddl property to false to enable the connector to capture the schema of all tables.

      no_data

      When you restart the connector, it takes a snapshot that captures only the table schema. Unlike a full data snapshot, this option does not capture any table data. Use this option if you want to restart the connector more quickly than with a full snapshot.

5. Restart the connector. The connector completes the type of snapshot specified by the snapshot.mode.

6. (Optional) If the connector performed a no_data snapshot, after the snapshot completes, initiate an incremental snapshot to capture data from the tables that you added. The connector runs the snapshot while it continues to stream real-time changes from the tables. Running an incremental snapshot captures the following data changes:

   • For tables that the connector previously captured, the incremental snapshot captures changes that occur while the connector was down, that is, in the interval between the time that the connector was stopped, and the current restart.
   • For newly added tables, the incremental snapshot captures all existing table rows.

Capturing data from tables not captured by the initial snapshot (schema change)

If a schema change is applied to a table, records that are committed before the schema change have different structures than those that were committed after the change. When Debezium captures data from a table, it reads the schema history to ensure that it applies the correct schema to each event. If the schema is not present in the schema history topic, the connector is unable to capture the table, and an error results.

If you want to capture data from a table that was not captured by the initial snapshot, and the schema of the table was modified, you must add the schema to the history topic, if it is not already available. You can add the schema by running a new schema snapshot, or by running an initial snapshot for the table.

Prerequisites

• You want to capture data from a table with a schema that the connector did not capture during the initial snapshot.
• A schema change was applied to the table so that the records to be captured do not have a uniform structure.

Procedure

Initial snapshot captured the schema for all tables (store.only.captured.tables.ddl was set to false)

1. Edit the table.include.list property to specify the tables that you want to capture.
2. Restart the connector.
3. Initiate an incremental snapshot if you want to capture existing data from the newly added tables.

Initial snapshot did not capture the schema for all tables (store.only.captured.tables.ddl was set to true)

If the initial snapshot did not save the schema of the table that you want to capture, complete one of the following procedures:

Procedure 1: Schema snapshot, followed by incremental snapshot

In this procedure, the connector first performs a schema snapshot. You can then initiate an incremental snapshot to enable the connector to synchronize data.

1. Stop the connector.

2. Remove the internal database schema history topic that is specified by the schema.history.internal.kafka.topic property.

3. Clear the offsets in the configured Kafka Connect offset.storage.topic. For more information about how to remove offsets, see the Debezium community FAQ.

   	Removing offsets should be performed only by advanced users who have experience in manipulating internal Kafka Connect data. This operation is potentially destructive, and should be performed only as a last resort.

4. Set values for properties in the connector configuration as described in the following steps:

   1. Set the value of the snapshot.mode property to no_data.
   2. Edit the table.include.list to add the tables that you want to capture.

5. Restart the connector.

6. Wait for Debezium to capture the schema of the new and existing tables. Data changes that occurred any tables after the connector stopped are not captured.

7. To ensure that no data is lost, initiate an incremental snapshot.

Procedure 2: Initial snapshot, followed by optional incremental snapshot

In this procedure the connector performs a full initial snapshot of the database. As with any initial snapshot, in a database with many large tables, running an initial snapshot can be a time-consuming operation. After the snapshot completes, you can optionally trigger an incremental snapshot to capture any changes that occur while the connector is off-line.

1. Stop the connector.

2. Remove the internal database schema history topic that is specified by the schema.history.internal.kafka.topic property.

3. Clear the offsets in the configured Kafka Connect offset.storage.topic. For more information about how to remove offsets, see the Debezium community FAQ.

   	Removing offsets should be performed only by advanced users who have experience in manipulating internal Kafka Connect data. This operation is potentially destructive, and should be performed only as a last resort.

4. Edit the table.include.list to add the tables that you want to capture.

5. Set values for properties in the connector configuration as described in the following steps:

   1. Set the value of the snapshot.mode property to initial.
   2. (Optional) Set schema.history.internal.store.only.captured.tables.ddl to false.

6. Restart the connector. The connector takes a full database snapshot. After the snapshot completes, the connector transitions to streaming.

7. (Optional) To capture any data that changed while the connector was off-line, initiate an incremental snapshot.

Chunk-based parallel snapshots

Chunk-based parallel snapshotting accelerates initial snapshots by distributing smaller units of work across multiple threads, improving workload balance and snapshot resilience.

When you set snapshot.max.threads to a value greater than 1, the connector divides each table into chunks based on primary key ranges and distributes those chunks across the available threads. Each thread snapshots its assigned chunks concurrently, and the connector emits READ events for each captured row as it progresses through the chunks.

The snapshot.max.threads.multiplier property controls how many chunks the connector creates per table relative to the thread count. By default, the connector creates one chunk per thread. Setting a higher multiplier creates more, smaller chunks, which keeps threads more evenly loaded. For example, with 4 threads and a multiplier of 2, the connector creates 8 chunks instead of 4.

The following table summarizes the differences between the two parallel snapshotting approaches.

Characteristic Chunk-based (default) Legacy table-per-thread

Unit of work per thread

Each thread processes a chunk of rows from a table. Chunks are defined by ranges of primary key values.

Each thread processes an entire table.

Load distribution

Threads claim available chunks as they complete their current work, helping to balance the workload across threads.

Each thread remains assigned to the same table for the duration of the snapshot. Threads that finish processing smaller tables remain idle while other threads continue to process larger tables.

Idle-connection risk

Low.

Threads remain active until the snapshot finishes.

High.

Threads that finish processing a table can remain idle while waiting for other threads to complete. In environments that enforce connection timeouts, idle connections can prevent the connector from closing connections cleanly after the snapshot finishes. Failure to close a connection can result in an exception, even if a snapshot captures all data successfully.

Chunk-based snapshotting is the default behavior. To use chunk-based snapshotting, set legacy.snapshot.max.threads to false.

To revert to the legacy table-per-thread behavior, set legacy.snapshot.max.threads to true.

The legacy table-per-thread behavior is deprecated and will be removed in a future release.

The property internal.legacy.snapshot.max.threads is a deprecated alias for legacy.snapshot.max.threads and should not be used in new configurations.

By default, a connector runs an initial snapshot operation only after it starts for the first time. Following this initial snapshot, under normal circumstances, the connector does not repeat the snapshot process. Any future change event data that the connector captures comes in through the streaming process only.

However, in some situations the data that the connector obtained during the initial snapshot might become stale, lost, or incomplete. To provide a mechanism for recapturing table data, Debezium includes an option to perform ad hoc snapshots. You might want to perform an ad hoc snapshot after any of the following changes occur in your Debezium environment:

• The connector configuration is modified to capture a different set of tables.
• Kafka topics are deleted and must be rebuilt.
• Data corruption occurs due to a configuration error or some other problem.

You can re-run a snapshot for a table for which you previously captured a snapshot by initiating a so-called ad-hoc snapshot. Ad hoc snapshots require the use of signaling tables. You initiate an ad hoc snapshot by sending a signal request to the Debezium signaling table.

When you initiate an ad hoc snapshot of an existing table, the connector appends content to the topic that already exists for the table. If a previously existing topic was removed, Debezium can create a topic automatically if automatic topic creation is enabled.

Ad hoc snapshot signals specify the tables to include in the snapshot. The snapshot can capture the entire contents of the database, or capture only a subset of the tables in the database. Also, the snapshot can capture a subset of the contents of the table(s) in the database.

You specify the tables to capture by sending an execute-snapshot message to the signaling table. Set the type of the execute-snapshot signal to incremental or blocking, and provide the names of the tables to include in the snapshot, as described in the following table:

Table 2. Example of an ad hoc execute-snapshot signal record

Field Default Value

type

incremental

Specifies the type of snapshot that you want to run. Currently, you can request incremental or blocking snapshots.

data-collections

N/A

An array that contains regular expressions matching the fully-qualified names of the tables to include in the snapshot. For the Informix connector, use the following format to specify the fully qualified name of a table: database.schema.table.

additional-conditions

N/A

An optional array that specifies a set of additional conditions that the connector evaluates to determine the subset of records to include in a snapshot. Each additional condition is an object that specifies the criteria for filtering the data that an ad hoc snapshot captures. You can set the following parameters for each additional condition:

data-collection

The fully-qualified name of the table that the filter applies to. You can apply different filters to each table.

filter

Specifies column values that must be present in a database record for the snapshot to include it, for example, "color='blue'".

The values that you assign to the filter parameter are the same types of values that you might specify in the WHERE clause of SELECT statements when you set the snapshot.select.statement.overrides property for a blocking snapshot.

surrogate-key

N/A

An optional string that specifies the column name that the connector uses as the primary key of a table during the snapshot process.

Triggering an ad hoc incremental snapshot

You initiate an ad hoc incremental snapshot by adding an entry with the execute-snapshot signal type to the signaling table, or by sending a signal message to a Kafka signaling topic. After the connector processes the message, it begins the snapshot operation. The snapshot process reads the first and last primary key values and uses those values as the start and end point for each table. Based on the number of entries in the table, and the configured chunk size, Debezium divides the table into chunks, and proceeds to snapshot each chunk, in succession, one at a time.

For more information, see Incremental snapshots.

Triggering an ad hoc blocking snapshot

You initiate an ad hoc blocking snapshot by adding an entry with the execute-snapshot signal type to the signaling table or signaling topic. After the connector processes the message, it begins the snapshot operation. The connector temporarily stops streaming, and then initiates a snapshot of the specified table, following the same process that it uses during an initial snapshot. After the snapshot completes, the connector resumes streaming.

For more information, see Blocking snapshots.

Incremental snapshots

To provide flexibility in managing snapshots, Debezium includes a supplementary snapshot mechanism, known as incremental snapshotting. Incremental snapshots rely on the Debezium mechanism for sending signals to a Debezium connector. Incremental snapshots are based on the DDD-3 design document.

In an incremental snapshot, instead of capturing the full state of a database all at once, as in an initial snapshot, Debezium captures each table in phases, in a series of configurable chunks. You can specify the tables that you want the snapshot to capture and the size of each chunk. The chunk size determines the number of rows that the snapshot collects during each fetch operation on the database. The default chunk size for incremental snapshots is 1024 rows.

As an incremental snapshot proceeds, Debezium uses watermarks to track its progress, maintaining a record of each table row that it captures. This phased approach to capturing data provides the following advantages over the standard initial snapshot process:

• You can run incremental snapshots in parallel with streamed data capture, instead of postponing streaming until the snapshot completes. The connector continues to capture near real-time events from the change log throughout the snapshot process, and neither operation blocks the other.
• If the progress of an incremental snapshot is interrupted, you can resume it without losing any data. After the process resumes, the snapshot begins at the point where it stopped, rather than recapturing the table from the beginning.
• You can run an incremental snapshot on demand at any time, and repeat the process as needed to adapt to database updates. For example, you might re-run a snapshot after you modify the connector configuration to add a table to its table.include.list property.

Incremental snapshot process

When you run an incremental snapshot, Debezium sorts each table by primary key and then splits the table into chunks based on the configured chunk size. Working chunk by chunk, it then captures each table row in a chunk. For each row that it captures, the snapshot emits a READ event. That event represents the value of the row when the snapshot for the chunk began.

As a snapshot proceeds, it’s likely that other processes continue to access the database, potentially modifying table records. To reflect such changes, INSERT, UPDATE, or DELETE operations are committed to the transaction log as per usual. Similarly, the ongoing Debezium streaming process continues to detect these change events and emits corresponding change event records to Kafka.

How Debezium resolves collisions among records with the same primary key

In some cases, the UPDATE or DELETE events that the streaming process emits are received out of sequence. That is, the streaming process might emit an event that modifies a table row before the snapshot captures the chunk that contains the READ event for that row. When the snapshot eventually emits the corresponding READ event for the row, its value is already superseded. To ensure that incremental snapshot events that arrive out of sequence are processed in the correct logical order, Debezium employs a buffering scheme for resolving collisions. Only after collisions between the snapshot events and the streamed events are resolved does Debezium emit an event record to Kafka.

Snapshot window

To assist in resolving collisions between late-arriving READ events and streamed events that modify the same table row, Debezium employs a so-called snapshot window. The snapshot window demarcates the interval during which an incremental snapshot captures data for a specified table chunk. Before the snapshot window for a chunk opens, Debezium follows its usual behavior and emits events from the transaction log directly downstream to the target Kafka topic. But from the moment that the snapshot for a particular chunk opens, until it closes, Debezium performs a de-duplication step to resolve collisions between events that have the same primary key..

For each data collection, the Debezium emits two types of events, and stores the records for them both in a single destination Kafka topic. The snapshot records that it captures directly from a table are emitted as READ operations. Meanwhile, as users continue to update records in the data collection, and the transaction log is updated to reflect each commit, Debezium emits UPDATE or DELETE operations for each change.

As the snapshot window opens, and Debezium begins processing a snapshot chunk, it delivers snapshot records to a memory buffer. During the snapshot windows, the primary keys of the READ events in the buffer are compared to the primary keys of the incoming streamed events. If no match is found, the streamed event record is sent directly to Kafka. If Debezium detects a match, it discards the buffered READ event, and writes the streamed record to the destination topic, because the streamed event logically supersede the static snapshot event. After the snapshot window for the chunk closes, the buffer contains only READ events for which no related transaction log events exist. Debezium emits these remaining READ events to the table’s Kafka topic.

The connector repeats the process for each snapshot chunk.

To enable Debezium to perform incremental snapshots, you must grant the connector permission to write to the signaling table.

Write permission is unnecessary only for connectors that can be configured to perform read-only incrementals snapshots (MariaDB, MySQL, or PostgreSQL).

Currently, you can use either of the following methods to initiate an incremental snapshot:

• Send an ad hoc snapshot signal to the signaling table on the source database.
• Send a message to a configured Kafka signaling topic.

Triggering an incremental snapshot

To initiate an incremental snapshot, you can send an ad hoc snapshot signal to the signaling table on the source database. You submit snapshot signals as SQL INSERT queries.

After Debezium detects the change in the signaling table, it reads the signal, and runs the requested snapshot operation.

The query that you submit specifies the tables to include in the snapshot, and, optionally, specifies the type of snapshot operation. Debezium currently supports the incremental and blocking snapshot types.

To specify the tables to include in the snapshot, provide a data-collections array that lists the tables, or an array of regular expressions used to match tables, for example,

{"data-collections": ["public.MyFirstTable", "public.MySecondTable"]}

Data collection names are case-sensitive. The data-collections array for an incremental snapshot signal has no default value. If the data-collections array is empty, Debezium interprets the empty array to mean that no action is required, and it does not perform a snapshot.

Prerequisites

• Signaling is enabled.

  • A signaling data collection exists on the source database.
  • The signaling data collection is specified in the signal.data.collection property.

Using a source signaling channel to trigger an incremental snapshot

1. Send a SQL query to add the ad hoc incremental snapshot request to the signaling table:

   INSERT INTO <signalTable> (id, type, data) VALUES ('<id>', '<snapshotType>', '{"data-collections": ["<fullyQualfiedTableName>","<fullyQualfiedTableName>"],"type":"<snapshotType>","additional-conditions":[{"data-collection": "<fullyQualfiedTableName>", "filter": "<additional-condition>"}]}');

   For example,

   INSERT INTO db1.myschema.debezium_signal (id, type, data)
   values ('ad-hoc-1',
       'execute-snapshot',
       '{"data-collections": ["db1.schema1.table1", "db1.schema1.table2"],
       "type":"incremental",
       "additional-conditions":[{"data-collection": "db1.schema1.table1" ,"filter":"color=\'blue\'"}]}');

The values of the id,type, and data parameters in the command correspond to the fields of the signaling table. The following list describes the parameters in the preceding example:

INSERT INTO database.schema.debezium_signal

Specifies the fully-qualified name of the signaling table on the source database.

values

id

The id parameter contains the value ad-hoc, an arbitrary string that serves as the id identifier for the signal request.

type

The type parameter specifies the type of operation to perform, in this case, execute-snapshot.

data

The the data field of a signal contains the following fields:

data-collections

An array of table names or regular expressions to match table names to include in the snapshot.

type

An optional type component of the data field of a signal that specifies the type of snapshot operation to run.

Valid values are incremental and blocking.

If you do not specify a value, the connector defaults to performing an incremental snapshot.

additional-conditions

An optional array that specifies a set of additional conditions that the connector evaluates to determine the subset of records to include in a snapshot. Each additional condition in the array is an object with data-collection and filter properties.

Each data-collection in the additional-conditions array is specified by its fully-qualified name. You can specify one or more data collections. Each collection can be paired with an optional filter parameter. You can pair a unique filter with each data collection. The value of a filter property consists a column label and a value. When the snapshot runs, for each collection that is named in the array, it captures only the rows that contain the specified filter criteria.

In the example, for the table1 data collection, the signal results in a snapshot that captures only the rows that include the field color where the field value is 'blue'.

For more information about the additional-conditions parameter, see Running an ad hoc incremental snapshots with additional-conditions.

Using physical row identifiers as surrogate keys

Some databases provide physical row identifiers, which are pseudo-columns that represent the physical location of a row on disk. These identifiers can provide significant performance improvements for incremental snapshot chunking.

Physical row identifiers are particularly useful in the following scenarios:

Tables with composite primary keys

When a table has no single-column surrogate key and uses multiple columns as the primary key, chunking queries become complex and inefficient.

Inefficient index utilization

Database query optimizers often cannot use indexes effectively with the disjunction of conditions generated by incremental snapshot chunking queries, resulting in full table scans.

By using a physical row identifier as the surrogate key, Debezium can generate simpler range-based queries that leverage the inherent ordering of row identifiers, significantly improving performance.

Debezium supports the following physical row identifiers as surrogate keys:

The following example shows a SQL query to trigger an incremental snapshot using Oracle’s ROWID as the surrogate key:

INSERT INTO db1.myschema.debezium_signal (id, type, data)
VALUES ('ad-hoc-1',
    'execute-snapshot',
    '{"data-collections": ["db1.myschema.mytable"],
      "type": "incremental",
      "surrogate-key": "ROWID"}');

Physical row identifiers can change under certain circumstances, which may affect snapshot consistency. Oracle ROWID can change during table reorganization operations such as ALTER TABLE MOVE, partition maintenance, or SHRINK SPACE operations.

To ensure data consistency, when an incremental snapshot that uses a physical row identifier is in progress, do not perform table maintenance operations, such as table moves, partition management, or shrink operations.

Running an ad hoc incremental snapshots with additional-conditions

If you want a snapshot to include only a subset of the content in a table, you can modify the signal request by appending an additional-conditions parameter to the snapshot signal.

The SQL query for a typical snapshot takes the following form:

SELECT * FROM <tableName> ....

By adding an additional-conditions parameter, you append a WHERE condition to the SQL query, as in the following example:

SELECT * FROM <data-collection> WHERE <filter> ....

The following example shows a SQL query to send an ad hoc incremental snapshot request with an additional condition to the signaling table:

INSERT INTO <signalTable> (id, type, data) VALUES ('<id>', '<snapshotType>', '{"data-collections": ["<fullyQualfiedTableName>","<fullyQualfiedTableName>"],"type":"<snapshotType>","additional-conditions":[{"data-collection": "<fullyQualfiedTableName>", "filter": "<additional-condition>"}]}');

For example, suppose you have a products table that contains the following columns:

• id (primary key)
• color
• quantity

If you want an incremental snapshot of the products table to include only the data items where color=blue, you can use the following SQL statement to trigger the snapshot:

INSERT INTO db1.myschema.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["db1.schema1.products"],"type":"incremental", "additional-conditions":[{"data-collection": "db1.schema1.products", "filter": "color=blue"}]}');

The additional-conditions parameter also enables you to pass conditions that are based on more than one column. For example, using the products table from the previous example, you can submit a query that triggers an incremental snapshot that includes the data of only those items for which color=blue and quantity>10:

INSERT INTO db1.myschema.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["db1.schema1.products"],"type":"incremental", "additional-conditions":[{"data-collection": "db1.schema1.products", "filter": "color=blue AND quantity>10"}]}');

The following example, shows the JSON for an incremental snapshot event that is captured by a connector.

Example 1. Incremental snapshot event message

{
    "before":null,
    "after": {
        "pk":"1",
        "value":"New data"
    },
    "source": {
        ...
        "snapshot":"incremental"
    },
    "op":"r",
    "ts_ms":"1620393591654",
    "ts_us":"1620393591654547",
    "ts_ns":"1620393591654547920",
    "transaction":null
}

The following list describes select fields in the preceding example of an incremental snapshot event message:

snapshot

Specifies the type of the snapshot.

op

Specifies the type of operation. For snapshot events, the value of the op field value is r, because a snapshot is a READ operation.

Using the Kafka signaling channel to trigger an incremental snapshot

To trigger an ad hoc incremental snapshot using the Kafka signaling channel, send an execute-snapshot message to the configured Kafka signaling topic.

The key of the Kafka message must match the value of the topic.prefix connector configuration option.

The value of the message is a JSON object with type and data fields.

The signal type is execute-snapshot, and the data field must have the following fields:

Table 3. Execute snapshot data fields

Field Default Value

type

incremental

The type of the snapshot to be executed. Currently Debezium supports the incremental and blocking types. See the next section for more details.

data-collections

N/A

An array of comma-separated regular expressions that match the fully-qualified names of tables to include in the snapshot.

Specify the names by using the same format as is required for the signal.data.collection configuration option. Data collection names are case-sensitive.

additional-conditions

N/A

An optional array of additional conditions that specifies criteria that the connector evaluates to designate a subset of records to include in a snapshot.

Each additional condition is an object that specifies the criteria for filtering the data that an ad hoc snapshot captures. You can set the following parameters for each additional condition:

data-collection

The fully-qualified name of the table that the filter applies to. You can apply different filters to each table.

filter

Specifies column values that must be present in a database record for the snapshot to include it, for example, "color='blue'".

The values that you assign to the filter parameter are the same types of values that you might specify in the WHERE clause of SELECT statements when you set the snapshot.select.statement.overrides property for a blocking snapshot.

Example 2. An execute-snapshot Kafka message

Key = `test_connector`

Value = `{"type":"execute-snapshot","data": {"data-collections": ["{collection-container}.table1", "{collection-container}.table2"], "type": "INCREMENTAL"}}`

Ad hoc incremental snapshots with additional-conditions

Debezium uses the additional-conditions field to select a subset of a table’s content.

Typically, when Debezium runs a snapshot, it runs a SQL query such as:

SELECT * FROM <tableName> …​.

When the snapshot request includes an additional-conditions property, the data-collection and filter parameters of the property are appended to the SQL query, for example:

SELECT * FROM <data-collection> WHERE <filter> …​.

For example, given a products table with the columns id (primary key), color, and brand, if you want a snapshot to include only content for which color='blue', when you request the snapshot, you could add the additional-conditions property to filter the content:

Key = `test_connector`

Value = `{"type":"execute-snapshot","data": {"data-collections": ["db1.schema1.products"], "type": "INCREMENTAL", "additional-conditions": [{"data-collection": "db1.schema1.products" ,"filter":"color='blue'"}]}}`

You can also use the additional-conditions property to pass conditions based on multiple columns. For example, using the same products table as in the previous example, if you want a snapshot to include only the content from the products table for which color='blue', and brand='MyBrand', you could send the following request:

Key = `test_connector`

Value = `{"type":"execute-snapshot","data": {"data-collections": ["db1.schema1.products"], "type": "INCREMENTAL", "additional-conditions": [{"data-collection": "db1.schema1.products" ,"filter":"color='blue' AND brand='MyBrand'"}]}}`

Stopping an incremental snapshot

In some situations, it might be necessary to stop an incremental snapshot. For example, you might realize that snapshot was not configured correctly, or maybe you want to ensure that resources are available for other database operations. You can stop a snapshot that is already running by sending a signal to the signaling table on the source database.

You submit a stop snapshot signal to the signaling table by sending it in a SQL INSERT query. The stop-snapshot signal specifies the type of the snapshot operation as incremental, and optionally specifies the tables that you want to omit from the currently running snapshot. After Debezium detects the change in the signaling table, it reads the signal, and stops the incremental snapshot operation if it’s in progress.

Additional resources

• Stopping an incremental snapshot by sending a JSON message to the Kafka signaling topic

Prerequisites

• Signaling is enabled.

  • A signaling data collection exists on the source database.
  • The signaling data collection is specified in the signal.data.collection property.

Using a source signaling channel to stop an incremental snapshot

1. Send a SQL query to stop the ad hoc incremental snapshot to the signaling table:

   INSERT INTO <signalTable> (id, type, data) values ('<id>', 'stop-snapshot', '{"data-collections": ["<fullyQualfiedTableName>","<fullyQualfiedTableName>"],"type":"incremental"}');

   For example,

   INSERT INTO db1.myschema.debezium_signal (id, type, data)
   values ('ad-hoc-1',
       'stop-snapshot',
       '{"data-collections": ["db1.schema1.table1", "db1.schema1.table2"],
       "type":"incremental"}');

   The values of the id, type, and data parameters in the signal command correspond to the fields of the signaling table.

   The following list describes the fields in the preceding signal example:

   database.schema.debezium_signal

   Specifies the fully-qualified name of the signaling table on the source database.

   ad-hoc-1

   The value of the signal’s id parameter. This arbitrary string provides a label that helps to distinguish signal requests from each other and to associate logging messages with entries in the signaling table. Debezium does not use this string.

   stop-snapshot

   The type parameter, which identifies the operation that the signal is intended to trigger.

   data-collections

   An optional component of the data field of a signal that specifies an array of table names or regular expressions to match table names to remove from the snapshot. The array lists regular expressions which match tables by their fully-qualified names in the format database.schema.table

   If you omit this component from the data field, the signal stops the entire incremental snapshot that is in progress.

   incremental

   A required component of the data field of a signal that specifies the type of snapshot operation that is to be stopped. Currently, the only valid option is incremental. If you do not specify a type value, the signal fails to stop the incremental snapshot.

Using the Kafka signaling channel to stop an incremental snapshot

To stop an in-progress incremental snapshot using the Kafka signaling channel, send a stop-snapshot message to the configured Kafka signaling topic.

The key of the Kafka message must match the value of the topic.prefix connector configuration option.

The value of the message is a JSON object with type and data fields.

The signal type is stop-snapshot, and the data field must have the following fields:

Table 4. Execute snapshot data fields

The following example shows a typical stop-snapshot Kafka message:

Key = `test_connector`

Value = `{"type":"stop-snapshot","data": {"data-collections": ["db1.schema1.table1", "db1.schema1.table2"], "type": "INCREMENTAL"}}`

Custom snapshotter SPI

To customize snapshot behavior beyond what is available in the standard snapshot modes, you can implement one or more of the Debezium snapshotter SPI interfaces. These interfaces can control whether a snapshot runs, how data is queried, and whether tables are locked.

io.debezium.snapshot.spi.Snapshotter

Controls whether the connector takes a snapshot.

io.debezium.snapshot.spi.SnapshotQuery

Controls how data is queried during a snapshot.

io.debezium.snapshot.spi.SnapshotLock

Controls whether the connector locks tables when taking a snapshot.

io.debezium.snapshot.spi.Snapshotter interface. All built-in snapshot modes implement this interface.

/**
 * {@link Snapshotter} is used to determine the following details about the snapshot process:
 * <p>
 * - Whether a snapshot occurs. <br>
 * - Whether streaming continues during the snapshot. <br>
 * - Whether the snapshot includes schema (if supported). <br>
 * - Whether to snapshot data or schema following an error.
 * <p>
 * Although Debezium provides many default snapshot modes,
 * to provide more advanced functionality, such as partial snapshots,
 * you can customize implementation of the interface.
 * For more information, see the documentation.
 *
 *
 *
 */
@Incubating
public interface Snapshotter extends Configurable {

    /**
     * @return the name of the snapshotter.
     *
     *
     */
    String name();

    /**
     * @param offsetExists is {@code true} when the connector has an offset context (i.e. restarted)
     * @param snapshotInProgress is {@code true} when the connector is started, but a snapshot is already in progress
     *
     * @return {@code true} if the snapshotter should take a data snapshot
     */
    boolean shouldSnapshotData(boolean offsetExists, boolean snapshotInProgress);

    /**
     * @param offsetExists is {@code true} when the connector has an offset context (i.e. restarted)
     * @param snapshotInProgress is {@code true} when the connector is started, but a snapshot is already in progress
     *
     * @return {@code true} if the snapshotter should take a schema snapshot
     */
    boolean shouldSnapshotSchema(boolean offsetExists, boolean snapshotInProgress);

    /**
     * @return {@code true} if the snapshotter should stream after taking a snapshot
     */
    boolean shouldStream();

    /**
     * @return {@code true} whether the schema can be recovered if database schema history is corrupted.
     */
    boolean shouldSnapshotOnSchemaError();

    /**
     * @return {@code true} whether the snapshot should be re-executed when there is a gap in data stream.
     */
    boolean shouldSnapshotOnDataError();

    /**
     *
     * @return {@code true} if streaming should resume from the start of the snapshot
     * transaction, or {@code false} for when a connector resumes and takes a snapshot,
     * streaming should resume from where streaming previously left off.
     */
    default boolean shouldStreamEventsStartingFromSnapshot() {
        return true;
    }

    /**
     * Lifecycle hook called after the snapshot phase is successful.
     */
    default void snapshotCompleted() {
        // no operation
    }

    /**
     * Lifecycle hook called after the snapshot phase is aborted.
     */
    default void snapshotAborted() {
        // no operation
    }
}

io.debezium.snapshot.spi.SnapshotQuery interface. All built-in snapshot query modes implement this interface.

/**
 * {@link SnapshotQuery} is used to determine the query used during a data snapshot
 *
 *
 */
public interface SnapshotQuery extends Configurable, Service {

    /**
     * @return the name of the snapshot lock.
     *
     *
     */
    String name();

    /**
     * Generate a valid query string for the specified table, or an empty {@link Optional}
     * to skip snapshotting this table (but that table will still be streamed from)
     *
     * @param tableId the table to generate a query for
     * @param snapshotSelectColumns the columns to be used in the snapshot select based on the column
     *                              include/exclude filters
     * @return a valid query string, or none to skip snapshotting this table
     */
    Optional<String> snapshotQuery(String tableId, List<String> snapshotSelectColumns);

}

io.debezium.snapshot.spi.SnapshotLock interface. All built-in snapshot lock modes implement this interface.

/**
 * {@link SnapshotLock} is used to determine the table lock mode used during schema snapshot
 *
 *
 */
public interface SnapshotLock extends Configurable, Service {

    /**
     * @return the name of the snapshot lock.
     *
     *
     */
    String name();

    /**
     * Returns a SQL statement for locking the given table during snapshotting, if required by the specific snapshotter
     * implementation.
     */
    Optional<String> tableLockingStatement(Duration lockTimeout, String tableId);

}

Blocking snapshots

A blocking snapshot lets you capture a complete, consistent snapshot of a table on demand while the connector is running, temporarily pausing streaming until the snapshot completes. Blocking snapshots rely on the Debezium mechanism for sending signals to a Debezium connector.

A blocking snapshot behaves just like an initial snapshot, except that you can trigger it at run time.

You might want to run a blocking snapshot rather than use the standard initial snapshot process in the following situations:

• You add a new table and you want to complete the snapshot while the connector is running.
• You add a large table, and you want the snapshot to complete in less time than is possible with an incremental snapshot.

Blocking snapshot process

When you run a blocking snapshot, Debezium stops streaming, and then initiates a snapshot of the specified table, following the same process that it uses during an initial snapshot. After the snapshot completes, the streaming is resumed.

Configure snapshot

You can set the following properties in the data component of a signal:

• data-collections: to specify which tables must be snapshot.

• data-collections: Specifies the tables that you want the snapshot to include. This property accepts a comma-separated list of regular expressions that match fully-qualified table names. The behavior of the property is similar to the behavior of the table.include.list property, which specifies the tables to capture in a blocking snapshot.

• additional-conditions: You can specify different filters for different table.

  • The data-collection property is the fully-qualified name of the table for which the filter will be applied, and can be case-sensitive or case-insensitive depending on the database.
  • The filter property will have the same value used in the snapshot.select.statement.overrides, the fully-qualified name of the table that should match by case.

For example:

  {"type": "blocking", "data-collections": ["schema1.table1", "schema1.table2"], "additional-conditions": [{"data-collection": "schema1.table1", "filter": "SELECT * FROM [schema1].[table1] WHERE column1 = 0 ORDER BY column2 DESC"}, {"data-collection": "schema1.table2", "filter": "SELECT * FROM [schema1].[table2] WHERE column2 > 0"}]}

Possible duplicates

A delay might exist between the time that you send the signal to trigger the snapshot, and the time when streaming stops and the snapshot starts. As a result of this delay, after the snapshot completes, the connector might emit some event records that duplicate records captured by the snapshot.

Change stream records

After a complete snapshot, when a Debezium Informix connector starts for the first time, the connector starts consuming change stream records for the source tables that are in capture mode. The connector performs the following actions:

1. Reads available change records from the current LSN.
2. Groups records by transaction Id and orders them according to the change LSN for each record.
3. Processes records as transactions are committed.
4. Passes begin, commit and change LSNs as offsets to Kafka Connect.
5. Stores the highest commit LSN and the lowest, uncommitted begin LSN that the connector passed to Kafka Connect.

After a restart, the connector resumes emitting change events from the offset (begin, commit and change LSNs) where it left off. As it resumes normal activity, the connector performs the following steps, in order:

1. Reads change records that were created between the last stored, lowest uncommitted begin LSN and the current LSN.
2. Groups records by transaction Id and ordering them according to the change LSN for each event.
3. Discards already processed transactions (commit LSN lower than last stored commit LSN).
4. Discards already processed records of the last incompletely processed transaction, if any (change LSN lower than last stored change LSN and commit LSN equal to last stored commit LSN).
5. Processes the remaining records of any incompletely processed transaction.
6. Continues processing records as transactions are committed.

Topic names

By default, the Informix connector writes change events for all of the INSERT, UPDATE, and DELETE operations that occur in a table to a single Apache Kafka topic that is specific to that table. The connector uses the following convention to name change event topics:

topicPrefix.schemaName.tableName

The following list provides definitions for the components of the default name:

topicPrefix

The topic prefix as specified by the topic.prefix connector configuration property.

schemaName

The name of the database schema in which the operation occurred.

tableName

The name of the database table in which the operation occurred.

For example, consider an Informix installation with a mydatabase database that contains the following tables in the myschema schema:

• products

• products_on_hand

• customers

• orders

  The connector would emit events to the following Kafka topics:

• mydatabase.myschema.products

• mydatabase.myschema.products_on_hand

• mydatabase.myschema.customers

• mydatabase.myschema.orders

The connector applies similar naming conventions to label its internal database schema history topics, schema change topics, and transaction metadata topics.

If the default topic names do not meet your requirements, you can configure custom topic names. To configure custom topic names, you specify regular expressions in the logical topic routing SMT. For more information about using the logical topic routing SMT to customize topic naming, see Topic routing.

Schema history topic

When a database client queries a database, the client uses the database’s current schema. However, the database schema can be changed at any time, which means that the connector must be able to identify what the schema was at the time that each insert, update, or delete operation was recorded. Also, a connector cannot necessarily apply the current schema to every event. If an event is relatively old, it’s possible that it was recorded before the current schema was applied.

To ensure correct processing of events that occur after a schema change, the Debezium Informix connector stores a snapshot of the new schema based on the structures of the Informix change data tables, which mirror the structures of their associated data tables. The connector stores the table schema information, together with the LSN of operations the result in schema changes, in the database schema history Kafka topic. The connector uses the stored schema representation to produce change events that correctly mirror the structure of tables at the time of each insert, update, or delete operation.

When the connector restarts after either a crash or a graceful stop, it resumes reading entries in the Informix change data tables from the last position that it read. Based on the schema information that the connector reads from the database schema history topic, the connector applies the table structures that existed at the position where the connector restarts.

If you update the schema of an Informix table that is in capture mode, it’s important that you also update the schema of the corresponding change table. You must be a Informix database administrator with elevated privileges to update database schema. For more information about how to update Informix database schema in Debezium environments, see Schema history evolution.

The database schema history topic is for internal connector use only. Optionally, the connector can also emit schema change events to a different topic that is intended for consumer applications.

Additional resources

• Default names for topics that receive Debezium event records.

Schema change topic

You can configure a Debezium Informix connector to produce schema change events that describe schema changes that are applied to tables in the database.

Debezium emits a message to the schema change topic after the following operations occur in the source database:

• You enable Debezium to capture changes from a new table.
• You disable capture for a table from which Debezium previously captured changes.

The connector writes schema change events to a Kafka schema change topic that has the name <topicPrefix> where <topicPrefix> is the topic prefix that is specified in the topic.prefix connector configuration property.

The schema for the schema change event has the following elements:

name

The name of the schema change event message.

type

The type of the change event message.

version

The version of the schema. The version is an integer that is incremented each time the schema is changed.

fields

The fields that are included in the change event message.

Example: Schema of the Informix connector schema change topic

The following example shows a typical schema in JSON format.

{
  "schema": {
    "type": "struct",
    "fields": [
      {
        "type": "string",
        "optional": false,
        "field": "databaseName"
      }
    ],
    "optional": false,
    "name": "io.debezium.connector.informix.SchemaChangeKey",
    "version": 1
  },
  "payload": {
    "databaseName": "inventory"
  }
}

Messages that the connector sends to the schema change topic contain a payload that includes the following elements:

databaseName

The name of the database to which the statements are applied. The value of databaseName serves as the message key.

pos

The position in the transaction log where the statements appear.

tableChanges

A structured representation of the entire table schema after the schema change. The tableChanges field contains an array that includes entries for each column of the table. Because the structured representation presents data in JSON or Avro format, consumers can easily read messages without first processing them through a DDL parser.

Never partition the database schema history topic. For the database schema history topic to function correctly, it must maintain a consistent, global order of the event records that the connector emits to it.

To ensure that the topic is not split among partitions, set the partition count for the topic by using one of the following methods:

• If you create the database schema history topic manually, specify a partition count of 1.
• If you use the Apache Kafka broker to create the database schema history topic automatically, the topic is created, set the value of the Kafka num.partitions configuration option to 1.

Example: Message emitted to the Informix connector schema change topic

The following example shows a message in the schema change topic. The message contains a logical representation of the table schema.

{
  "schema": {
  ...
  },
  "payload": {
    "source": {
      "version": "3.6.3.Final",
      "connector": "informix",
      "name": "informix",
      "ts_ms": 1588252618953,
      "snapshot": "true",
      "db": "testdb",
      "schema": "informix",
      "table": "customers",
      "commit_lsn": "0",
      "change_lsn": "0",
      "txId": null,
      "begin_lsn": "0"
    },
    "ts_ms": 1588252618953,
    "databaseName": "testdb",
    "schemaName": "informix",
    "ddl": null,
    "tableChanges": [
      {
        "type": "CREATE",
        "id": "\"testdb\".\"informix\".\"customers\"",
        "table": {
          "defaultCharsetName": null,
          "primaryKeyColumnNames": [
            "id"
          ],
          "columns": [
            {
              "name": "id",
              "jdbcType": 4,
              "nativeType": null,
              "typeName": "int identity",
              "typeExpression": "int identity",
              "charsetName": null,
              "length": 10,
              "scale": 0,
              "position": 1,
              "optional": false,
              "autoIncremented": false,
              "generated": false
            },
            {
              "name": "first_name",
              "jdbcType": 12,
              "nativeType": null,
              "typeName": "varchar",
              "typeExpression": "varchar",
              "charsetName": null,
              "length": 255,
              "scale": null,
              "position": 2,
              "optional": false,
              "autoIncremented": false,
              "generated": false
            },
            {
              "name": "last_name",
              "jdbcType": 12,
              "nativeType": null,
              "typeName": "varchar",
              "typeExpression": "varchar",
              "charsetName": null,
              "length": 255,
              "scale": null,
              "position": 3,
              "optional": false,
              "autoIncremented": false,
              "generated": false
            },
            {
              "name": "email",
              "jdbcType": 12,
              "nativeType": null,
              "typeName": "varchar",
              "typeExpression": "varchar",
              "charsetName": null,
              "length": 255,
              "scale": null,
              "position": 4,
              "optional": false,
              "autoIncremented": false,
              "generated": false
            }
          ],
          "attributes": [
            {
              "customAttribute": "attributeValue"
            }
          ]
        }
      }
    ]
  }
}

The following list describes select fields in the preceding schema change message:

ts_ms

Optional field that displays the time at which the connector processed the event. The time is based on the system clock in the JVM running the Kafka Connect task.

In the source object, ts_ms indicates the time that the change was made in the database. To determine the time lag between when a change occurs at the source database and when Debezium processes the change, compare the values for payload.source.ts_ms and payload.ts_ms.

databaseName, schemaName

Identifies the database and the schema that contain the change.

ddl

Always null for the Informix connector. For other connectors, this field contains the DDL responsible for the schema change. This DDL is not available to Informix connectors.

tableChanges

An array of one or more items that contain the schema changes generated by a DDL command.

tableChanges.type

Describes the type of change. The field contains one of the following values:

tableChanges.id

Full identifier of the table that was created, altered, or dropped.

tableChanges.table

Represents table metadata after the applied change.

tableChanges.table.primaryKeyColumnNames

List of columns that comprise the table’s primary key.

tableChanges.table.columns

Metadata for each column in the changed table.

tableChanges.table.attributes

Custom attribute metadata for each table change.

In messages that the connector sends to the schema change topic, the message key is the name of the database that contains the schema change. In the following example, the payload field contains the key:

{
  "schema": {
    "type": "struct",
    "fields": [
      {
        "type": "string",
        "optional": false,
        "field": "databaseName"
      }
    ],
    "optional": false,
    "name": "io.debezium.connector.informix.SchemaChangeKey",
    "version": 1
  },
  "payload": {
    "databaseName": "testdb"
  }
}

Transaction metadata

Debezium can generate events that represent transaction boundaries and that enrich change event messages.

Limits on when Debezium receives transaction metadata

Debezium registers and receives metadata only for transactions that occur after you deploy the connector. Metadata for transactions that occur before you deploy the connector is not available.

Debezium generates transaction boundary events for the BEGIN and END delimiters in every transaction. Transaction boundary events contain the following fields:

status

BEGIN or END.

id

String representation of the unique transaction identifier composed of Informix transaction ID itself and LSN of given operation separated by colon, i.e. the format is txID:LSN.

ts_ms

The time of a transaction boundary event (BEGIN or END event) at the data source. If the data source does not provide Debezium with the event time, then the field instead represents the time at which Debezium processes the event.

event_count (for END events)

Total number of events emmitted by the transaction.

data_collections (for END events)

An array of pairs of data_collection and event_count elements that indicates the number of events that the connector emits for changes that originate from a data collection.

Example

{
  "status": "BEGIN",
  "id": "571:53195829",
  "ts_ms": 1486500577125,
  "event_count": null,
  "data_collections": null
}

{
  "status": "END",
  "id": "571:53195832",
  "ts_ms": 1486500577691,
  "event_count": 2,
  "data_collections": [
    {
      "data_collection": "testdb.informix.tablea",
      "event_count": 1
    },
    {
      "data_collection": "testdb.informix.tableb",
      "event_count": 1
    }
  ]
}

By default, the connector emits transaction events to the <topic.prefix>.transaction topic. You can override the default setting by changing the value of the topic.transaction property.

Data change event enrichment

When transaction metadata is enabled, the connector enriches the change event Envelope with a new transaction field. This field provides information about every event in the form of a composite of fields:

id

String representation of unique transaction identifier.

total_order

The absolute position of the event among all events generated by the transaction.

data_collection_order

The per-data collection position of the event among all events that were emitted by the transaction.

Following is an example of a message:

{
  "before": null,
  "after": {
    "pk": "2",
    "aa": "1"
  },
  "source": {
    ...
  },
  "op": "c",
  "ts_ms": "1580390884335",
  "ts_us": "1580390884335641",
  "ts_ns": "1580390884335641387",
  "transaction": {
    "id": "571:53195832",
    "total_order": "1",
    "data_collection_order": "1"
  }
}

Data change events

The Debezium Informix connector generates a data change event for each row-level INSERT, UPDATE, and DELETE operation. Each event contains a key and a value. The structure of the key and the value depends on the table that was changed.

Debezium and Kafka Connect are designed for processing continuous streams of event messages. However, because the structure of these events might change over time, consumers might encounter difficulties when processing some Debezium events. To address this challenge, each event is designed to be self-contained. That is, the event contains either the schema for its content, or, in environments that use a schema registry, a schema ID that the consumer can use to obtain the schema from the registry.

The JSON structure in the following example shows how a typical Debezium event record represents the four basic four components of change event. The exact representation an event depends on the Kafka Connect converter that you configure for use with your application. A schema field is present in a change event only when you configure the converter to produce it. Likewise, the event key and event payload are present a change event only if you configure the converter to produce them. If you use the JSON converter, and you configure it to produce all four basic change event parts, change events have the following structure:

{
 "schema": {
   ...
  },
 "payload": {
   ...
 },
 "schema": {
   ...
 },
 "payload": {
   ...
 },
}

The following list describes the fields in the preceding basic change event:

`schema

The first schema field is part of the event key. It specifies the Kafka Connect schema that describes the structure of the content in the payload portion of the event key. In other words, for tables in which a change occurs, the first schema field describes the structure of the primary key, or of the table’s unique key if no primary key is defined.

payload

The first payload field is part of the event key. Its structure is described by the preceding schema field, and it specifies the key of the row where the change occurred.

schema

The second schema field is part of the event value. It specifies the Kafka Connect schema that describes the structure of the event value payload. In other words, the second schema describes the structure of the row that was changed. Typically, the event value schema contains nested schemas.

payload

The second payload field is part of the event value. It has the structure described in the event value schema field, and it contains the actual data for the row that was changed.

By default, the connector streams change event records to topics with names that are the same as the event’s originating table. For more information, see topic names.

The Debezium Informix connector ensures that all Kafka Connect schema names adhere to the Avro schema name format. Conforming to the Avro schema name format means that the logical server name starts with a Latin letter, or with an underscore, that is, a-z,` A-Z`, or _. Each remaining character in the logical server name, and each character in the database and table names, must be a Latin letter, a digit, or an underscore, that is, a-z, A-Z,0-9, or \_. If there is an invalid character, it is replaced with an underscore character.

The use of underscores to replace invalid characters can lead to unexpected conflicts. For example, a conflict can result when the name of a logical server, a database, or a table contains one or more invalid characters, and those characters are the only characters that distinguish the name from the name of another entity of the same type.

Naming conflicts can also occur, because the names of databases, schemas, and tables in Informix can be case-sensitive. In some cases, the connector might emit event records from more than one table to the same Kafka topic.

Change event keys

A change event’s key contains the schema for the changed table’s key and the changed row’s actual key. Both the schema and its corresponding payload contain a field for each column in the changed table’s PRIMARY KEY (or unique constraint) at the time the connector created the event.

Consider the following customers table, which is followed by an example of a change event key for this table.

Example table

CREATE TABLE customers (
 id INTEGER IDENTITY(1001,1) NOT NULL PRIMARY KEY,
 first_name VARCHAR(255) NOT NULL,
 last_name VARCHAR(255) NOT NULL,
 email VARCHAR(255) NOT NULL UNIQUE
);

Example change event key

When Debezium captures a change from the customers table, it emits a change event record that contains the event key schema. As long as the definition of the customers table remains unchanged, every change that Debezium captures from the customers table results in an event record that has the same key structure. The following example shows a JSON representation of the event structure:

{
    "schema": {
        "type": "struct",
        "fields": [
            {
                "type": "int32",
                "optional": false,
                "field": "ID"
            }
        ],
        "optional": false,
        "name": "mydatabase.myschema.customers.Key"
    },
    "payload": {
        "ID": 1004
    }
}

The following list describes fields in the preceding change event key JSON object:

schema

Represents the schema field of the event key, which shows the Kafka Connect schema that describes the structure of the event key payload.

schema.fields

An array of field definitions that are defined for the payload. Each field definition includes the field’s name, type, and whether it is required.

schema.fields[].type

Specifies the data type of a field in the payload. In this example, int32 indicates a 32-bit integer.

schema.fields[].optional

Indicates whether the field can contain a null value. In this example, the false value indicates that the field is required and it cannot be null. A value in the key’s payload field is optional when a table does not have a primary key.

schema.fields[].field

Specifies the name of the field in the payload. In this example, the field name is ID.

schema.name

Specifies the name of the schema that defines the structure of the key’s payload. This schema describes the structure of the primary key for the table that was changed. Key schema names have the following format:

<connector-name>.<database-name>.<table-name>.Key.

The schema name in the preceding example is comprised of the following elements:

connector-name

mydatabase: The name of the connector that generated this event.

database-name

myschema: The database schema that contains the table that was changed.

table-name

customers: The name of the table that was updated.

payload

Specifies the key of the table row in which the change event occurred. In the preceding example, the key contains a single ID field whose value is 1004.

Change event values

The value in a change event is a bit more complicated than the key. Like the event key, the value includes a schema element and a payload element. The schema element contains the schema that describes the Envelope structure of the payload element, including its nested fields. Change events for operations that create, update or delete data all have a value payload with an envelope structure.

Consider the sample `customers`table that was used in the earlier example of a change event key:

Example table

CREATE TABLE customers (
 id INTEGER IDENTITY(1001,1) NOT NULL PRIMARY KEY,
 first_name VARCHAR(255) NOT NULL,
 last_name VARCHAR(255) NOT NULL,
 email VARCHAR(255) NOT NULL UNIQUE
);

The value element of every change event that Debezium captures from the customers table uses the same schema. The payload of each event value varies according to the event type:

• create events
• update events
• delete events

create events

A create event represents a row-level INSERT operation, capturing the full state of the newly inserted row in the 1after` field of the event payload.

The following example shows the value portion of a change event that the connector generates for an operation that creates data in the customers table:

{
  "schema": {
    "type": "struct",
    "fields": [
      {
        "type": "struct",
        "fields": [
          {
            "type": "int32",
            "optional": false,
            "field": "id"
          },
          {
            "type": "string",
            "optional": false,
            "field": "first_name"
          },
          {
            "type": "string",
            "optional": false,
            "field": "last_name"
          },
          {
            "type": "string",
            "optional": false,
            "field": "email"
          }
        ],
        "optional": true,
        "name": "mydatabase.myschema.customers.Value",
        "field": "before"
      },
      {
        "type": "struct",
        "fields": [
          {
            "type": "int32",
            "optional": false,
            "field": "id"
          },
          {
            "type": "string",
            "optional": false,
            "field": "first_name"
          },
          {
            "type": "string",
            "optional": false,
            "field": "last_name"
          },
          {
            "type": "string",
            "optional": false,
            "field": "email"
          }
        ],
        "optional": true,
        "name": "mydatabase.myschema.customers.Value",
        "field": "after"
      },
      {
        "type": "struct",
        "fields": [
          {
            "type": "string",
            "optional": false,
            "field": "version"
          },
          {
            "type": "string",
            "optional": false,
            "field": "connector"
          },
          {
            "type": "string",
            "optional": false,
            "field": "name"
          },
          {
            "type": "int64",
            "optional": false,
            "field": "ts_ms"
          },
          {
            "type": "int64",
            "optional": false,
            "field": "ts_us"
          },
          {
            "type": "int64",
            "optional": false,
            "field": "ts_ns"
          },
          {
            "type": "boolean",
            "optional": true,
            "default": false,
            "field": "snapshot"
          },
          {
            "type": "string",
            "optional": false,
            "field": "db"
          },
          {
            "type": "string",
            "optional": false,
            "field": "schema"
          },
          {
            "type": "string",
            "optional": false,
            "field": "table"
          },
          {
            "type": "string",
            "optional": true,
            "field": "commit_lsn"
          },
          {
            "type": "string",
            "optional": true,
            "field": "change_lsn"
          },
          {
            "type": "string",
            "optional": true,
            "field": "txId"
          },
          {
            "type": "string",
            "optional": true,
            "field": "begin_lsn"
          }
        ],
        "optional": false,
        "name": "io.debezium.connector.informix.Source",
        "field": "source"
      },
      {
        "type": "string",
        "optional": false,
        "field": "op"
      },
      {
        "type": "int64",
        "optional": true,
        "field": "ts_ms"
      },
      {
        "type": "int64",
        "optional": true,
        "field": "ts_us"
      },
      {
        "type": "int64",
        "optional": true,
        "field": "ts_ns"
      }
    ],
    "optional": false,
    "name": "mydatabase.myschema.customers.Envelope"
  },
  "payload": {
    "before": null,
    "after": {
      "id": 1005,
      "first_name": "john",
      "last_name": "doe",
      "email": "[email protected]"
    },
    "source": {
      "version": "3.6.3.Final",
      "connector": "informix",
      "name": "myconnector",
      "ts_ms": 1559729468470,
      "ts_us": 1559729468470000,
      "ts_ns": 1559729468470000000,
      "snapshot": false,
      "db": "mydatabase",
      "schema": "myschema",
      "table": "customers",
      "commit_lsn": "627404540760620",
      "change_lsn": "627404540485812",
      "txId": "157",
      "begin_lsn": "627404540372400"
    },
    "op": "c",
    "ts_ms": 1559729471739,
    "ts_us": 1559729471739241,
    "ts_ns": 1559729471739241367
  }
}

The following list describes the fields in the preceding create event value:

schema

Represents the schema field of the change event value, which shows the Kafka Connect schema that describes the structure of the event payload. The schema of a change event value is the same for every change event that the connector generates for a particular table.

schema.type

Specifies the schema type. The struct value indicates that the schema defines a structured data type with multiple fields.

schema.fields

An array of field definitions for the payload. Each field definition describes a top-level field in the payload, including before, after, source, op, and timestamp fields.

schema.fields.name

io.debezium.connector.informix.Source is the schema for the payload’s source field. This schema is specific to the Informix connector. The connector uses it for all events that it generates.

schema.optional

Indicates whether the change event value must contain a payload. The false value indicates that the payload is required.

schema.name

Specifies the name of the schema that defines the structure of the change event’s payload. Change event value schema names have the following format:

<connector-name>.<database-name>.<table-name>.Envelope.

In this example, mydatabase.myschema.customers.Envelope indicates the envelope schema for the customers table.

payload

The actual data of the change event. The information in the payload illustrates how the event changed data in a table row. It provides the row state before and after the change, as well as source metadata, operation type, and timestamps.

payload.before

An optional field that specifies the state of the row before the event occurred. For create (insert) operations, this field is always null because the row did not exist before the insertion.

payload.after

An optional field that specifies the state of the row after the event occurred. For create operations, this field contains the values of all columns in the newly inserted row. In this example, it shows the new row with id 1005, first_name john, last_name doe, and email [email protected].

payload.source

A mandatory field that describes the source metadata for the event. The source structure shows Informix metadata for this change, which provides traceability. You can use information in the source element to compare events within a topic, or in different topics to understand whether this event occurred before, after, or as part of the same commit as other events. This field contains information about the database, table, and transaction context where the change occurred.

payload.source.connector

The type of connector that generated the event. In this example, informix indicates that the Debezium Informix connector emitted the event.

payload.op

A mandatory string field that describes the type of operation that caused the event. In this example, c indicates a create (insert) operation.

payload.ts_ms

The timestamp (in milliseconds since the Unix epoch) when the connector processed the event. The time is based on the system clock in the JVM that runs the Kafka Connect task.

payload.ts_us

The timestamp (in microseconds since the Unix epoch) when the connector processed the event.

payload.ts_ns

The timestamp (in nanoseconds since the Unix epoch) when the connector processed the event.

update events

An update event represents a row-level UPDATE operation, capturing both the row state before the change in the before field and the new row state after the change in the after field.

The value of a change event for an update in the sample customers table has the same schema as a create event for that table. Similarly, the payload of the value of an update event has a structure that is mirrors the structure of the value payload in a create event. However, the value payloads of_update_ events and create events do not include the same values. The following example shows the change event value for an event record that the connector generates in response to an update in the customers table:

{
  "schema": { ... },
  "payload": {
    "before": {
      "id": 1005,
      "first_name": "john",
      "last_name": "doe",
      "email": "[email protected]"
    },
    "after": {
      "ID": 1005,
      "first_name": "john",
      "last_name": "doe",
      "email": "[email protected]"
    },
    "source": {
      "version": "3.6.3.Final",
      "connector": "informix",
      "name": "myconnector",
      "ts_ms": 1559729995937,
      "ts_us": 1559729995937000,
      "ts_ns": 1559729995937000000,
      "snapshot": false,
      "db": "mydatabase",
      "schema": "myschema",
      "table": "customers",
      "commit_lsn": "627404540760620",
      "change_lsn": "627404540485812",
      "txId": "157",
      "begin_lsn": "627404540372400"
    },
    "op": "u",
    "ts_ms": 1559729998706,
    "ts_us": 1559729998706742,
    "ts_ns": 1559729998706742877
  }
}

The following list describes the fields in the preceding update event value:

payload.before

An optional field that represents the state of the row before an event occurs. When present, it contains an object with fields that represent the column values before the change. In this example, it shows the row state before the update, including the original email address [email protected].

payload.after

An optional field that represents the state of the row after an event occurs. When present, it contains an object with fields that represent the column values after the change. In this example, it shows the row state after the update, including the new email address [email protected].

payload.source

A mandatory field that describes the source metadata for the event. This field contains information about the database, table, and transaction context where the change occurred.

payload.op

A mandatory string field that describes the type of operation that caused the event. The value u indicates that this row changed because of an update.

payload.ts_ms

The timestamp (in milliseconds since the Unix epoch) when the connector processed the event. The time is based on the system clock in the JVM that runs the Kafka Connect task. This represents when Debezium created the change event message, not when the change occurred in the database.

payload.ts_us

The timestamp (in microseconds since the Unix epoch) when the connector processed the event.

payload.ts_ns

The timestamp (in nanoseconds since the Unix epoch) when the connector processed the event.

If you update the columns for a row’s primary or unique key, you change the value of the row’s key. After a key change, Debezium emits the following events:

• A DELETE event
• A tombstone event , with the old key for the row
• An event that contains the new key for the row.

delete events

A delete event represents a row-level DELETE operation, capturing the final state of the deleted row in the before field so that consumers can identify and process the removal.

The value in a delete change event for a table has a schema portion that is similar to the schema element in create and update events for the same table. After a user performs a delete operation in the sample customers table, Debezium emits an event message such as the one in the following example:

{
  "schema": { ... },
  },
  "payload": {
    "before": {
      "id": 1005,
      "first_name": "john",
      "last_name": "doe",
      "email": "[email protected]"
    },
    "after": null,
    "source": {
      "version": "3.6.3.Final",
      "connector": "informix",
      "name": "myconnector",
      "ts_ms": 1559730445243,
      "ts_us": 1559730445243000,
      "ts_ns": 1559730445243000000,
      "snapshot": false,
      "db": "mydatabase",
      "schema": "myschema",
      "table": "customers",
      "commit_lsn": "627404540760620",
      "change_lsn": "627404540485812",
      "txId": "157",
      "begin_lsn": "627404540372400"
    },
    "op": "d",
    "ts_ms": 1559730450205,
    "ts_us": 1559730450205104,
    "ts_ns": 1559730450205104870
  }
}

The following list describes the fields in the preceding delete event value:

payload.before

An optional field that represents the state of the row before an event occurs. For delete operations, this field contains the final state of the row before it was deleted. In this example, it shows the row values at the time of deletion, including id 1005 and email [email protected].

payload.after

An optional field that specifies the state of the row after an event occurs. For delete operations, this field is always null because the row no longer exists after the deletion.

payload.source

A mandatory field that describes the source metadata for the event. This field contains information about the database, table, and transaction context where the change occurred.

payload.op

Mandatory string that describes the type of operation. The value d indicates that this row was deleted.

payload.ts_ms

The timestamp (in milliseconds since the Unix epoch) when the connector processed the event. The time is based on the system clock in the JVM that runs the Kafka Connect task. This represents when Debezium created the change event message, not when the change occurred in the database.

payload.ts_us

The timestamp (in microseconds since the Unix epoch) when the connector processed the event.

payload.ts_ns

The timestamp (in nanoseconds since the Unix epoch) when the connector processed the event.

A delete change event record provides a consumer with the information that it needs to process the removal of the row. The record includes the previous values to support consumers that might require them to process the removal.

Informix connector events are designed to work with Kafka log compaction. Log compaction enables removal of some older messages as long as at least the most recent message for every key is kept. Retaining the most recent message enables Kafka to reclaim storage space while ensuring that the topic contains a complete data set that can be used for reloading key-based state.

When a row is deleted, the delete event value still works with log compaction, because Kafka can remove all earlier messages that have that same key. However, for Kafka to remove all messages that have that same key, the message value must be null. To make this possible, after Debezium’s Informix connector emits a delete event, the connector emits a special tombstone event that has the same key but a null value.

Data type mappings

For a complete description of the data types that Informix supports, see the Data Types section in the Informix documentation.

The following data types are not supported for data capture:

• Simple large objects (TEXT and BYTE data types)
• User-defined data types
• Collection data types (SET, MULTISET, LIST, and ROW data types)

For more information, see Data for capture in the Informix documentation.

The Informix connector represents changes to rows by emitting events whose structures mirror the structure of the source tables in which the change events occur. Event records contain fields for each column value. To populate values in these fields from the source columns, the connector uses a default mapping to convert the values from the original Informix data types to a Kafka Connect schema type or a semantic type. The connector provides default mappings for the following Informix data types:

• Basic types
• Temporal types
• Timestamp types
• Decimal types

If the default data type conversions do not meet your needs, you can create a custom converter for the connector.

Basic types

The following table describes how the connector maps each Informix data type to a literal type and a semantic type in event fields.

• literal type describes how the value is represented using Kafka Connect schema types: INT8, INT16, INT32, INT64, FLOAT32, FLOAT64, BOOLEAN, STRING, BYTES, ARRAY, MAP, and STRUCT.
• semantic type describes how the Kafka Connect schema captures the meaning of the field using the name of the Kafka Connect schema for the field.

Table 5. Mappings for Informix basic data types

Informix data type Literal type (schema type) Semantic type (schema name) and Notes

BIGINT

INT64

n/a

BIGSERIAL

INT64

n/a

BLOB

BYTES

n/a

BOOLEAN

BOOLEAN

n/a

CHAR[(N)]

STRING

n/a

CLOB

STRING

n/a

DATE

INT32

io.debezium.time.Date

A date without timezone information

DATETIME

INT64

io.debezium.time.Timestamp

A timestamp without timezone information

DECIMAL

BYTES

org.apache.kafka.connect.data.Decimal

DOUBLE

FLOAT64

n/a

FLOAT

FLOAT64

n/a

INTEGER

INT32

n/a

LVARCHAR[(N)]

STRING

n/a

NUMERIC

BYTES

org.apache.kafka.connect.data.Decimal

REAL

FLOAT32

n/a

SERIAL

INT32

n/a

SMALLINT

INT16

n/a

SMALLFLOAT

FLOAT32

n/a

TINYINT

INT16

8-bit unsigned integer value between 0 and 255, thus needs to be stored as int16

VARCHAR[(N)]

STRING

n/a

If present, a column’s default value is propagated to the corresponding field’s Kafka Connect schema. Change events contain the field’s default value unless an explicit column value is specified. Consequently, there is rarely a need to obtain the default value from the schema. Passing the default value helps satisfy compatibility rules when using Avro as the serialization format together with the Confluent schema registry.

Temporal types

Informix maps temporal types based on the value of the time.precision.mode connector configuration property. The following sections describe these mappings:

• time.precision.mode=adaptive
• time.precision.mode=connect
• time.precision.mode=isostring

time.precision.mode=adaptive

To ensure that events exactly represent the values in the database, when the time.precision.mode configuration property is set to the default value, adaptive, the connector determines the literal and semantic types based on the column’s data type definition.

Table 6. Mappings when time.precision.mode is adaptive

Informix data type Literal type (schema type) Semantic type (schema name) and Notes

DATE

INT32

io.debezium.time.Date

Represents the number of days since the epoch.

DATETIME

INT64

io.debezium.time.Timestamp

Represents the number of milliseconds since the epoch, and does not include timezone information.

time.precision.mode=connect

When the time.precision.mode configuration property is set to connect, the connector uses Kafka Connect logical types. This setting can be useful for consumers that can handle only the built-in Kafka Connect logical types, and that cannot handle variable-precision time values. However, because Informix supports tens of microsecond precision, if a connector is configured to use connect time precision, and the database column has a fractional second precision value that is greater than 3, the connector generates events that result in a loss of precision.

Table 7. Mappings when time.precision.mode is connect

Informix data type Literal type (schema type) Semantic type (schema name) and Notes

DATE

INT32

org.apache.kafka.connect.data.Date

Represents the number of days since the epoch.

DATETIME

INT64

org.apache.kafka.connect.data.Timestamp

Represents the number of milliseconds since the epoch, and does not include timezone information.

time.precision.mode=isostring

Set the time.precision.mode property to isostring to configure the connector to map temporal values as ISO-8601 formatted strings at the UTC time zone. When you apply this setting, the connector uses the semantic types io.debezium.time.IsoDate and io.debezium.time.IsoTimestamp to map date and timestamp values.

Table 8. Mappings when time.precision.mode is isostring

Informix data type Literal type (schema type) Semantic type (schema name) and Notes

DATE

STRING

io.debezium.time.IsoDate

Represents date values in UTC format, according to the ISO 8601 standard, for example, 2017-09-15Z.

DATETIME

STRING

io.debezium.time.IsoTimestamp

Represents timestamp values in UTC format, according to the ISO 8601 standard, for example, 2019-07-09T02:28:57.123456Z.

INTERVAL

The INTERVAL type is not supported by the Informix Change Stream client.

Timestamp types

The DATETIME type represents a timestamp without time zone information. Such columns are converted into an equivalent Kafka Connect value based on UTC. For example, the DATETIME value "2018-06-20 15:13:16.94514" is represented by an io.debezium.time.Timestamp with the value "1529507596000".

The timezone of the JVM running Kafka Connect and Debezium does not affect this conversion.

Decimal types

The following table describes how the connector maps Informix decimal data types to Kafka Connect literal types and semantic types in change event fields.

Informix data type Literal type (schema type) Semantic type (schema name) and Notes

NUMERIC[(P[,S])]

BYTES

org.apache.kafka.connect.data.Decimal

The scale schema parameter contains an integer that represents how many digits the decimal point is shifted. The connect.decimal.precision schema parameter contains an integer that represents the precision of the given decimal value.

DECIMAL[(P[,S])]

BYTES

org.apache.kafka.connect.data.Decimal

The scale schema parameter contains an integer that represents how many digits the decimal point is shifted. The connect.decimal.precision schema parameter contains an integer that represents the precision of the given decimal value.

Setting up Informix

For Debezium to capture change events that are committed to Informix tables, a Informix database administrator with the necessary privileges must configure the database for change data capture.

Perform the following tasks to prepare for using the Change Data Capture API:

1. As the database user informix, run the syscdcv1.sql script from the $INFORMIXDIR/etc directory. This will install the syscdcv1 database.
2. Verify that the syscdcv1 database exists by creating a connection to it as user informix.
3. Set the DB_LOCALE environment variable to be the same as the locale of the database from which you want to capture data.

Deployment

To deploy a Debezium Informix connector, you install the Debezium Informix connector archive, configure the connector, and start the connector by adding its configuration to Kafka Connect.

Prerequisites

• Apache Kafka and Kafka Connect are installed.
• Informix is installed and capture mode is enabled for tables to prepare the database to be used with the Debezium connector.

Procedure

1. Download the Debezium Informix connector plug-in archive from Maven Central.
2. Extract the JAR files into your Kafka Connect environment.
3. Download the JDBC driver for Informix and Informix Change Stream client from Maven Central, and copy the downloaded JAR files to the directory that contains the Debezium Informix connector JAR file (that is, debezium-connector-informix-3.6.3.Final.jar).

1. Add the directory with the JAR files to Kafka Connect’s plugin.path.
2. Restart your Kafka Connect process to pick up the new JAR files.

If you are working with immutable containers, see Debezium’s container images for Apache Kafka and Kafka Connect with the Informix connector already installed and ready to run.

You can also run Debezium on Kubernetes and OpenShift.

Next steps

• Configure the connector and add the configuration to your Kafka Connect cluster.

Informix connector configuration example

The following example shows the configuration for a connector instance that captures data from an Informix server with the logical name fullfillment on port 9088 at 192.168.99.100. Typically, you configure the Debezium Informix connector in a JSON file by setting the configuration properties that are available for the connector.

You can choose to produce events for a subset of the schemas and tables in a database. Optionally, you can ignore, mask, or truncate columns that contain sensitive data, that are larger than a specified size, or that you do not need.

{
  "name": "informix-connector",
  "config": {
    "connector.class": "io.debezium.connector.informix.InformixConnector",
    "database.hostname": "192.168.99.100",
    "database.port": "9088",
    "database.user": "informix",
    "database.password": "in4mix",
    "database.dbname": "mydatabase",
    "topic.prefix": "fullfillment",
    "table.include.list": "mydatabase.myschema.customers",
    "schema.history.internal.kafka.bootstrap.servers": "kafka:9092",
    "schema.history.internal.kafka.topic": "schemahistory.fullfillment"
  }
}

The following list describes the fields in the preceding configuration example:

name

Specifies the name of the connector as registered with the Kafka Connect service.

connector.class

Specifies the name of the Debezium connector class.

database.hostname

Specifies the address of the Informix instance.

database.port

Specifies the port number of the Informix instance.

database.user

Specifies the name of the Informix user.

database.password

Specifies the password for the Informix user.

database.dbname

Specifies the name of the database to capture changes from.

topic.prefix

Specifies the logical name of the Informix instance or cluster. This name forms a namespace that is used in the names of all Kafka topics to which the connector writes, the Kafka Connect schema names, and the namespaces of the corresponding Avro schema when the Avro Connector is used.

table.include.list

Specifies a list of all tables whose changes Debezium should capture.

schema.history.internal.kafka.bootstrap.servers

Specifies the list of Kafka brokers that this connector uses to write and recover DDL statements to the database schema history topic.

schema.history.internal.kafka.topic"

Specifies the name of the database schema history topic where the connector writes and recovers DDL statements. This topic is for internal use only and is not intended for direct use by consumers.

For the complete list of the configuration properties that you can set for the Debezium Informix connector, see Informix connector properties.

You can send this configuration with a POST command to a running Kafka Connect service. The service records the configuration and starts one connector task that performs the following actions:

• Connects to the Informix database.
• Reads change-data tables for tables that are in capture mode.
• Streams change event records to Kafka topics.

Adding connector configuration

To start running a Informix connector, create a connector configuration and add the configuration to your Kafka Connect cluster.

Prerequisites

• Informix replication is enabled to expose change data for tables that are in capture mode.
• The Informix connector is installed.

Procedure

1. Create a configuration for the Informix connector.
2. Use the Kafka Connect REST API to add that connector configuration to your Kafka Connect cluster.

Results

After the connector starts, it performs a consistent snapshot of the Informix database tables that the connector is configured to capture changes for. The connector then starts generating data change events for row-level operations and streaming change event records to Kafka topics.

Connector properties

The Debezium Informix connector has numerous configuration properties that you can use to achieve the right connector behavior for your application. Many properties have default values. Information about the properties is organized as follows:

• Required configuration properties

• Advanced configuration properties

• Database schema history connector configuration properties that control how Debezium processes events that it reads from the database schema history topic.

• Pass-through Informix connector configuration properties

  • Pass-through database schema history properties for configuring producer and consumer clients
  • Pass-through Kafka signals configuration properties
  • Pass-through Kafka signals consumer client configuration properties
  • Pass-through sink notification configuration properties
  • Pass-through database driver configuration properties

Required Debezium Informix connector configuration properties

The following configuration properties are required unless a default value is available.

Table 9. Required connector configuration properties

Property Default Description

name

No default

Unique name for the connector. You can register a connector with the specified name only once. Subsequent attempts result in failures. This property is required by all Kafka Connect connectors.

connector.class

No default

The name of the Java class for the connector. Always use the value io.debezium.connector.informix.InformixConnector for the Informix connector.

tasks.max

1

The maximum number of tasks that this connector can create. The Informix connector always uses a single task and therefore does not use this value, so the default is always acceptable.

database.hostname

No default

IP address or hostname of the Informix database server.

database.port

9088

Integer port number of the Informix database server.

database.user

No default

Name of the Informix database user for connecting to the Informix database server.

database.password

No default

Password to use when connecting to the Informix database server.

database.dbname

No default

The name of the Informix database from which to stream changes.

topic.prefix

No default

Topic prefix that provides a namespace for the particular Informix database server that hosts the database for which Debezium is capturing changes. The prefix should be unique across all other connectors, since it is used as a topic name prefix for all Kafka topics that receive records from this connector. Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name.

table.include.list

No default

An optional, comma-separated list of regular expressions that match fully-qualified table identifiers for tables whose changes you want the connector to capture. When this property is set, the connector captures changes only from the specified tables. Each identifier is of the form databaseName.schemaName.tableName. By default, the connector captures changes in every non-system table.

To match the name of a table, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire identifier for the table; it does not match substrings that might be present in a table name.

If you include this property in the configuration, do not also set the table.exclude.list property.

table.exclude.list

No default

An optional, comma-separated list of regular expressions that match fully-qualified table identifiers for tables whose changes you do not want to capture. The connector captures changes in each non-system table that is not included in the exclude list. Each identifier is of the form databaseName.schemaName.tableName.

To match the name of a table, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire identifier for the table it does not match substrings that might be present in a table name.

If you include this property in the configuration, do not also set the table.include.list property.

column.include.list

No default

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns to include in change event record values. The fully-qualified name of a column observes one of the following formats: databaseName.tableName.columnName, or databaseName.schemaName.tableName.columnName.

To match the name of a column, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire name string of the column; it does not match substrings that might be present in a column name. If you include this property in the configuration, do not also set the column.exclude.list property.

column.exclude.list

No default

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns to exclude from change event values. The fully-qualified name of a column observes one of the following formats: databaseName.tableName.columnName, or databaseName.schemaName.tableName.columnName.

To match the name of a column, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire name string of the column; it does not match substrings that might be present in a column name. Primary key columns are always included in the event’s key, the value that you set in this property would exclude them. If you include this property in the configuration, do not set the column.include.list property.

column.mask.hash.hashAlgorithm.with.salt.salt

n/a

An optional, comma-separated list of regular expressions that match the fully-qualified names of character-based columns. The fully-qualified name of a column observes one of the following formats: databaseName.tableName.columnName, or databaseName.schemaName.tableName.columnName.

To match the name of a column, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire name string of the column; the expression does not match substrings that might be present in a column name. In the resulting change event record, the values for the specified columns are replaced with pseudonyms.

A pseudonym consists of the hashed value that results from applying the specified hashAlgorithm and salt. Based on the hash function that is used, referential integrity is maintained, while column values are replaced with pseudonyms. Supported hash functions are described in the MessageDigest section of the Java Cryptography Architecture Standard Algorithm Name Documentation.

In the following example, CzQMA0cB5K is a randomly selected salt.

column.mask.hash.SHA-256.with.salt.CzQMA0cB5K = inventory.orders.customerName, inventory.shipment.customerName

If necessary, the pseudonym is automatically shortened to the length of the column. The connector configuration can include multiple properties that specify different hash algorithms and salts.

Depending on the hashAlgorithm used, the salt selected, and the actual data set, the resulting data set might not be completely masked.

time.precision.mode

adaptive

Specifies the numeric precision that the connector uses to represent time, date, and timestamps values. Specify one of the following values:

adaptive

Depending on the data type of the table column, the connector uses millisecond, microsecond, or nanosecond precision values to represent time and timestamp values exactly as they exist in the source table .

connect

The connector always represents Time, Date, and Timestamp values by using the default Kafka Connect format, which uses millisecond precision regardless of the precision that is configured for the column in the source table. For more information, see temporal types.

tombstones.on.delete

true

Specifies whether a delete event is followed by a tombstone event. Specify one of the following values:

true

For each delete operation, the connector emits a delete event, and a subsequent tombstone event. Select this option to ensure that Kafka can delete all events that pertain to the key of the deleted row. If tombstones are disabled, and log compaction is enabled for the destination topic, Kafka might be unable to identify and delete all events that share the key.

false

The connector emits only a delete event.

include.schema.changes

true

Boolean value that specifies whether the connector publishes changes in the database schema to a Kafka topic with the same name as the topic prefix. The connector records each schema change with a key that contains the database name, and a value that is a JSON structure that describes the schema update. This mechanism for recording schema changes is independent of the connector’s internal recording of changes to the database schema history.

column.truncate.to.length.chars

n/a

An optional, comma-separated list of regular expressions that match the fully-qualified names of character-based columns. Set this property if you want to truncate the data in a set of columns when it exceeds the number of characters specified by the length in the property name. Set length to a positive integer value, for example, column.truncate.to.20.chars.

The fully-qualified name of a column observes one of the following formats: databaseName.tableName.columnName, or databaseName.schemaName.tableName.columnName.

To match the name of a column, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire name string of the column; the expression does not match substrings that might be present in a column name.

You can specify multiple properties with different lengths in a single configuration.

column.mask.with.length.chars

n/a

An optional, comma-separated list of regular expressions that match the fully-qualified names of character-based columns. Set this property if you want the connector to mask the values for a set of columns, for example, if they contain sensitive data. Set length to a positive integer to replace data in the specified columns with the number of asterisk (*) characters specified by the length in the property name. Set length to 0 (zero) to replace data in the specified columns with an empty string.

The fully-qualified name of a column observes one of the following formats: databaseName.tableName.columnName, or databaseName.schemaName.tableName.columnName.

To match the name of a column, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire name string of the column; the expression does not match substrings that might be present in a column name.

You can specify multiple properties with different lengths in a single configuration.

column.propagate.source.type

n/a

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns for which you want the connector to emit extra parameters that represent column metadata. When this property is set, the connector adds the following fields to the schema of event records:

• __debezium.source.column.type
• __debezium.source.column.length
• __debezium.source.column.scale

These parameters propagate the original data type name along with applicable type attributes, such as length for variable‑width types, and scale for numeric types. Enabling the connector to emit this extra data can assist in properly sizing specific numeric or character-based columns in sink databases.

The fully-qualified name of a column observes one of the following formats: databaseName.tableName.columnName, or databaseName.schemaName.tableName.columnName.

To match the name of a column, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire name string of the column; the expression does not match substrings that might be present in a column name.

datatype.propagate.source.type

n/a

An optional, comma-separated list of regular expressions that specify the fully-qualified names of data types that are defined for columns in a database. When this property is set, for columns with matching data types, the connector emits event records that include the following extra fields in their schema:

• __debezium.source.column.type
• __debezium.source.column.length
• __debezium.source.column.scale

These parameters propagate the original data type name along with applicable type attributes, such as length for variable‑width types, and scale for numeric types. Enabling the connector to emit this extra data can assist in properly sizing specific numeric or character-based columns in sink databases.

The fully-qualified name of a column observes one of the following formats: databaseName.tableName.typeName, or databaseName.schemaName.tableName.typeName.

To match the name of a data type, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire name string of the data type; the expression does not match substrings that might be present in a type name.

For the list of Informix-specific data type names, see the Informix data type mappings .

message.key.columns

empty string

A list of expressions that specify the columns that the connector uses to form custom message keys for change event records that it publishes to the Kafka topics for specified tables.

By default, Debezium uses the primary key column of a table as the message key for records that it emits. In place of the default, or to specify a key for tables that lack a primary key, you can configure custom message keys based on one or more columns.

To establish a custom message key for a table, list the table, followed by the columns to use as the message key. Each list entry takes the following format:

<fully-qualified_tableName>:<keyColumn>,<keyColumn>

To base a table key on multiple column names, insert commas between the column names. Each fully-qualified table name is a regular expression in the following format:

<databaseName>.<schemaName>.<tableName>

The property can list entries for multiple tables. Use a semicolon to separate entries for different tables in the list.

The following example sets the message key for the tables inventory.customers and purchaseorders:

inventory.customers:pk1,pk2;(.*).purchaseorders:pk3,pk4

In the preceding example, the columns pk1 and pk2 are specified as the message key for the table inventory.customer. For purchaseorders tables in any schema, the columns pk3 and pk4 serve as the message key.

schema.name.adjustment.mode

none

Specifies how to adjust schema names for compatibility with the message converter that the connector uses. Specify one of the following values:

none

No adjustment.

avro

Replace characters that are not valid for the Avro type with an underscore (_).

avro_unicode

Replaces underscores or characters are not valid for the Avro type with the corresponding unicode, for example, _uxxxx.

Note: _ is an escape sequence, equivalent to a backslash in Java.

field.name.adjustment.mode

none

Specifies how to adjust field names for compatibility with the message converter that the connector uses. Specify one of the following values:

none

No adjustment.

avro

Replace characters that are not valid for the Avro type with an underscore (_).

avro_unicode

Replaces underscores or characters are not valid for the Avro type with the corresponding unicode, for example, _uxxxx.

Note: _ is an escape sequence, equivalent to a backslash in Java.

For more information about Avro compatibility, see Avro naming .

Advanced connector configuration properties

The following advanced configuration properties have defaults that work in most situations and therefore rarely need to be specified in the connector’s configuration.

Table 10. Advanced connector configuration properties

Property Default Description

converters

No default

Enumerates a comma-separated list of the symbolic names of the custom converter instances that the connector can use. For example,

isbn

You must set the converters property to enable the connector to use a custom converter.

For each converter that you configure for a connector, you must also add a .type property, which specifies the fully-qualified name of the class that implements the converter interface. The .type property uses the following format:

<converterSymbolicName>.type

For example,

isbn.type: io.debezium.test.IsbnConverter

If you want to further control the behavior of a configured converter, you can add one or more configuration parameters to pass values to the converter. To associate any additional configuration parameter with a converter, prefix the parameter names with the symbolic name of the converter. For example,

isbn.schema.name: io.debezium.informix.type.Isbn

snapshot.mode

initial

Specifies the criteria for performing a snapshot when the connector starts:

always

The connector performs a snapshot every time that it starts. The snapshot includes the structure and data of the captured tables. Specify this value to populate topics with a complete representation of the data from the captured tables every time that the connector starts. After the snapshot completes, the connector begins to stream event records for subsequent database changes.

initial

The connector performs a database snapshot as described in the default workflow for creating an initial snapshot. After the snapshot completes, the connector begins to stream event records for subsequent database changes.

initial_only

The connector performs a database a snapshot only when no offsets have been recorded for the logical server name. After the snapshot completes, the connector stops. It does not transition to streaming event records for subsequent database changes.

schema_only

Deprecated, see no_data.

no_data

The connector runs a snapshot that captures the structure of all relevant tables, performing all the steps described in the default snapshot workflow, except that it does not create READ events to represent the data set at the point of the connector’s start-up (Step 7.b).

recovery

Set this option to restore a database schema history topic that is lost or corrupted. After a restart, the connector runs a snapshot that rebuilds the topic from the source tables. You can also set the property to periodically prune a database schema history topic that experiences unexpected growth.

when_needed

After the connector starts, it performs a snapshot only if it detects one of the following circumstances:

• It cannot detect any topic offsets.
• A previously recorded offset specifies a log position that is not available on the server.

configuration_based

With this option, you control snapshot behavior through a set of connector properties that have the prefix 'snapshot.mode.configuration.based'.

custom

The custom snapshot mode lets you inject your own implementation of the io.debezium.spi.snapshot.Snapshotter interface. Set the snapshot.mode.custom.name configuration property to the name provided by the name() method of your implementation.

For more information, see custom snapshotter SPI.

snapshot.mode.configuration.based.snapshot.data

false

If the snapshot.mode is set to configuration_based, set this property to specify whether the connector includes table data when it performs a snapshot.

snapshot.mode.configuration.based.snapshot.schema

false

If the snapshot.mode is set to configuration_based, set this property to specify whether the connector includes the table schema when it performs a snapshot.

snapshot.mode.configuration.based.start.stream

false

If the snapshot.mode is set to configuration_based, set this property to specify whether the connector begins to stream change events after a snapshot completes.

snapshot.mode.configuration.based.snapshot.on.schema.error

false

If the snapshot.mode is set to configuration_based, set this property to specify whether the connector includes table schema in a snapshot if the schema history topic is not available.

snapshot.mode.configuration.based.snapshot.on.data.error

false

If the snapshot.mode is set to configuration_based, this property specifies whether the connector attempts to snapshot table data if it does not find the last committed offset in the transaction log.

Set the value to true to instruct the connector to perform a new snapshot.

snapshot.mode.custom.name

No default

If snapshot.mode is set to custom, use this setting to specify the name of the custom implementation that is provided in the name() method that is defined in the io.debezium.spi.snapshot.Snapshotter interface. After a connector restart, Debezium calls the specified custom implementation to determine whether to perform a snapshot.

For more information, see custom snapshotter SPI.

snapshot.locking.mode

exclusive

Controls whether and for how long the connector holds a table lock. Table locks prevent other database clients from performing certain table operations during a snapshot. You can set the following values:

exclusive

Controls how the connector holds locks on tables while performing the schema snapshot when snapshot.isolation.mode is REPEATABLE_READ or EXCLUSIVE. The connector holds a table lock that ensures exclusive table access during only the initial phase of the snapshot in which the connector reads the database schema and other metadata. In subsequent phases of the snapshot, the connector uses a flashback query, which requires no locks, to select all rows from each table.

share

Controls how the connector holds locks on tables while performing the schema snapshot when snapshot.isolation.mode is REPEATABLE_READ or EXCLUSIVE. The connector holds a read table lock that ensures read table access during only the initial phase of the snapshot in which the connector reads the database schema and other metadata. In subsequent phases of the snapshot, the connector uses a flashback query, which requires no locks, to select all rows from each table. If you prefer snapshots to run without setting any locks, set the following option, none.

none

Prevents the connector from acquiring any table locks during the snapshot. Use this setting only if no schema changes might occur during the creation of the snapshot.

custom

The connector performs a snapshot according to the implementation specified by the snapshot.locking.mode.custom.name property, which is a custom implementation of the io.debezium.spi.snapshot.SnapshotLock interface.

snapshot.locking.mode.custom.name

No default

When snapshot.locking.mode is set to custom, use this setting to specify the name of the custom locking implementation provided in the name() method that is defined by the io.debezium.spi.snapshot.SnapshotLock interface.

For more information, see custom snapshotter SPI.

snapshot.query.mode

select_all

Specifies how the connector queries data while performing a snapshot. Set one of the following options:

select_all

The connector performs a select all query by default, optionally adjusting the columns selected based on the column include and exclude list configurations.

custom

The connector performs a snapshot query according to the implementation specified by the snapshot.query.mode.custom.name property, which defines a custom implementation of the io.debezium.spi.snapshot.SnapshotQuery interface.

This setting enables you to manage snapshot content in a more flexible manner compared to using the snapshot.select.statement.overrides property.

snapshot.query.mode.custom.name

No default

When snapshot.query.mode is set to custom, use this setting to specify the name of the custom query implementation provided in the name() method that is defined by the io.debezium.spi.snapshot.SnapshotQuery interface.

For more information, see custom snapshotter SPI.

snapshot.isolation.mode

repeatable_read

During a snapshot, specifies the transaction isolation level and the length of time that the connector locks tables that are in capture mode. Specify one of the following values:

read_uncommitted

Does not prevent other transactions from updating table rows during an initial snapshot. This mode has no data consistency guarantees; some data might be lost or corrupted.

read_committed

Does not prevent other transactions from updating table rows during an initial snapshot. It is possible for a new record to appear twice: once in the initial snapshot, and once in the streaming phase. However, this consistency level is appropriate for data mirroring.

repeatable_read

Prevents other transactions from updating table rows during an initial snapshot. It is possible for a new record to appear twice: once in the initial snapshot,and once in the streaming phase. However, this consistency level is appropriate for data mirroring.

exclusive

Uses repeatable read isolation level but takes an exclusive lock for all tables to be read. This mode prevents other transactions from updating table rows during an initial snapshot. Only exclusive mode guarantees full consistency; the initial snapshot and streaming logs constitute a linear history.

cdc.timeout

5

Positive integer value that specifies the timeout behavior of a read call to the change stream client. Specify one of the following values:

<0

Do not timeout.

0

Return immediately if no data is available.

>=1

Specifies the number of seconds that the connector waits for data before it times out.

cdc.buffersize

65536

Positive integer value that specifies the maximum size of each batch of records that the Informix Change Stream Client processes.

cdc.max.records

64

Positive integer value that specifies the maximum number of CDC records that the Informix Change Stream Client processes.

cdc.stop.logging.on.close

true

Boolean value that specifies whether Informix should stop Full Row Logging of watched tables when streaming is closed.

cdc.return.empty.transactions

true

Boolean value that specifies whether the Debezium Informix connector emits records for empty transactions.

event.processing.failure.handling.mode

fail

Specifies how the connector handles exceptions during processing of events. Specify one of the following values:

fail

The connector logs the offset of the problematic event and stops processing.

warn

The connector logs the offset of the problematic event and continues processing with the next event.

skip

The connector skips the problematic event and continues processing with the next event.

poll.interval.ms

500 (0.5 seconds)

Positive integer value that specifies the number of milliseconds that the connector waits for new change events to appear before it starts processing a batch of events.

max.batch.size

2048

Positive integer value that specifies the maximum size of each batch of events that the connector processes.

max.queue.size

8192

Positive integer value that specifies the maximum number of records that the blocking queue can hold.

When Debezium reads events streamed from the database, it places the events in the blocking queue before it writes them to Kafka. The blocking queue can provide backpressure for reading change events from the database in cases where the connector ingests messages faster than it can write them to Kafka, or when Kafka becomes unavailable. Events that are held in the queue are disregarded when the connector periodically records offsets.

Always set the value of max.queue.size to be larger than the value of max.batch.size.

max.queue.size.in.bytes

0

A long integer value that specifies the maximum volume of the blocking queue in bytes. By default, volume limits are not specified for the blocking queue. To specify the number of bytes that the queue can consume, set this property to a positive long value. If max.queue.size is also set, writing to the queue is blocked when the size of the queue reaches the limit specified by either property. For example, if you set max.queue.size=1000, and max.queue.size.in.bytes=5000, writing to the queue is blocked after the queue contains 1000 records, or after the volume of the records in the queue reaches 5000 bytes.

heartbeat.interval.ms

0

Specifies the interval, in milliseconds, at which the connector sends heartbeat messages to a Kafka topic.

Heartbeat messages help to confirm that the connector is still processing the transaction log and to ensure that it commits the latest offset to Kafka.

Set this property to a positive integer to enable and schedule heartbeat messages. By default, the connector does not emit heartbeat messages.

In the absence of heartbeat messages, even if the database log receives a high volume of changes, unless these changes affect captured tables, the connector has no opportunity to commit the latest offset. Thus, if the connector restarts, it resumes reading the log from a stale offset, which could result in resending a large backlog of change event messages. By enabling heartbeats, you help to ensure that the connector sends the latest offset to Kafka even when few changes occur in monitored tables.

heartbeat.action.query

No default

Specifies a query that the connector executes on the source database when the connector sends a heartbeat message.

This is useful for resolving the situation where capturing changes from a low-traffic database on the same host as a high-traffic database prevents Debezium from updating its last commited/restart LSN before the physical log files rotate. To address this situation, create a heartbeat table in the low-traffic database, and set this property to a statement that inserts records into that table, for example:

INSERT INTO test_heartbeat_table (text) VALUES ('test_heartbeat')

This allows the connector to receive changes from the low-traffic database and update its last committed/restart LSN before the physical log files rotate.

snapshot.delay.ms

No default

An interval in milliseconds that the connector should wait before performing a snapshot when the connector starts. If you start multiple connectors in a cluster, this property is useful for avoiding snapshot interruptions, which might cause re-balancing of connectors.

statistics.metrics.enabled

true

Specifies whether the connector collects advanced statistical metrics for streaming metrics, such as quantiles. When set to true, the connector collects the following statistics:

• Minimum value
• Maximum value
• Average value
• P50 (median) percentile
• P95 percentile
• P99 percentile

The statistics are computed using a probabilistic data structure (DDSketch) that provides approximate quantile values with 1% relative accuracy. When set to false, the connector does not collect quantiles, and the quantile JMX metrics return null values. The connector continues to collect minimum, maximum, and average values. Disabling quantile collection reduces memory overhead slightly. For more information, see Streaming metrics.

streaming.delay.ms

0

Specifies the time, in milliseconds, that the connector delays the start of the streaming process after it completes a snapshot. Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins.

Set a delay value that is higher than the value of the offset.flush.interval.ms property that is set for the Kafka Connect worker.

snapshot.include.collection.list

All tables specified in table.include.list

An optional, comma-separated list of regular expressions that match the fully-qualified names (databaseName.schemaName.tableName) of the tables to include in a snapshot. The specified items must be named in the connector’s table.include.list property. This property takes effect only if the connector’s snapshot.mode property is set to a value other than no_data.

This property does not affect the behavior of incremental snapshots.

To match the name of a table, Debezium applies the regular expression that you specify as an anchored regular expression. That is, the specified expression is matched against the entire name string of the table; it does not match substrings that might be present in a table name.

snapshot.fetch.size

2000

During a snapshot, the connector reads table content in batches of rows. This property specifies the maximum number of rows in a batch.

snapshot.lock.timeout.ms

10000

Specifies the maximum amount of time (in milliseconds) to wait to obtain table locks when performing a snapshot. If the connector cannot acquire table locks during this interval, the snapshot fails. For more information, see How the connector performs snapshots.

Specify one of the following settings:

An integer > 0

The number of milliseconds that the connector waits to obtain table locks. The snapshot fails if the connector cannot obtain a lock before the specified interval ends.

0

The snapshot fails immediately if the connector cannot obtain a lock.

-1

The connector waits indefinitely to obtain a lock.

snapshot.select.statement.overrides

No default

Specifies the tables for which the connector uses custom SELECT statements to determine which rows to include in a snapshot.

This property affects snapshots only. It does not apply to events that the connector reads from the log during the streaming phase.

This property consists of two parts that work together:

Main property

A comma-separated list of fully-qualified table names in the format <databaseName>.<schemaName>.<tableName>. This list identifies the tables for which you want to specify custom snapshot queries.

For example,

"snapshot.select.statement.overrides": "mydatabase.inventory.products,mydatabase.customers.orders"

Secondary properties

For each table that you list in the main property, you must define a corresponding snapshot.select.statement.overrides.<databaseName>.<schemaName>.<tableName> property that specifies the custom SELECT statement to run during the snapshot. The SELECT statement determines which rows from the table to include in the snapshot.

For example, to specify a SELECT statement for the mydatabase.customer.orders table, add the following property:

snapshot.select.statement.overrides.mydatabase.customers.orders

Example configuration

The following example shows how to configure the snapshot.select-statement property to perform a snapshot of the mydatabase.customers.orders table that includes only records that are not soft-deleted; that is, the value of the soft-delete field, delete_flag, is set to 0.

"snapshot.select.statement.overrides": "mydatabase.customer.orders",
"snapshot.select.statement.overrides.mydatabase.customer.orders": "SELECT * FROM customers.orders WHERE delete_flag = 0 ORDER BY id DESC"

provide.transaction.metadata

false

Determines whether the connector generates events with transaction boundaries and enriches change event envelopes with transaction metadata. Set the value to true if you want the connector to perform these actions. For more information, see Transaction metadata .

skipped.operations

t

A comma-separated list of operation types that the connector skips during streaming. You can specify the following values:

c

The connector does not emit events for insert (create) operations.

u

The connector does not emit events for update operations.

d

The connector does not emit events for delete operations.

t

The connector does not emit events truncate operation.

none

The connector emits events for all operation types.

signal.data.collection

No default

Fully-qualified name of the data collection that is used to send signals to the connector. The collection name is case-sensitive.

Use the following format to specify the collection name:

<databaseName>.<schemaName>.<tableName>

signal.enabled.channels

source

List of the signaling channel names that are enabled for the connector. By default, the following channels are available:

• source
• kafka
• file
• jmx

Optionally, you can also implement a custom signaling channel.

notification.enabled.channels

No default

List of the notification channel names that are enabled for the connector. By default, the following channels are available:

• sink
• log
• jmx

Optionally, you can also implement a custom notification channel.

incremental.snapshot.chunk.size

1024

The maximum number of rows that the connector fetches and reads into memory during an incremental snapshot chunk. Increasing the chunk size provides greater efficiency, because the snapshot runs fewer snapshot queries of a greater size. However, larger chunk sizes also require more memory to buffer the snapshot data. Adjust the chunk size to a value that provides the best performance in your environment.

incremental.snapshot.watermarking.strategy

insert_insert

Specifies the watermarking mechanism that the connector uses during an incremental snapshot to deduplicate events that might be captured by an incremental snapshot and then recaptured after streaming resumes. You can specify one of the following options:

insert_insert

When you send a signal to initiate an incremental snapshot, for every chunk that Debezium reads during the snapshot, it writes an entry to the signaling data collection to record the signal to open the snapshot window. After the snapshot completes, Debezium inserts a second entry that records the signal to close the window.

insert_delete

When you send a signal to initiate an incremental snapshot, for every chunk that Debezium reads, it writes a single entry to the signaling data collection to record the signal to open the snapshot window. After the snapshot completes, this entry is removed. No entry is created for the signal to close the snapshot window. Set this option to prevent rapid growth of the signaling data collection.

topic.naming.strategy

io.debezium.schema.SchemaTopicNamingStrategy

The name of the TopicNamingStrategy class that the connector uses to construct the topic names for data change, schema change, transaction, heartbeat, and other types of events.

topic.delimiter

.

Specifies the delimiter that the connector uses to construct topic names.

topic.cache.size

10000

The cache size allocated for storing topic names in a bounded concurrent hash map. This cache helps to determine the topic name that corresponds to a given data collection.

topic.heartbeat.prefix

__debezium-heartbeat

Specifies a string that the connector appends to the name of the topic to which it sends heartbeat messages. The resulting topic name has the following pattern:

topic.heartbeat.prefix.topic.prefix

For example, if the topic prefix is fulfillment, based on the default value of the prefix, the connector assigns the following name to the heartbeat topic : __debezium-heartbeat.fulfillment.

This property is ignored if topic.heartbeat.name is set.

topic.heartbeat.name

empty

Specifies an explicit, full name for the topic to which the connector sends heartbeat messages, overriding the prefix-based naming derived from topic.heartbeat.prefix and topic.prefix.

When set, all heartbeat messages are routed to this exact topic name, regardless of the connector’s topic.prefix. This is useful when running multiple connectors and you want to consolidate heartbeat events into a single shared topic, avoiding the creation of a large number of single-partition heartbeat topics.

For example, setting this to debezium-heartbeat routes all heartbeat messages to a topic named debezium-heartbeat.

If this property is empty or unset, the connector falls back to the default behavior: topic.heartbeat.prefix.topic.prefix.

topic.transaction

transaction

Specifies a string that the connector appends to the name of the topic to which it sends transaction metadata messages. The resulting topic name has the following pattern:

topic.prefix.transaction

For example, if the topic prefix is fulfillment, based on the default value of this property, the connector assigns the following name to the transaction metadata topic: fulfillment.transaction.

snapshot.max.threads

1

Specifies the number of threads that the connector uses when performing an initial snapshot. The value must be a positive integer greater than or equal to 1. When set to a value greater than 1, the connector performs a parallel snapshot by dividing each table into chunks based on primary key ranges and processing the chunks concurrently across all available threads.

snapshot.max.threads.multiplier

1

A global multiplier that controls the number of chunks created per table during a parallel snapshot. By default, Debezium creates one chunk per thread. A higher value causes the connector to create more, smaller chunks per table when running a snapshot. Smaller chunks keep threads more evenly loaded. For example, with 4 threads and a multiplier of 2, Debezium creates 8 chunks instead of 4.

To override the multiplier for a specific table, set snapshot.max.threads.multiplier.<fully_qualified_table_name> to the desired value.

legacy.snapshot.max.threads

false

The default value (false) enables the connector to accelerate initial snapshots by dividing tables into chunks and using separate threads to process each chunk concurrently. To revert to the legacy parallel snapshot behavior of processing one table per thread, set the value to true.

custom.metric.tags

No default

Defines tags that customize MBean object names by adding metadata that provides contextual information. Specify a comma-separated list of key-value pairs. Each key represents a tag for the MBean object name, and the corresponding value represents a value for the key, for example, k1=v1,k2=v2

The connector appends the specified tags to the base MBean object name. Tags can help you to organize and categorize metrics data. You can define tags to identify particular application instances, environments, regions, versions, and so forth. For more information, see Customized MBean names.

custom.sanitize.pattern

.*secret$|.*password$|.*sasl\.jaas\.config$|.*basic\.auth\.user\.info$|.*registry\.auth\.client-secret

An optional regular expression that specifies a custom pattern for masking sensitive configuration keys.

By default, Debezium masks the value of configuration keys that match a predefined pattern for commonly known sensitive properties such as passwords and authentication tokens. To customize the way that the connector masks configuration key values, set this property to a regular expression that matches specific configuration key values that you want to mask.

For example, to mask keys the contain the strings api.key or token, set this property to the following value:

"custom.sanitize.pattern": ".*api\\.key.*\|.*token.*"

If you set this property for the connector, Debezium masks any matching instances of configuration key values that it returns for display, logging, or in response to API calls. A string of asterisks replaces the original values, for example, ********.

errors.max.retries

-1

Specifies the maximum number of times that the connector retries retriable errors, such as connection errors, before failing. Set one of the following values:

database.query.timeout.ms

600000 (10 minutes)

Specifies the time, in milliseconds, that the connector waits for a query to complete. Set the value to 0 (zero) to remove the timeout limit.

extended.headers.enabled

true

This property specifies whether Debezium adds context headers with the prefix __debezium.context. to the messages that it emits.

These headers are required by the OpenLineage integration and provide metadata that enables downstream processing systems to track and identify the sources of change events.

The property adds following headers:

__debezium.context.connectorLogicalName

The logical name of the Debezium connector.

__debezium.context.taskId

The unique identifier of the connector task.

__debezium.context.connectorName

The name of the Debezium connector.

Debezium Informix connector database schema history configuration properties

Debezium provides a set of schema.history.internal.* properties that control how the connector interacts with the schema history topic.

The following table describes the schema.history.internal properties for configuring the Debezium connector.

Table 11. Connector database schema history configuration properties

Property Default Description

schema.history.internal.kafka.topic

No default

The full name of the Kafka topic where the connector stores the database schema history.

schema.history.internal.kafka.bootstrap.servers

No default

A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster. This connection is used for retrieving the database schema history previously stored by the connector, and for writing each DDL statement read from the source database. Each pair should point to the same Kafka cluster used by the Kafka Connect process.

schema.history.internal.kafka.recovery.poll.interval.ms

100

An integer value that specifies the maximum number of milliseconds the connector should wait during startup/recovery while polling for persisted data. The default is 100ms.

schema.history.internal.kafka.query.timeout.ms

3000

An integer value that specifies the maximum number of milliseconds the connector should wait while fetching cluster information using Kafka admin client.

schema.history.internal.kafka.create.timeout.ms

30000

An integer value that specifies the maximum number of milliseconds the connector should wait while create kafka history topic using Kafka admin client.

schema.history.internal.kafka.recovery.attempts

100

The maximum number of times that the connector should try to read persisted history data before the connector recovery fails with an error. The maximum amount of time to wait after receiving no data is recovery.attempts × recovery.poll.interval.ms.

schema.history.internal.skip.unparseable.ddl

false

A Boolean value that specifies whether the connector should ignore malformed or unknown database statements or stop processing so a human can fix the issue. The safe default is false. Skipping should be used only with care as it can lead to data loss or mangling when the binlog is being processed.

schema.history.internal.store.only.captured.tables.ddl

false

A Boolean value that specifies whether the connector records schema structures from all tables in a schema or database, or only from tables that are designated for capture. Specify one of the following values:

false (default)

During a database snapshot, the connector records the schema data for all non-system tables in the database, including tables that are not designated for capture. It’s best to retain the default setting. If you later decide to capture changes from tables that you did not originally designate for capture, the connector can easily begin to capture data from those tables, because their schema structure is already stored in the schema history topic. Debezium requires the schema history of a table so that it can identify the structure that was present at the time that a change event occurred.

true

During a database snapshot, the connector records the table schemas only for the tables from which Debezium captures change events. If you change the default value, and you later configure the connector to capture data from other tables in the database, the connector lacks the schema information that it requires to capture change events from the tables.

schema.history.internal.store.only.captured.databases.ddl

false

A Boolean value that specifies whether the connector records schema structures from all logical databases in the database instance. Specify one of the following values:

true

The connector records schema structures only for tables in the logical database and schema from which Debezium captures change events.

false

The connector records schema structures for all logical databases.

schema.history.internal.memory.optimization

off

Controls how Debezium deduplicates identical schema objects (tables, columns, attributes) in memory using an interner. Specify one of the following values:

off

No deduplication is performed (the default).

on

Each connector uses its own isolated intern pool. Reduces heap usage within a single connector without interfering with other connectors.

shared

All connectors configured with shared share a single global intern pool. Maximises deduplication when many connectors track tables with similar structures.

Pass-through Informix connector configuration properties

The connector supports pass-through properties that enable Debezium to specify custom configuration options for fine-tuning the behavior of the Apache Kafka producer and consumer. For information about the full range of configuration properties for Kafka producers and consumers, see the Kafka documentation.

Pass-through properties for configuring how producer and consumer clients interact with schema history topics

Debezium relies on an Apache Kafka producer to write schema changes to database schema history topics. Similarly, it relies on a Kafka consumer to read from database schema history topics when a connector starts. You define the configuration for the Kafka producer and consumer clients by assigning values to a set of pass-through configuration properties that begin with the schema.history.internal.producer.* and schema.history.internal.consumer.* prefixes. The pass-through producer and consumer database schema history properties control a range of behaviors, such as how these clients secure connections with the Kafka broker, as shown in the following example:

schema.history.internal.producer.security.protocol=SSL
schema.history.internal.producer.ssl.keystore.location=/var/private/ssl/kafka.server.keystore.jks
schema.history.internal.producer.ssl.keystore.password=test1234
schema.history.internal.producer.ssl.truststore.location=/var/private/ssl/kafka.server.truststore.jks
schema.history.internal.producer.ssl.truststore.password=test1234
schema.history.internal.producer.ssl.key.password=test1234

schema.history.internal.consumer.security.protocol=SSL
schema.history.internal.consumer.ssl.keystore.location=/var/private/ssl/kafka.server.keystore.jks
schema.history.internal.consumer.ssl.keystore.password=test1234
schema.history.internal.consumer.ssl.truststore.location=/var/private/ssl/kafka.server.truststore.jks
schema.history.internal.consumer.ssl.truststore.password=test1234
schema.history.internal.consumer.ssl.key.password=test1234

Debezium strips the prefix from the property name before it passes the property to the Kafka client.

For more information about Kafka producer configuration properties and Kafka consumer configuration properties, see the Apache Kafka documentation .

Pass-through properties for configuring how the Informix connector interacts with the Kafka signaling topic

Debezium provides a set of signal.* properties that control how the connector interacts with the Kafka signals topic.

The following table describes the Kafka signal properties.

Table 12. Kafka signals configuration properties

Property Default Description

signal.kafka.topic

<topic.prefix>-signal

The name of the Kafka topic that the connector monitors for ad hoc signals.

signal.kafka.groupId

kafka-signal

The name of the group ID that is used by Kafka consumers.

signal.kafka.bootstrap.servers

No default

A list of the host and port pairs that the connector uses to establish its initial connection to the Kafka cluster. Each pair references the Kafka cluster that is used by the Debezium Kafka Connect process.

signal.kafka.poll.timeout.ms

100

An integer value that specifies the maximum number of milliseconds that the connector waits when polling signals.

Pass-through properties for configuring the Kafka consumer client for the signaling channel

The Debezium connector provides for pass-through configuration of the signals Kafka consumer. Pass-through signals properties begin with the prefix signal.consumer.*. For example, the connector passes properties such as signal.consumer.security.protocol=SSL to the Kafka consumer.

Debezium strips the prefixes from the properties before it passes the properties to the Kafka signals consumer.

Pass-through properties for configuring the Informix connector sink notification channel

The following table describes properties that you can use to configure the Debezium sink notification channel.

Table 13. Sink notification configuration properties

Debezium connector pass-through database driver configuration properties

The Debezium connector provides for pass-through configuration of the database driver. Pass-through database properties begin with the prefix driver.*. For example, the connector passes properties such as driver.foobar=false to the JDBC URL.

Debezium strips the prefixes from the properties before it passes the properties to the database driver.

Monitoring

The Debezium Informix connector provides three types of metrics that are in addition to the built-in support for JMX metrics that Apache Kafka and Kafka Connect provide.

• Snapshot metrics provide information about connector operation while performing a snapshot.
• Streaming metrics provide information about connector operation when the connector is capturing changes and streaming change event records.
• Schema history metrics provide information about the status of the connector’s schema history.

Debezium monitoring documentation provides details for how to expose these metrics by using JMX.

Customized MBean names

Debezium connectors expose metrics via the MBean name for the connector. These metrics, which are specific to each connector instance, provide data about the behavior of the connector’s snapshot, streaming, and schema history processes.

By default, when you deploy a correctly configured connector, Debezium generates a unique MBean name for each of the different connector metrics. To view the metrics for a connector process, you configure your observability stack to monitor its MBean. But these default MBean names depend on the connector configuration; configuration changes can result in changes to the MBean names. A change to the MBean name breaks the linkage between the connector instance and the MBean, disrupting monitoring activity. In this scenario, you must reconfigure the observability stack to use the new MBean name if you want to resume monitoring.

To prevent monitoring disruptions that result from MBean name changes, you can configure custom metrics tags. You configure custom metrics by adding the custom.metric.tags property to the connector configuration. The property accepts key-value pairs in which each key represents a tag for the MBean object name, and the corresponding value represents the value of that tag. For example: k1=v1,k2=v2. Debezium appends the specified tags to the MBean name of the connector.

After you configure the custom.metric.tags property for a connector, you can configure the observability stack to retrieve metrics associated with the specified tags. The observability stack then uses the specified tags, rather than the mutable MBean names to uniquely identify connectors. Later, if Debezium redefines how it constructs MBean names, or if the topic.prefix in the connector configuration changes, metrics collection is uninterrupted, because the metrics scrape task uses the specified tag patterns to identify the connector.

A further benefit of using custom tags, is that you can use tags that reflect the architecture of your data pipeline, so that metrics are organized in a way that suits you operational needs. For example, you might specify tags with values that declare the type of connector activity, the application context, or the data source, for example, db1-streaming-for-application-abc. If you specify multiple key-value pairs, all of the specified pairs are appended to the connector’s MBean name.

The following example illustrates how tags modify the default MBean name.

Example 3. How custom tags modify the connector MBean name

By default, the Informix connector uses the following MBean name for streaming metrics:

debezium.informix:type=connector-metrics,context=streaming,server=<topic.prefix>

If you set the value of custom.metric.tags to database=salesdb-streaming,table=inventory, Debezium generates the following custom MBean name:

debezium.informix:type=connector-metrics,context=streaming,server=<topic.prefix>,database=salesdb-streaming,table=inventory

Snapshot metrics

The MBean is debezium.informix:type=connector-metrics,context=snapshot,server=<topic.prefix>.

The following table lists the JMX metrics that are available for monitoring Debezium snapshot operations, including row counts, table progress, duration, and queue capacity. Snapshot metrics are not exposed unless a snapshot operation is active, or a snapshot has occurred since the last connector start.

The following table lists the additional JMX metrics that are available when a connector runs an incremental snapshot, including chunk and table boundary identifiers that you can use to track snapshot progress.

Streaming metrics

The MBean is debezium.informix:type=connector-metrics,context=streaming,server=<topic.prefix>.

The following table lists the JMX metrics that are available for monitoring Debezium streaming operations, including event counts by type, lag behind the source, queue capacity, and connection status.

Schema history metrics

The MBean is debezium.informix:type=connector-metrics,context=schema-history,server=<topic.prefix>.

The following table lists the JMX metrics that are available for monitoring the connector’s schema history process, including recovery status, the number of schema changes applied, and timestamps for the most recent changes.

Schema evolution

While a Debezium Informix connector can capture schema changes, to update a schema, you must collaborate with a database administrator to ensure that the connector continues to produce change events.

Offline schema update

Informix does not support online schema updates while capturing changes. You must stop the Debezium Informix connector before you perform a schema update.

Prerequisites

• One or more tables that are in capture mode require schema updates.

Procedure

1. Suspend the application that updates the database.
2. Wait for the Debezium connector to stream all unstreamed change event records.
3. Stop the Debezium connector.
4. Apply all changes to the source table schema.
5. Resume the application that updates the database.
6. Restart the Debezium connector.