Capture Capture

type: "io.kestra.plugin.debezium.sqlserver.Capture"

Wait for change data capture event on Microsoft SQL server

# Examples

id: "capture"
type: "io.kestra.plugin.debezium.sqlserver.Capture"
hostname: 127.0.0.1
port: 1433
username: sa
password: sqlserver_passwd
maxRecords: 100

# Properties

# database

  • Type: string
  • Dynamic:
  • Required:

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

# deleted

  • Type: string

  • Dynamic:

  • Required:

  • Default: ADD_FIELD

  • Possible Values:

    • ADD_FIELD
    • NULL
    • DROP

How to handle deleted rows

Possible settings are:

  • ADD_FIELD: add a deleted fields as boolean.
  • NULL: send a row will all values as null.
  • DROP: don't send row deleted.

# deletedFieldName

  • Type: string
  • Dynamic:
  • Required:
  • Default: deleted

The name of deleted fields if deleted is ADD_FIELD

# excludedColumns

  • Type: ====
  • Dynamic:
  • Required:

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.

# excludedDatabases

  • Type: ====
  • Dynamic:
  • Required:

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 theincludedDatabases` connector configuration property.

# excludedTables

  • Type: ====
  • Dynamic:
  • Required:

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.

# format

  • Type: string

  • Dynamic:

  • Required:

  • Default: INLINE

  • Possible Values:

    • RAW
    • INLINE
    • WRAP

The format of 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 cols will be present on each rows.
  • WRAP: Send a row like INLINE but wrapped on a record field.

# hostname

  • Type: string
  • Dynamic:
  • Required:

Hostname of the remote server

# ignoreDdl

  • Type: boolean
  • Dynamic:
  • Required:
  • Default: true

Ignore ddl statement

Ignore create table and others administration operations

# includedColumns

  • Type: ====
  • Dynamic:
  • Required:

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.

# includedDatabases

  • Type: ====
  • Dynamic:
  • Required:

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 theexcludedDatabases` connector configuration property.

# includedTables

  • Type: ====
  • Dynamic:
  • Required:

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 theexcludedTables` connector configuration property.

# key

  • Type: string

  • Dynamic:

  • Required:

  • Default: ADD_FIELD

  • Possible Values:

    • ADD_FIELD
    • DROP

How to handle key

Possible settings are:

  • ADD_FIELD: add key(s) merged with cols.
  • DROP: drop keys.

# maxDuration

  • Type: string
  • Dynamic:
  • Required:
  • Format: duration

The max total processing duration

It's not an hard limit and is evaluated every second

# maxRecords

  • Type: integer
  • Dynamic:
  • Required:

The max number of rows to fetch before stopping

It's not an hard limit and is evaluated every second

# maxWait

  • Type: string
  • Dynamic:
  • Required:
  • Default: 10.000000000
  • Format: duration

The max duration waiting for new rows

It's not an hard limit and is evaluated every second

# metadata

  • Type: string

  • Dynamic:

  • Required:

  • Default: ADD_FIELD

  • Possible Values:

    • ADD_FIELD
    • DROP

How to handle metadata

Possible settings are:

  • ADD_FIELD: add metadata in a col named metadata.
  • DROP: drop keys.

# metadataFieldName

  • Type: string
  • Dynamic:
  • Required:
  • Default: metadata

The name of metadata fields if metadata is ADD_FIELD

# password

  • Type: string
  • Dynamic:
  • Required:

Password on the remote server

# port

  • Type: string
  • Dynamic:
  • Required:

Port of the remote server

# properties

  • Type: object
  • Dynamic:
  • Required:

Additional configuration properties

Any additional configuration properties that is valid for the current driver

# snapshotMode

  • Type: string

  • Dynamic:

  • Required:

  • Default: INITIAL

  • Possible Values:

    • INITIAL
    • INITIAL_ONLY
    • SCHEMA_ONLY

Specifies the criteria for running a snapshot when the connector starts.

Possible settings are:

  • INITIAL: Takes a snapshot of structure and data of captured tables; useful if topics should be populated with a complete representation of the data from the captured tables.
  • INITIAL_ONLY: Takes a snapshot of structure and data like initial but instead does not transition into streaming changes once the snapshot has completed.
  • SCHEMA_ONLY: Takes a snapshot of the structure of captured tables only; useful if only changes happening from now onwards should be propagated to topics.

# splitTable

  • Type: string

  • Dynamic:

  • Required:

  • Default: TABLE

  • Possible Values:

    • OFF
    • DATABASE
    • TABLE

Split table on separate output uris

Possible settings are:

  • TABLE: will split all rows by tables on output with name database.table
  • DATABASE: will split all rows by database on output with name database.
  • OFF: will NOT split all rows resulting a single data output.

# stateName

  • Type: string
  • Dynamic:
  • Required:
  • Default: debezium-state

The name of Debezium state file

# username

  • Type: string
  • Dynamic:
  • Required:

Username on the remote server

# Outputs

# size

  • Type: integer

The size of the rows fetch

# stateHistory

  • Type: string

The state with database history

# stateOffset

  • Type: string

The state with offset

# uris

  • Type: object
  • SubType: string

Uri of the generated internal storage file