RealtimeTrigger
Trigger a flow via a PostgreSQL change data capture event in real-time and create one execution per row.
If you would like to consume multiple messages processed within a given time frame and process them in batch, you can use the io.kestra.plugin.debezium.postgres.Trigger instead.
type: "io.kestra.plugin.debezium.postgres.RealtimeTrigger"Consume a message from a PostgreSQL database via change data capture in real-time.
id: debezium-postgres
namespace: company.team
tasks:
- id: send_data
type: io.kestra.plugin.core.log.Log
message: "{{ trigger.data }}"
triggers:
- id: realtime
type: io.kestra.plugin.debezium.postgres.RealtimeTrigger
database: postgres
hostname: 127.0.0.1
port: "5432"
username: "{{ secret('PG_USERNAME') }}"
password: "{{ secret('PG_PASSWORD') }}"
The name of the PostgreSQL database from which to stream the changes.
deletedThe name of deleted field if deleted is ADD_FIELD.
Hostname of the remote server.
ADD_FIELDADD_FIELDDROPSpecify how to handle key.
Possible settings are:
ADD_FIELD: Add key(s) merged with columns.DROP: Drop keys.
ADD_FIELDADD_FIELDDROPSpecify how to handle metadata.
Possible settings are:
ADD_FIELD: Add metadata in a column namedmetadata.DROP: Drop metadata.
PGOUTPUTDECODERBUFSWAL2JSONWAL2JSON_RDSWAL2JSON_STREAMINGWAL2JSON_RDS_STREAMINGPGOUTPUTThe name of the PostgreSQL logical decoding plug-in installed on the PostgreSQL server.
If you are using a wal2json plug-in and transactions are very large, the JSON batch event that contains all transaction changes might not fit into the hard-coded memory buffer, which has a size of 1 GB. In such cases, switch to a streaming plug-in, by setting the plugin-name property to wal2json_streaming or wal2json_rds_streaming. With a streaming plug-in, PostgreSQL sends the connector a separate message for each change in a transaction.
kestra_publicationThe name of the PostgreSQL publication created for streaming changes when using PGOUTPUT.
This publication is created at start-up if it does not already exist and it includes all tables. Debezium then applies its own include/exclude list filtering, if configured, to limit the publication to change events for the specific tables of interest. The connector user must have superuser permissions to create this publication, so it is usually preferable to create the publication before starting the connector for the first time.
If the publication already exists, either for all tables or configured with a subset of tables, Debezium uses the publication as it is defined.
INITIALINITIALALWAYSNEVERINITIAL_ONLYSpecifies the criteria for running a snapshot when the connector starts.
Possible settings are:
INITIAL: The connector performs a snapshot only when no offsets have been recorded for the logical server name.ALWAYS: The connector performs a snapshot each time the connector starts.NEVER: The connector never performs snapshots. When a connector is configured this way, its behavior when it starts is as follows. If there is a previously stored LSN, the connector continues streaming changes from that position. If no LSN has been stored, the connector starts streaming changes from the point in time when the PostgreSQL logical replication slot was created on the server. The never snapshot mode is useful only when you know all data of interest is still reflected in the WAL.INITIAL_ONLY: The connector performs an initial snapshot and then stops, without processing any subsequent changes.
debezium-stateThe name of the Debezium state file stored in the KV Store for that namespace.
List of conditions in order to limit the flow trigger.
ADD_FIELDADD_FIELDNULLDROPSpecify how to handle deleted rows.
Possible settings are:
ADD_FIELD: Add a deleted field as boolean.NULL: Send a row with all values as null.DROP: Don't send deleted row.
An optional, comma-separated list of regular expressions that match the fully-qualified names of columns to include in change event record values.
Fully-qualified names for columns are of the form databaseName.tableName.columnName. Do not also specify the includedColumns connector configuration property."
An optional, comma-separated list of regular expressions that match the names of databases for which you do not want to capture changes.
The connector captures changes in any database whose name is not in the excludedDatabases. Do not also set the includedDatabases connector configuration property.
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 any table not included in excludedTables. Each identifier is of the form databaseName.tableName. Do not also specify the includedTables connector configuration property.
INLINERAWINLINEWRAPThe format of the output.
Possible settings are:
RAW: Send raw data from debezium.INLINE: Send a row like in the source with only data (remove after & before), all the columns will be present for each row.WRAP: Send a row like INLINE but wrapped in arecordfield.
trueIgnore DDL statement.
Ignore CREATE, ALTER, DROP and TRUNCATE operations.
An optional, comma-separated list of regular expressions that match the fully-qualified names of columns to exclude from change event record values.
Fully-qualified names for columns are of the form databaseName.tableName.columnName. Do not also specify the excludedColumns connector configuration property.
An optional, comma-separated list of regular expressions that match the names of the databases for which to capture changes.
The connector does not capture changes in any database whose name is not in includedDatabases. By default, the connector captures changes in all databases. Do not also set the excludedDatabases connector configuration property.
An optional, comma-separated list of regular expressions that match fully-qualified table identifiers of tables whose changes you want to capture.
The connector does not capture changes in any table not included in includedTables. Each identifier is of the form databaseName.tableName. By default, the connector captures changes in every non-system table in each database whose changes are being captured. Do not also specify the excludedTables connector configuration property.
metadataThe name of metadata field if metadata is ADD_FIELD.
ON_EACH_BATCHON_EACH_BATCHON_STOPHow to commit the offsets to the KV Store.
Possible values are:
- ON_EACH_BATCH: after each batch of records consumed by this trigger, the offsets will be stored in the KV Store. This avoids any duplicated records being consumed but can be costly if many events are produced.
- ON_STOP: when this trigger is stopped or killed, the offsets will be stored in the KV Store. This avoid any un-necessary writes to the KV Store, but if the trigger is not stopped gracefully, the KV Store value may not be updated leading to duplicated records consumption.
Password on the remote server.
Port of the remote server.
Additional configuration properties.
Any additional configuration properties that is valid for the current driver.
kestraThe name of the PostgreSQL logical decoding slot that was created for streaming changes from a particular plug-in for a particular database/schema.
The server uses this slot to stream events to the Debezium connector that you are configuring. Slot names must conform to PostgreSQL replication slot naming rules, which state: "Each replication slot has a name, which can contain lower-case letters, numbers, and the underscore character."
TABLEOFFDATABASETABLESplit table on separate output uris.
Possible settings are:
TABLE: This will split all rows by tables on output with namedatabase.tableDATABASE: This will split all rows by databases on output with namedatabase.OFF: This will NOT split all rows resulting in a singledataoutput.
The SSL certificate for the client.
Must be a PEM encoded certificate.
The SSL private key of the client.
Must be a PEM encoded key.
The password to access the client private key sslKey.
DISABLEDISABLEREQUIREVERIFY_CAVERIFY_FULLWhether to use an encrypted connection to the PostgreSQL server. Options include:
DISABLEuses an unencrypted connection.REQUIREuses a secure (encrypted) connection, and fails if one cannot be established.VERIFY_CAbehaves like require but also verifies the server TLS certificate against the configured Certificate Authority (CA) certificates, or fails if no valid matching CA certificates are found.VERIFY_FULLbehaves like verify-ca but also verifies that the server certificate matches the host to which the connector is trying to connect.
See the PostgreSQL documentation for more information.
The root certificate(s) against which the server is validated.
Must be a PEM encoded certificate.
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDList of execution states after which a trigger should be stopped (a.k.a. disabled).
Username on the remote server.
Data.
Data extracted.
Stream.
Stream source
partial-timeSLA daily deadline
Use it only for DAILY_TIME_DEADLINE SLA.
partial-timeSLA daily end time
Use it only for DAILY_TIME_WINDOW SLA.
partial-timeSLA daily start time
Use it only for DAILY_TIME_WINDOW SLA.
DURATION_WINDOWDAILY_TIME_DEADLINEDAILY_TIME_WINDOWDURATION_WINDOWSLIDING_WINDOWThe type of the SLA
The default SLA is a sliding window (DURATION_WINDOW) with a window of 24 hours.
durationThe duration of the window
Use it only for DURATION_WINDOW or SLIDING_WINDOW SLA.
See ISO_8601 Durations for more information of available duration value.
The start of the window is always based on midnight except if you set windowAdvance parameter. Eg if you have a 10 minutes (PT10M) window,
the first window will be 00: 00 to 00: 10 and a new window will be started each 10 minutes
durationThe window advance duration
Use it only for DURATION_WINDOW SLA.
Allow to specify the start time of the window
Eg: you want a window of 6 hours (window=PT6H), by default the check will be done between: 00: 00 and 06: 00, 06: 00 and 12: 00, 12: 00 and 18: 00, and 18: 00 and 00: 00.
If you want to check the window between 03: 00 and 09: 00, 09: 00 and 15: 00, 15: 00 and 21: 00, and 21: 00 and 3: 00, you will have to shift the window of 3 hours by settings windowAdvance: PT3H
The flow id.
The namespace of the flow.
The namespace of the flow or the prefix if prefix is true.
falseIf we must look at the flow namespace by prefix (checked using startWith). The prefix is case sensitive.
The flow id.
The namespace of the flow.
timeThe time to test must be after this one.
Must be a valid ISO 8601 time with offset.
timeThe time to test must be before this one.
Must be a valid ISO 8601 time with offset.
{{ trigger.date }}The time to test.
Can be any variable or any valid ISO 8601 time. By default, it will use the trigger date.
List of labels to match in the execution.
{{ trigger.date }}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
1The list of conditions to validate.
If any condition is true, it will allow the event's execution.
String against which to match the execution namespace depending on the provided comparison.
EQUALSPREFIXSUFFIXComparison to use when checking if namespace matches. If not provided, it will use EQUALS by default.
falseWhether to look at the flow namespace by prefix. Shortcut for comparison: PREFIX.
Only used when comparison is not set
^[a-zA-Z0-9][a-zA-Z0-9_-]*1A unique id for the condition
trueWhether to reset the evaluation results of SLA conditions after a first successful evaluation within the given time period.
By default, after a successful evaluation of the set of SLA conditions, the evaluation result is reset, so, the same set of conditions needs to be successfully evaluated again in the same time period to trigger a new execution.
This means that to create multiple executions, the same set of conditions needs to be evaluated to true multiple times.
You can disable this by setting this property to false so that, within the same period, each time one of the conditions is satisfied again after a successful evaluation, it will trigger a new execution.
{
"type": "DURATION_WINDOW"
}Define the time period (or window) for evaluating preconditions.
You can set the type of sla to one of the following values:
DURATION_WINDOW: this is the defaulttype. It uses a start time (windowAdvance) and end time (window) that are moving forward to the next interval whenever the evaluation time reaches the end time, based on the defined durationwindow. For example, with a 1-day window (the default option:window: PT1D), the SLA conditions are always evaluated during 24h starting at midnight (i.e. at time 00: 00: 00) each day. If you setwindowAdvance: PT6H, the window will start at 6 AM each day. If you setwindowAdvance: PT6Hand you also override thewindowproperty toPT6H, the window will start at 6 AM and last for 6 hours — as a result, Kestra will check the SLA conditions during the following time periods: 06: 00 to 12: 00, 12: 00 to 18: 00, 18: 00 to 00: 00, and 00: 00 to 06: 00, and so on.SLIDING_WINDOW: this option also evaluates SLA conditions over a fixed timewindow, but it always goes backward from the current time. For example, a sliding window of 1 hour (window: PT1H) will evaluate executions for the past hour (so between now and one hour before now). It uses a default window of 1 day.DAILY_TIME_DEADLINE: this option declares that some SLA conditions should be met "before a specific time in a day". With the string propertydeadline, you can configure a daily cutoff for checking conditions. For example,deadline: "09: 00: 00"means that the defined SLA conditions should be met from midnight until 9 AM each day; otherwise, the flow will not be triggered.DAILY_TIME_WINDOW: this option declares that some SLA conditions should be met "within a given time range in a day". For example, a window fromstartTime: "06: 00: 00"toendTime: "09: 00: 00"evaluates executions within that interval each day. This option is particularly useful for declarative definition of freshness conditions when building data pipelines. For example, if you only need one successful execution within a given time range to guarantee that some data has been successfully refreshed in order for you to proceed with the next steps of your pipeline, this option can be more useful than a strict DAG-based approach. Usually, each failure in your flow would block the entire pipeline, whereas with this option, you can proceed with the next steps of the pipeline as soon as the data is successfully refreshed at least once within the given time range.
durationThe duration of the window
Deprecated, use timeWindow.window instead.
durationThe window advance duration
Deprecated, use timeWindow.windowAdvance instead.
1The list of conditions to exclude.
If any conditions is true, it will prevent the event's execution.
FIRSTLASTSECONDTHIRDFOURTHAre you looking for the first or the last day in the month?
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAYThe day of week.
{{ trigger.date }}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAYThe day of week.
{{ trigger.date }}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDList of states that are authorized.
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDList of states that aren't authorized.
date-timeThe date to test must be after this one.
Must be a valid ISO 8601 datetime with the zone identifier (use 'Z' for the default zone identifier).
date-timeThe date to test must be before this one.
Must be a valid ISO 8601 datetime with the zone identifier (use 'Z' for the default zone identifier).
{{ trigger.date }}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDList of states that are authorized.
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDList of states that aren't authorized.
ISO 3166-1 alpha-2 country code. If not set, it uses the country code from the default locale.
It uses the Jollyday library for public holiday calendar that supports more than 70 countries.
{{ trigger.date }}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
ISO 3166-2 country subdivision (e.g., provinces and states) code.
It uses the Jollyday library for public holiday calendar that supports more than 70 countries.