Skip to content
Streamkap
Esc
navigateopen⌘Jpreview

Create New Destination

POST/destinations
Authorization
AuthorizationBearer token · headerrequired
Query parameters
secret_returnedboolean

Whether to include secret values in the response

default: false
waitboolean

When False, save config and return immediately without waiting for KC deployment

default: true
Request body
requiredapplication/json
namestringrequired

Display name for the destination connector.

connectorstringrequired

Connector type identifier (e.g., 'snowflake', 'bigquery', 'clickhouse', 'postgresql', 's3').

configBigQueryDestinationConfig | ClickhouseDestinationConfig | CockroachDBDestinationConfig | DatabricksDestinationConfig | Db2DestinationConfig | GCSDestinationConfig | HttpSinkDestinationConfig | IcebergDestinationConfig | KafkaDestinationConfig | KafkaDirectDestinationConfig | MotherduckDestinationConfig | MySQLDestinationConfig | OracleDestinationConfig | PineconeDestinationConfig | PostgreSQLDestinationConfig | R2DestinationConfig | RedisDestinationConfig | RedshiftDestinationConfig | S3DestinationConfig | SQLServerDestinationConfig | SnowflakeDestinationConfig | StarburstDestinationConfig | WeaviateDestinationConfigrequired

Connector-specific configuration properties. The schema depends on the connector type specified in the 'connector' field.

Show properties
One of:
BigQueryDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks.

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

keyfileobject<password>required

Upload the BigQuery service-account JSON key file.

defaultDatasetstringrequired

Name of the destination BigQuery dataset. The dataset must already exist.

timePartitioningTypestring

Time partitioning granularity used when auto-creating tables. Select NONE to create non-partitioned tables.

default: "DAY"
Allowed:DAYHOURMONTHYEARNONE
custom.partition.fieldstring

Optional record field to partition by. Leave blank for ingestion-time partitioning.

custom.clustering.fieldsstring

Optional comma-separated list of fields to cluster the table by (max 4).

custom.partition.expiration.daysstring

Optional. Automatically delete partitions older than this many days from tables this destination creates. Leave blank to keep all partitions. Ignored when Time Partitioning is NONE.

autoCreateTablesstring

Automatically create BigQuery tables for new topics.

default: true
allowNewBigQueryFieldsstring

Allow adding new columns to BigQuery tables when the schema evolves.

default: true
allowBigQueryRequiredFieldRelaxationstring

Allow changing BigQuery columns from REQUIRED to NULLABLE when the schema evolves.

default: true
ClickhouseDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active task

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: false
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

ingestion.modestring

Upsert or append modes are available

default: "upsert"
Allowed:[object Object][object Object]
hard.deletestring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)

default: true
hostnamestringrequired

ClickHouse Hostname Or IP address

connection.usernamestringrequired

Username to access ClickHouse

connection.passwordstring<password>required

Password to access the ClickHouse

portstringrequired

ClickHouse Port. For example, 8443

default: "8443"
databasestringrequired

ClickHouse database

sslstring

Enable TLS for network connections

default: true
topics.config.mapstring

Per topic configuration in JSON format

clickhouse.json.supportstring

Allow JSON data type in ClickHouse, make sure the ClickHouse server supports it. If not set, the connector will use String type for JSON data.

default: false
table.name.prefixstring

Optional prefix prepended to every destination table name (e.g. 'prod_' produces tables like 'prod_customers'). Only letters, digits, and underscores are allowed.

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
CockroachDBDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

CockroachDB Hostname

database.port.user.definedstringrequired

CockroachDB Port. For example, 26257

default: "26257"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

table.name.prefixstringrequired

Schema for the associated table name

default: "public"
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

DatabricksDestinationConfig
tasks.maxinteger

The maximum number of active tasks. NOTE: Increasing this value may increase parallelism and throughput but can also lead to higher costs on databricks side.

min 1 · max 100 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

ingestion.modestring

Upsert or append modes are available

default: "upsert"
Allowed:[object Object][object Object]
databricks.tokenstring<password>required

Token

connection.url.user.definedstringrequired

JDBC URL

connection.timeout.user.definedinteger

Connection Timeout

min 1 · default: "180"
databricks.catalog.user.definedstring

The name of the Databricks catalog to use.

default: "hive_metastore"
partition.modestring

Partition tables or not

default: "by_topic"
Allowed:by_topicby_partitionby_topic_and_partition
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
table.name.prefixstring

Schema for the associated table name

default: "streamkap"
hard.deletestring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
consumer.wait.time.for.larger.batch.msstring

Controls how long the connector waits to accumulate a larger batch before writing to Databricks. Higher values = larger batches = better throughput and fewer MERGE INTOs, but higher latency.

default: "10000"
Allowed:[object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object]
topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

Db2DestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

Db2 Hostname

database.port.user.definedstringrequired

Db2 Port. For example, 50000

default: "50000"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

GCSDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

gcs.credentials.jsonstring<password>

GCP credentials as a JSON string with escaped quotes (" into "). \n in the private_key field should also be escaped as \n. Example format: {"type": "service_account","project_id": "XXXXXX", ...}

gcs.bucket.namestringrequired

The GCS Bucket to use.

format.user.definedstring

The format to use when writing data to the store.

default: "CSV"
Allowed:CSVJSON LinesJSON ArrayParquet
file.name.templatestring

The format of the filename. See documentation for more information about formatting options.

default: "{{topic}}-{{partition}}-{{start_offset}}"
file.name.prefixstring

Prefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).

file.compression.typestring

Compression type for files written to GCS.

default: "gzip"
Allowed:nonegzipsnappyzstd
format.output.fields.user.definedstring[]

A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.

default: ["value"]
HttpSinkDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

http.urlstringrequired

The URL to send data to.

http.authorization.typestring

The HTTP authorization type.

default: "none"
Allowed:nonestaticoauth2
http.headers.authorizationstring

Static content of Authorization header (required for STATIC authorization).

oauth2.access.token.urlstringrequired

URL for fetching OAuth2 access token.

oauth2.client.idstringrequired

OAuth2 client id.

oauth2.client.secretstring<password>required

OAuth2 client secret.

oauth2.scopestringrequired

OAuth2 client scope.

http.headers.content.typestring

Value of Content-Type header for each request.

default: "application/json"
http.headers.additionalstring

Additional headers in header:value format, comma-separated.

http.proxy.hoststring

Proxy hostname.

http.proxy.portstring

Proxy port.

batching.enabledstring

Enable batching multiple records in a single HTTP request.

default: false
batch.max.sizeinteger

Maximum size of a record batch (1 to 1,000,000).

min 1 · max 1000000 · default: 500
batch.buffering.enabledstring

Enable buffering and only send records when batch.max.size reaches or batch.max.time.ms hits.

default: false
batch.max.time.msinteger

Maximum time to wait before flushing a batch (1 to 1,000,000,000 ms).

min 1 · max 1000000000 · default: 10000
batch.prefixstring

Prefix for record batches.

default: "["
batch.suffixstring

Suffix for record batches.

default: "]"
batch.separatorstring

Separator for records in a batch.

default: ","
max.retriesinteger

Maximum number of retries on errors.

min 0 · max 2147483647 · default: 1
retry.backoff.msinteger

Time in ms to wait before retrying.

min 0 · max 2147483647 · default: 3000
http.timeoutinteger

HTTP response timeout in seconds.

min 0 · max 2147483647 · default: 30
decimal.formatstring

Format for serializing decimals: BASE64 (default) or NUMERIC.

default: "NUMERIC"
Allowed:BASE64NUMERIC
errors.tolerance.user.definedstring

Error tolerance setting. Note: Cannot be used when Batching is enabled.

default: "none"
Allowed:noneall
IcebergDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

iceberg.catalog.typestring

Type of Iceberg catalog

default: "rest"
Allowed:[object Object][object Object][object Object]
iceberg.catalog.auth.modestring

How to authenticate with the Iceberg catalog. 'No Auth' for catalogs that don't require authentication. 'Token' for bearer token authentication (e.g., Cloudflare R2). 'OAuth2 Credential' for OAuth2 client credential authentication (e.g., Polaris, DataHub).

default: "none"
Allowed:[object Object][object Object][object Object]
iceberg.catalog.namestring

Iceberg catalog name

iceberg.catalog.client.assume-role.arnstring

AWS IAM role (e.g., arn:aws:iam::<your-account>:role/<role-name>)

iceberg.catalog.uristring

Catalog endpoint URL. For REST catalogs use https://… ; for Hive Metastore use thrift://… ; AWS Glue uses the regional endpoint.

iceberg.catalog.tokenstring<password>required

Bearer token used for catalog authentication.

iceberg.catalog.credentialstring<password>required

OAuth2 client credential in client_id:client_secret format.

iceberg.catalog.scopestringrequired

OAuth2 scope for catalog authentication (e.g., PRINCIPAL_ROLE:ALL).

default: "PRINCIPAL_ROLE:ALL"
iceberg.catalog.oauth2-server-uristring

OAuth2 token endpoint URI. Required when the REST catalog endpoint is not also the OAuth2 authorization server.

iceberg.catalog.audiencestring

Optional OAuth2 audience parameter to request from the token endpoint.

iceberg.catalog.resourcestring

Optional OAuth2 resource parameter to request from the token endpoint.

iceberg.catalog.s3.credentials.enabledboolean

Enable to provide your own S3 access key and secret. Disable if the catalog vends storage credentials automatically.

default: false
iceberg.catalog.s3.access-key-idstringrequired

The access key ID used to connect to S3 or S3-compatible storage.

iceberg.catalog.s3.secret-access-keystring<password>required

The secret access key used to connect to S3 or S3-compatible storage.

iceberg.catalog.client.region.user.definedstring

The AWS region to be used. For Cloudflare R2, select 'auto'.

default: "us-west-2"
Allowed:ap-south-1eu-west-2eu-west-1ap-northeast-2ap-northeast-1ca-central-1sa-east-1cn-north-1us-gov-west-1ap-southeast-1ap-southeast-2eu-central-1us-east-1us-east-2us-west-1us-west-2auto
iceberg.catalog.warehousestringrequired

The Iceberg warehouse identifier. For R2 Data Catalog, this should be the warehouse name configured in the catalog. For S3-based catalogs, this is typically an S3 or S3-compatible path (e.g., s3://bucket/path).

table.name.prefixstringrequired

Name of the database schema that contains the table (e.g., public, sales, analytics).

insert.mode.user.definedstring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:[object Object][object Object]
iceberg.tables.default-id-columnsstring

Optional. A comma-separated list of field names to use as record identifiers when key fields are not present in Kafka messages

iceberg.tables.hard-delete-enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)

default: true
iceberg.tables.compaction.enabledstring

Enable lightweight compaction of small data files after commits

default: false
iceberg.tables.compaction.target-file-size-bytesstring

Target file size in bytes for compaction. Files smaller than this are candidates for merging

default: "134217728"
iceberg.tables.compaction.min-small-filesstring

Minimum number of small files required before triggering compaction

default: "5"
iceberg.tables.compaction.max-files-per-runstring

Maximum number of small files to compact in a single run

default: "100"
iceberg.tables.compaction.commit-thresholdstring

Number of Iceberg commits between compaction checks

default: "5"
iceberg.tables.compaction.expire-snapshotsstring

Expire old snapshots and delete unreferenced data files after compaction

default: false
iceberg.tables.compaction.retain-laststring

Number of most recent snapshots to retain when expiring snapshots after compaction

default: "1"
KafkaDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

Maximum number of tasks for the connector

min 1 · max 100 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

kafka.sink.bootstrapstringrequired

A comma-separated list of host and port pairs that are the addresses of the Destination Kafka brokers. This list should be in the form host1:port1,host2:port2,...

destination.formatstring

The format to use when writing data to kafka

default: "json"
Allowed:avrojson
json.schema.enablestring

Include schema in json message

default: false
schema.registry.url.user.definedstringrequired

Destination kafka schema registry url

topic.prefixstring

Prefix for destination topics

topic.suffixstring

Suffix for destination topics

transforms.InsertField.offset.fieldstring

If Kafka destination is used to sync data between services or to apply some transformations, it would be better to rename this field to _streamkap_offset_sync or _streamkap_offset_transform to avoid conflicts with the destination on the other service

default: "_streamkap_offset"
transforms.changeTopicName.add.original.topicstring

Add the original topic name to the output record. 'off' disables it, 'header' adds it as a Kafka header, 'field' adds it as a _streamkap_topic column in the destination table.

default: "off"
Allowed:offheaderfield
KafkaDirectDestinationConfig
passwordstring<password>required

Password for setting up the Kafka proxy

whitelist.ips.user.definedstringrequired

A comma-separated list of IPs/CIDRs

MotherduckDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 25 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

ingestion.modestring

Upsert or append modes are available

default: "upsert"
Allowed:[object Object][object Object]
motherduck.tokenstring<password>required

Motherduck Token

motherduck.catalog.user.definedstringrequired

The name of the Motherduck database/catalog to use.

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
table.name.prefixstring

Schema for the associated table name

default: "streamkap"
hard.deletestring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

MySQLDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

MySQL Hostname

database.port.user.definedstringrequired

MySQL Port. For example, 3306

default: "3306"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

OracleDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

Oracle Hostname

database.port.user.definedstringrequired

Oracle Port. For example, 1521

default: "1521"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

PineconeDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

pinecone.api.keystring<password>required

API key for authenticating with Pinecone

pinecone.index.namestringrequired

Name of the target Pinecone index

pinecone.proxy.hoststring

Proxy host for Pinecone connections

pinecone.proxy.portstring

Proxy port for Pinecone connections (required if Proxy Host is set)

collection.mappingstring

Mapping between Kafka topic and Pinecone namespace. Use ${topic} for dynamic topic name substitution

default: "${topic}"
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created namespaces, set to NONE

default: "basic"
Allowed:[object Object][object Object]
document.id.strategy.user.definedstring

Strategy to generate document IDs. 'None' uses random UUIDs (append-only, no upsert/delete support)

default: "None"
Allowed:NoneKafka IDField ID
document.id.field.namestring

Field name containing the ID in Kafka record

default: "id"
vector.field.namestringrequired

Field name containing the embedding vector

default: "vector"
delete.enabledstring

Treat null record values or __deleted=true as deletes. Requires Document ID Strategy to be set to 'Kafka ID' (not 'None')

default: false
batch.sizestring

Number of records per batch

default: "100"
retry.maxstring

Maximum number of retry attempts for failed operations

default: "3"
retry.backoff.msstring

Backoff time between retries in milliseconds

default: "1000"
PostgreSQLDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

PostgreSQL Hostname

database.port.user.definedstringrequired

PostgreSQL Port. For example, 5432

default: "5432"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
table.name.prefixstringrequired

Schema for the associated table name

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

transforms.TopicRegexRouter1.regexstring

Rename destination tables using a regex pattern. The regex is matched against the full topic name — use capture groups to extract parts. Example: <code>..(.)</code> extracts the table name from <code>source_123.public.orders</code>. Leave empty to skip.

transforms.TopicRegexRouter1.replacementstring

The replacement value for the matched regex. Use <code>$1</code>, <code>$2</code> etc. to reference capture groups from the pattern. Example: <code>$1</code> with the pattern above produces <code>orders</code>.

default: "$0"
transforms.TopicRegexRouter2.regexstring

Optional second rename rule, applied after the first. Use when a single regex is not enough. Leave empty to skip.

transforms.TopicRegexRouter2.replacementstring

The replacement value for the second rename rule. Use <code>$1</code>, <code>$2</code> etc. to reference capture groups.

default: "$0"
topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
R2DestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

r2.account.user.definedstringrequired

Cloudflare R2 account ID. This is the account ID you see in the Cloudflare dashboard.

aws.access.key.idstringrequired

The Access Key ID used to connect to R2.

aws.secret.access.keystring<password>required

The Secret Access Key used to connect to R2.

aws.s3.bucket.namestringrequired

The R2 Bucket to use.

format.user.definedstring

The format to use when writing data to the store.

default: "JSON Array"
Allowed:JSON LinesJSON ArrayParquet
file.name.templatestring

The format of the filename. See documentation for more information about formatting options.

default: "{{topic}}-{{partition}}-{{start_offset}}"
file.name.prefixstring

Prefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).

file.compression.typestring

Compression type for files written to S3.

default: "gzip"
Allowed:nonegzipsnappyzstd
format.output.fields.user.definedstring[]

A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.

default: ["value"]
RedisDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

redis.host.user.definedstringrequired

Redis Hostname

redis.port.user.definedstringrequired

Redis Port. For example, 6379

default: "6379"
redis.usernamestringrequired

Username to access the Redis database

redis.passwordstring<password>required

Password to access the Redis database

ssl.enabledstring

Enable TLS for network connections

default: true
redis.keystringrequired

Redis key to stream the data

redis.key.data.typestring

Data Type of Redis Key. At the moment, only Stream and List are supported

default: "Stream"
Allowed:StreamListHash
RedshiftDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

aws.redshift.domainstringrequired

Domain of the leader of the cluster

aws.redshift.portstringrequired

Port number for incoming connections to the leader

default: "5439"
aws.redshift.databasestringrequired

Name of the database on the cluster

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

primary.key.fieldsstringrequired

List of comma-separated primary key field names

default: "id"
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
table.name.prefixstringrequired

Schema for the associated table name

S3DestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

aws.auth.modestringrequired

How Streamkap authenticates with S3. Choose Access Keys to use an AWS Access Key ID and Secret. Choose Cross-Account Role to have Streamkap assume an IAM role in your account using a Role ARN and External ID (recommended for production — see https://docs.streamkap.com/aws-cross-account-iam).

default: "Access Keys"
Allowed:Access KeysCross-Account Role
aws.access.key.idstringrequired

The AWS Access Key ID used to connect to S3.

aws.secret.access.keystring<password>required

The AWS Secret Access Key used to connect to S3.

aws.sts.role.arnstringrequired

ARN of the IAM role Streamkap should assume to write to your S3 bucket (e.g. arn:aws:iam::<your-account-id>:role/<role-name>). The role's trust policy must allow the Streamkap account to assume it.

aws.sts.role.external.idstringrequired

The External ID configured in your role's trust-policy condition. Streamkap passes this value verbatim when assuming the role.

aws.s3.regionstring

The AWS region to be used

default: "us-west-2"
Allowed:ap-south-1eu-west-2eu-west-1ap-northeast-2ap-northeast-1ca-central-1sa-east-1cn-north-1us-gov-west-1ap-southeast-1ap-southeast-2eu-central-1us-east-1us-east-2us-west-1us-west-2
aws.s3.bucket.namestringrequired

The S3 Bucket to use.

format.user.definedstring

The format to use when writing data to the store.

default: "JSON Array"
Allowed:JSON LinesJSON ArrayParquet
file.name.templatestring

The format of the filename. Static text can be added anywhere in the template, including at the start, to act as a directory prefix (e.g. dir1/dir2/{{topic}}-{{partition}}-{{start_offset}}). See documentation for more information about formatting options.

default: "{{topic}}-{{partition}}-{{start_offset}}"
file.compression.typestring

Compression type for files written to S3.

default: "gzip"
Allowed:nonegzipsnappyzstd
file.max.recordsinteger

Maximum number of records buffered into a single file before it is rotated. The rotated file is still only uploaded to S3 on the next flush interval. Set to 0 for unlimited (one file per topic-partition per flush interval).

min 0 · max 100000 · default: 0
aws.s3.part.size.bytesinteger

Size of each part in a multipart upload to S3, in bytes. Larger parts mean fewer S3 API calls for big files but more memory used per upload. AWS requires multipart parts to be at least 5MB (except the last part of a file).

min 5242880 · max 104857600 · default: 5242880
format.output.envelopeboolean

When enabled (default), each output record is wrapped in an envelope with Kafka metadata (key, offset, timestamp, headers) alongside the value. Disable to write only the record's own value structure. No effect on CSV; for Parquet, only applies when the value is a record or map.

default: true
format.output.fields.user.definedstring[]

A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.

default: ["value"]
SQLServerDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

SQL Server Hostname

database.port.user.definedstringrequired

SQL Server Port. For example, 1433

default: "1433"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

table.name.prefixstringrequired

Schema for the associated table name

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

SnowflakeDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

snowflake.url.namestringrequired

The URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

snowflake.user.namestringrequired

User login name for the Snowflake account.

snowflake.private.keystring<password>required

The private key to authenticate the user. Include only the key, not the header or footer. If the key is split across multiple lines, remove the line breaks.

snowflake.private.key.passphrase.securedstring

If checked (default), provide your SSH key's passphrase, otherwise, uncheck for SSH keys without passphrase.

default: true
snowflake.private.key.passphrasestring<password>required

The passphrase is used to decrypt the private key.

sfwarehousestring

The name of the snowflake warehouse.

default: "STREAMKAP_WH"
snowflake.database.namestringrequired

The name of the database that contains the table to insert rows into.

snowflake.schema.namestringrequired

The name of the schema that contains the table to insert rows into.

create.schema.autostring

Automatically generates a Snowflake schema if it does not already exist.

default: true
snowflake.role.namestringrequired

The name of an existing role with necessary privileges (for Streamkap) assigned to the <Username>

default: "STREAMKAP_ROLE"
ingestion.modestring

<span>Upsert or append modes are available. NOTE: when switching append to upsert, existing data must be deduplicated or deleted. <a href='https://docs.streamkap.com/snowflake#upsert-mode' class='docs-url' target='_blank'>Read more about upsert mode</a> </span>

default: "append"
Allowed:[object Object][object Object]
hard.deletestring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)

default: true
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
use.hybrid.tablesstring

Specifies whether the connector should create Hybrid Tables (applies to upsert only)

default: false
apply.dynamic.table.scriptstring

Specifies whether the connector should create Dynamic Tables & Cleanup Tasks (applies to append only)

default: false
create.sql.executestring

These template queries run for each table the first time a record is streamed for them.

default: "CREATE OR REPLACE DYNAMIC TABLE {{table}}_DT TARGET_LAG='15 minutes' WAREHOUSE={{warehouse}} AS SELECT * EXCLUDE dedupe_id FROM( SELECT *, ROW_NUMBER() OVER (PARTITION BY {{primaryKeyColumns}} ORDER BY _streamkap_ts_ms DESC, _streamkap_offset DESC) AS dedupe_id FROM {{table}} ) WHERE dedupe_id = 1 AND __deleted = 'false';"
sql.table.namestring

Can be used as <code>{{dynamicTableName}}</code> in dynamic table creation SQL. It can use input JSON data for more complex mappings and logic.

default: "{{table}}_DT"
create.sql.datastring

Use <code>{"TABLE_DATA": {"{table_name}": {"{key}": "{value}"}, ...}, ...}</code> to set table specific data. This data will be available in the custom SQL templates e.g. <code>SELECT {{key}}</code>.

auto.qa.dedupe.table.mappingstring

Mapping between the tables that store append-only data and the deduplicated tables. The dedupeTable in mapping will be used for QA scripts. If dedupeSchema is not specified, the deduplicated table will be created in the same schema as the raw table.

snowflake.topic2table.mapstring

Define custom topic-to-table name mapping using regex. Format: <code>matching_pattern:replacement_pattern</code>. Use $1, $2, etc. for captured groups. Example: <code>^([-\w]+.)([-\w]+.)?([-\w]+.)?([-\w]+.)?([-\w]+):$5</code> uses only the last segment as table name.

default: "REGEX_MATCHER>^([-\\w]+\\.)([-\\w]+\\.)?([-\\w]+\\.)?([-\\w]+\\.)?([-\\w]+):$5"
transforms.KeyToValue.fields.include.liststring

Comma-separated list of key fields to copy into each record's value so they land as columns at the destination. Use * to copy all key fields, or <topic>.<field> patterns to scope by topic and field name (e.g. *.pk,*.sk where * matches any topic). Leave empty to disable.

StarburstDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

aws.access.key.idstringrequired

The AWS Access Key ID used to connect to Starburst.

aws.secret.access.keystring<password>required

The AWS Secret Access Key used to connect to Starburst.

aws.s3.regionstring

The AWS region to be used

default: "us-west-2"
Allowed:ap-south-1eu-west-2eu-west-1ap-northeast-2ap-northeast-1ca-central-1sa-east-1cn-north-1us-gov-west-1ap-southeast-1ap-southeast-2eu-central-1us-east-1us-east-2us-west-1us-west-2
aws.s3.bucket.namestringrequired

The Bucket to use.

format.user.definedstring

The format to use when writing data to the store.

default: "CSV"
Allowed:CSVJSON LinesJSON ArrayParquet
file.name.templatestring

The format of the filename. See documentation for more information about formatting options.

default: "{{topic}}-{{partition}}-{{start_offset}}"
file.name.prefixstring

Prefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).

file.compression.typestring

Compression type for files written to Starburst.

default: "gzip"
Allowed:nonegzipsnappyzstd
format.output.fields.user.definedstring[]

A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.

default: ["value"]
WeaviateDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

weaviate.connection.urlstringrequired

Weaviate connection URL

default: "http://localhost:8080"
weaviate.grpc.urlstringrequired

Weaviate gRPC connection URL

default: "localhost:50051"
weaviate.grpc.securedstring

Enable TLS encryption for gRPC connection

default: false
weaviate.auth.schemestring

Authentication mechanism to use to connect to Weaviate

default: "NONE"
Allowed:NONEAPI_KEYOIDC_CLIENT_CREDENTIALS
weaviate.api.keystring<password>required

User API Key for API Key authentication

weaviate.oidc.client.secretstring<password>required

User OIDC client secret for OIDC authentication

weaviate.oidc.scopesstring

OIDC client scopes (comma-separated)

default: "openid"
weaviate.headersstring

Custom headers to provide (format: key=value, one per line). Example: X-OpenAI-Api-Key=your-key

collection.mappingstring

Mapping between Kafka topic and Weaviate collection. Use ${topic} for dynamic topic name substitution

default: "${topic}"
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
document.id.strategy.user.definedstring

Strategy to generate document IDs

default: "None"
Allowed:NoneKafka IDField ID
document.id.field.namestring

Field name containing the ID in Kafka record

default: "id"
vector.strategy.user.definedstring

Strategy to generate or extract document embeddings

default: "None"
Allowed:NoneField Vector
vector.field.namestring

Field name containing the embedding vector

default: "vector"
weaviate.vectorizerstring

Sets the default Weaviate vectorizer to use for objects without explicit vector data. Applies to new collections only.

default: "text2vec-weaviate"
Allowed:nonetext2vec-weaviatetext2vec-coheretext2vec-jinaaitext2vec-openaitext2vec-voyageai
delete.enabledstring

Treat null record values as deletes. Requires Document ID Strategy to be set to either 'Kafka ID' or 'Field ID' (not 'None')

default: false
batch.sizestring

Number of records per batch

default: "100"
pool.sizestring

Number of thread pools to process batches

default: "1"
await.termination.msstring

Timeout for batch processing in milliseconds

default: "10000"
max.connection.retriesstring

Maximum number of retries for connection issues

default: "3"
max.timeout.retriesstring

Maximum number of retries for timeout issues

default: "3"
retry.intervalstring

Interval between retries in milliseconds

default: "2000"
retry.backoff.msstring

Backoff time between retries in milliseconds

default: "1000"
consistency.levelstring

Consistency level for writes (ALL, ONE, QUORUM)

default: "QUORUM"
Allowed:ALLONEQUORUM
created_fromEntityOriginEnum | any

Origin of the entity creation.

default: "api"
Show properties
Any of:
EntityOriginEnum
string
any
any
desired_stateDesiredStateEnum | any

Desired operational state of the destination.

Show properties
Any of:
DesiredStateEnum
string
any
any
kc_cluster_idstring | any

KC cluster to deploy this connector to. Omit for default cluster.

Show properties
Any of:
string
string
any
any
tagsstring[] | any

List of tag IDs to assign to this destination

Show properties
Any of:
string[]
Array of string
string
any
any
Responses
200

Successful Response

namestring | any

User-defined connector name

Show properties
Any of:
string
string
any
any
connectorstring | any

Connector type (e.g., 'snowflake', 'bigquery', 'clickhouse')

Show properties
Any of:
string
string
any
any
idstring | any

Unique identifier

Show properties
Any of:
string
string
any
any
connector_display_namestring | any

Human-readable connector type name

Show properties
Any of:
string
string
any
any
created_timestampstring | string<date-time> | any

Creation timestamp (ISO 8601)

Show properties
Any of:
string
string
string<date-time>
string<date-time>
any
any
sub_idstring | any

Subscription identifier

Show properties
Any of:
string
string
any
any
tenant_idstring | any

Tenant identifier for multi-tenancy

Show properties
Any of:
string
string
any
any
configBigQueryDestinationConfig | ClickhouseDestinationConfig | CockroachDBDestinationConfig | DatabricksDestinationConfig | Db2DestinationConfig | GCSDestinationConfig | HttpSinkDestinationConfig | IcebergDestinationConfig | KafkaDestinationConfig | KafkaDirectDestinationConfig | MotherduckDestinationConfig | MySQLDestinationConfig | OracleDestinationConfig | PineconeDestinationConfig | PostgreSQLDestinationConfig | R2DestinationConfig | RedisDestinationConfig | RedshiftDestinationConfig | S3DestinationConfig | SQLServerDestinationConfig | SnowflakeDestinationConfig | StarburstDestinationConfig | WeaviateDestinationConfig | any

Connector configuration parameters

Show properties
Any of:
BigQueryDestinationConfig | ClickhouseDestinationConfig | CockroachDBDestinationConfig | DatabricksDestinationConfig | Db2DestinationConfig | GCSDestinationConfig | HttpSinkDestinationConfig | IcebergDestinationConfig | KafkaDestinationConfig | KafkaDirectDestinationConfig | MotherduckDestinationConfig | MySQLDestinationConfig | OracleDestinationConfig | PineconeDestinationConfig | PostgreSQLDestinationConfig | R2DestinationConfig | RedisDestinationConfig | RedshiftDestinationConfig | S3DestinationConfig | SQLServerDestinationConfig | SnowflakeDestinationConfig | StarburstDestinationConfig | WeaviateDestinationConfig
One of:
BigQueryDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks.

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

keyfileobject<password>required

Upload the BigQuery service-account JSON key file.

defaultDatasetstringrequired

Name of the destination BigQuery dataset. The dataset must already exist.

timePartitioningTypestring

Time partitioning granularity used when auto-creating tables. Select NONE to create non-partitioned tables.

default: "DAY"
Allowed:DAYHOURMONTHYEARNONE
custom.partition.fieldstring

Optional record field to partition by. Leave blank for ingestion-time partitioning.

custom.clustering.fieldsstring

Optional comma-separated list of fields to cluster the table by (max 4).

custom.partition.expiration.daysstring

Optional. Automatically delete partitions older than this many days from tables this destination creates. Leave blank to keep all partitions. Ignored when Time Partitioning is NONE.

autoCreateTablesstring

Automatically create BigQuery tables for new topics.

default: true
allowNewBigQueryFieldsstring

Allow adding new columns to BigQuery tables when the schema evolves.

default: true
allowBigQueryRequiredFieldRelaxationstring

Allow changing BigQuery columns from REQUIRED to NULLABLE when the schema evolves.

default: true
ClickhouseDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active task

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: false
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

ingestion.modestring

Upsert or append modes are available

default: "upsert"
Allowed:[object Object][object Object]
hard.deletestring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)

default: true
hostnamestringrequired

ClickHouse Hostname Or IP address

connection.usernamestringrequired

Username to access ClickHouse

connection.passwordstring<password>required

Password to access the ClickHouse

portstringrequired

ClickHouse Port. For example, 8443

default: "8443"
databasestringrequired

ClickHouse database

sslstring

Enable TLS for network connections

default: true
topics.config.mapstring

Per topic configuration in JSON format

clickhouse.json.supportstring

Allow JSON data type in ClickHouse, make sure the ClickHouse server supports it. If not set, the connector will use String type for JSON data.

default: false
table.name.prefixstring

Optional prefix prepended to every destination table name (e.g. 'prod_' produces tables like 'prod_customers'). Only letters, digits, and underscores are allowed.

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
CockroachDBDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

CockroachDB Hostname

database.port.user.definedstringrequired

CockroachDB Port. For example, 26257

default: "26257"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

table.name.prefixstringrequired

Schema for the associated table name

default: "public"
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

DatabricksDestinationConfig
tasks.maxinteger

The maximum number of active tasks. NOTE: Increasing this value may increase parallelism and throughput but can also lead to higher costs on databricks side.

min 1 · max 100 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

ingestion.modestring

Upsert or append modes are available

default: "upsert"
Allowed:[object Object][object Object]
databricks.tokenstring<password>required

Token

connection.url.user.definedstringrequired

JDBC URL

connection.timeout.user.definedinteger

Connection Timeout

min 1 · default: "180"
databricks.catalog.user.definedstring

The name of the Databricks catalog to use.

default: "hive_metastore"
partition.modestring

Partition tables or not

default: "by_topic"
Allowed:by_topicby_partitionby_topic_and_partition
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
table.name.prefixstring

Schema for the associated table name

default: "streamkap"
hard.deletestring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
consumer.wait.time.for.larger.batch.msstring

Controls how long the connector waits to accumulate a larger batch before writing to Databricks. Higher values = larger batches = better throughput and fewer MERGE INTOs, but higher latency.

default: "10000"
Allowed:[object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object]
topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

Db2DestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

Db2 Hostname

database.port.user.definedstringrequired

Db2 Port. For example, 50000

default: "50000"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

GCSDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

gcs.credentials.jsonstring<password>

GCP credentials as a JSON string with escaped quotes (" into "). \n in the private_key field should also be escaped as \n. Example format: {"type": "service_account","project_id": "XXXXXX", ...}

gcs.bucket.namestringrequired

The GCS Bucket to use.

format.user.definedstring

The format to use when writing data to the store.

default: "CSV"
Allowed:CSVJSON LinesJSON ArrayParquet
file.name.templatestring

The format of the filename. See documentation for more information about formatting options.

default: "{{topic}}-{{partition}}-{{start_offset}}"
file.name.prefixstring

Prefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).

file.compression.typestring

Compression type for files written to GCS.

default: "gzip"
Allowed:nonegzipsnappyzstd
format.output.fields.user.definedstring[]

A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.

default: ["value"]
HttpSinkDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

http.urlstringrequired

The URL to send data to.

http.authorization.typestring

The HTTP authorization type.

default: "none"
Allowed:nonestaticoauth2
http.headers.authorizationstring

Static content of Authorization header (required for STATIC authorization).

oauth2.access.token.urlstringrequired

URL for fetching OAuth2 access token.

oauth2.client.idstringrequired

OAuth2 client id.

oauth2.client.secretstring<password>required

OAuth2 client secret.

oauth2.scopestringrequired

OAuth2 client scope.

http.headers.content.typestring

Value of Content-Type header for each request.

default: "application/json"
http.headers.additionalstring

Additional headers in header:value format, comma-separated.

http.proxy.hoststring

Proxy hostname.

http.proxy.portstring

Proxy port.

batching.enabledstring

Enable batching multiple records in a single HTTP request.

default: false
batch.max.sizeinteger

Maximum size of a record batch (1 to 1,000,000).

min 1 · max 1000000 · default: 500
batch.buffering.enabledstring

Enable buffering and only send records when batch.max.size reaches or batch.max.time.ms hits.

default: false
batch.max.time.msinteger

Maximum time to wait before flushing a batch (1 to 1,000,000,000 ms).

min 1 · max 1000000000 · default: 10000
batch.prefixstring

Prefix for record batches.

default: "["
batch.suffixstring

Suffix for record batches.

default: "]"
batch.separatorstring

Separator for records in a batch.

default: ","
max.retriesinteger

Maximum number of retries on errors.

min 0 · max 2147483647 · default: 1
retry.backoff.msinteger

Time in ms to wait before retrying.

min 0 · max 2147483647 · default: 3000
http.timeoutinteger

HTTP response timeout in seconds.

min 0 · max 2147483647 · default: 30
decimal.formatstring

Format for serializing decimals: BASE64 (default) or NUMERIC.

default: "NUMERIC"
Allowed:BASE64NUMERIC
errors.tolerance.user.definedstring

Error tolerance setting. Note: Cannot be used when Batching is enabled.

default: "none"
Allowed:noneall
IcebergDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

iceberg.catalog.typestring

Type of Iceberg catalog

default: "rest"
Allowed:[object Object][object Object][object Object]
iceberg.catalog.auth.modestring

How to authenticate with the Iceberg catalog. 'No Auth' for catalogs that don't require authentication. 'Token' for bearer token authentication (e.g., Cloudflare R2). 'OAuth2 Credential' for OAuth2 client credential authentication (e.g., Polaris, DataHub).

default: "none"
Allowed:[object Object][object Object][object Object]
iceberg.catalog.namestring

Iceberg catalog name

iceberg.catalog.client.assume-role.arnstring

AWS IAM role (e.g., arn:aws:iam::<your-account>:role/<role-name>)

iceberg.catalog.uristring

Catalog endpoint URL. For REST catalogs use https://… ; for Hive Metastore use thrift://… ; AWS Glue uses the regional endpoint.

iceberg.catalog.tokenstring<password>required

Bearer token used for catalog authentication.

iceberg.catalog.credentialstring<password>required

OAuth2 client credential in client_id:client_secret format.

iceberg.catalog.scopestringrequired

OAuth2 scope for catalog authentication (e.g., PRINCIPAL_ROLE:ALL).

default: "PRINCIPAL_ROLE:ALL"
iceberg.catalog.oauth2-server-uristring

OAuth2 token endpoint URI. Required when the REST catalog endpoint is not also the OAuth2 authorization server.

iceberg.catalog.audiencestring

Optional OAuth2 audience parameter to request from the token endpoint.

iceberg.catalog.resourcestring

Optional OAuth2 resource parameter to request from the token endpoint.

iceberg.catalog.s3.credentials.enabledboolean

Enable to provide your own S3 access key and secret. Disable if the catalog vends storage credentials automatically.

default: false
iceberg.catalog.s3.access-key-idstringrequired

The access key ID used to connect to S3 or S3-compatible storage.

iceberg.catalog.s3.secret-access-keystring<password>required

The secret access key used to connect to S3 or S3-compatible storage.

iceberg.catalog.client.region.user.definedstring

The AWS region to be used. For Cloudflare R2, select 'auto'.

default: "us-west-2"
Allowed:ap-south-1eu-west-2eu-west-1ap-northeast-2ap-northeast-1ca-central-1sa-east-1cn-north-1us-gov-west-1ap-southeast-1ap-southeast-2eu-central-1us-east-1us-east-2us-west-1us-west-2auto
iceberg.catalog.warehousestringrequired

The Iceberg warehouse identifier. For R2 Data Catalog, this should be the warehouse name configured in the catalog. For S3-based catalogs, this is typically an S3 or S3-compatible path (e.g., s3://bucket/path).

table.name.prefixstringrequired

Name of the database schema that contains the table (e.g., public, sales, analytics).

insert.mode.user.definedstring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:[object Object][object Object]
iceberg.tables.default-id-columnsstring

Optional. A comma-separated list of field names to use as record identifiers when key fields are not present in Kafka messages

iceberg.tables.hard-delete-enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)

default: true
iceberg.tables.compaction.enabledstring

Enable lightweight compaction of small data files after commits

default: false
iceberg.tables.compaction.target-file-size-bytesstring

Target file size in bytes for compaction. Files smaller than this are candidates for merging

default: "134217728"
iceberg.tables.compaction.min-small-filesstring

Minimum number of small files required before triggering compaction

default: "5"
iceberg.tables.compaction.max-files-per-runstring

Maximum number of small files to compact in a single run

default: "100"
iceberg.tables.compaction.commit-thresholdstring

Number of Iceberg commits between compaction checks

default: "5"
iceberg.tables.compaction.expire-snapshotsstring

Expire old snapshots and delete unreferenced data files after compaction

default: false
iceberg.tables.compaction.retain-laststring

Number of most recent snapshots to retain when expiring snapshots after compaction

default: "1"
KafkaDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

Maximum number of tasks for the connector

min 1 · max 100 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

kafka.sink.bootstrapstringrequired

A comma-separated list of host and port pairs that are the addresses of the Destination Kafka brokers. This list should be in the form host1:port1,host2:port2,...

destination.formatstring

The format to use when writing data to kafka

default: "json"
Allowed:avrojson
json.schema.enablestring

Include schema in json message

default: false
schema.registry.url.user.definedstringrequired

Destination kafka schema registry url

topic.prefixstring

Prefix for destination topics

topic.suffixstring

Suffix for destination topics

transforms.InsertField.offset.fieldstring

If Kafka destination is used to sync data between services or to apply some transformations, it would be better to rename this field to _streamkap_offset_sync or _streamkap_offset_transform to avoid conflicts with the destination on the other service

default: "_streamkap_offset"
transforms.changeTopicName.add.original.topicstring

Add the original topic name to the output record. 'off' disables it, 'header' adds it as a Kafka header, 'field' adds it as a _streamkap_topic column in the destination table.

default: "off"
Allowed:offheaderfield
KafkaDirectDestinationConfig
passwordstring<password>required

Password for setting up the Kafka proxy

whitelist.ips.user.definedstringrequired

A comma-separated list of IPs/CIDRs

MotherduckDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 25 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

ingestion.modestring

Upsert or append modes are available

default: "upsert"
Allowed:[object Object][object Object]
motherduck.tokenstring<password>required

Motherduck Token

motherduck.catalog.user.definedstringrequired

The name of the Motherduck database/catalog to use.

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
table.name.prefixstring

Schema for the associated table name

default: "streamkap"
hard.deletestring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

MySQLDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

MySQL Hostname

database.port.user.definedstringrequired

MySQL Port. For example, 3306

default: "3306"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

OracleDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

Oracle Hostname

database.port.user.definedstringrequired

Oracle Port. For example, 1521

default: "1521"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

PineconeDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

pinecone.api.keystring<password>required

API key for authenticating with Pinecone

pinecone.index.namestringrequired

Name of the target Pinecone index

pinecone.proxy.hoststring

Proxy host for Pinecone connections

pinecone.proxy.portstring

Proxy port for Pinecone connections (required if Proxy Host is set)

collection.mappingstring

Mapping between Kafka topic and Pinecone namespace. Use ${topic} for dynamic topic name substitution

default: "${topic}"
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created namespaces, set to NONE

default: "basic"
Allowed:[object Object][object Object]
document.id.strategy.user.definedstring

Strategy to generate document IDs. 'None' uses random UUIDs (append-only, no upsert/delete support)

default: "None"
Allowed:NoneKafka IDField ID
document.id.field.namestring

Field name containing the ID in Kafka record

default: "id"
vector.field.namestringrequired

Field name containing the embedding vector

default: "vector"
delete.enabledstring

Treat null record values or __deleted=true as deletes. Requires Document ID Strategy to be set to 'Kafka ID' (not 'None')

default: false
batch.sizestring

Number of records per batch

default: "100"
retry.maxstring

Maximum number of retry attempts for failed operations

default: "3"
retry.backoff.msstring

Backoff time between retries in milliseconds

default: "1000"
PostgreSQLDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

PostgreSQL Hostname

database.port.user.definedstringrequired

PostgreSQL Port. For example, 5432

default: "5432"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
table.name.prefixstringrequired

Schema for the associated table name

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

transforms.TopicRegexRouter1.regexstring

Rename destination tables using a regex pattern. The regex is matched against the full topic name — use capture groups to extract parts. Example: <code>..(.)</code> extracts the table name from <code>source_123.public.orders</code>. Leave empty to skip.

transforms.TopicRegexRouter1.replacementstring

The replacement value for the matched regex. Use <code>$1</code>, <code>$2</code> etc. to reference capture groups from the pattern. Example: <code>$1</code> with the pattern above produces <code>orders</code>.

default: "$0"
transforms.TopicRegexRouter2.regexstring

Optional second rename rule, applied after the first. Use when a single regex is not enough. Leave empty to skip.

transforms.TopicRegexRouter2.replacementstring

The replacement value for the second rename rule. Use <code>$1</code>, <code>$2</code> etc. to reference capture groups.

default: "$0"
topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
R2DestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

r2.account.user.definedstringrequired

Cloudflare R2 account ID. This is the account ID you see in the Cloudflare dashboard.

aws.access.key.idstringrequired

The Access Key ID used to connect to R2.

aws.secret.access.keystring<password>required

The Secret Access Key used to connect to R2.

aws.s3.bucket.namestringrequired

The R2 Bucket to use.

format.user.definedstring

The format to use when writing data to the store.

default: "JSON Array"
Allowed:JSON LinesJSON ArrayParquet
file.name.templatestring

The format of the filename. See documentation for more information about formatting options.

default: "{{topic}}-{{partition}}-{{start_offset}}"
file.name.prefixstring

Prefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).

file.compression.typestring

Compression type for files written to S3.

default: "gzip"
Allowed:nonegzipsnappyzstd
format.output.fields.user.definedstring[]

A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.

default: ["value"]
RedisDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

redis.host.user.definedstringrequired

Redis Hostname

redis.port.user.definedstringrequired

Redis Port. For example, 6379

default: "6379"
redis.usernamestringrequired

Username to access the Redis database

redis.passwordstring<password>required

Password to access the Redis database

ssl.enabledstring

Enable TLS for network connections

default: true
redis.keystringrequired

Redis key to stream the data

redis.key.data.typestring

Data Type of Redis Key. At the moment, only Stream and List are supported

default: "Stream"
Allowed:StreamListHash
RedshiftDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

aws.redshift.domainstringrequired

Domain of the leader of the cluster

aws.redshift.portstringrequired

Port number for incoming connections to the leader

default: "5439"
aws.redshift.databasestringrequired

Name of the database on the cluster

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

primary.key.fieldsstringrequired

List of comma-separated primary key field names

default: "id"
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
table.name.prefixstringrequired

Schema for the associated table name

S3DestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

aws.auth.modestringrequired

How Streamkap authenticates with S3. Choose Access Keys to use an AWS Access Key ID and Secret. Choose Cross-Account Role to have Streamkap assume an IAM role in your account using a Role ARN and External ID (recommended for production — see https://docs.streamkap.com/aws-cross-account-iam).

default: "Access Keys"
Allowed:Access KeysCross-Account Role
aws.access.key.idstringrequired

The AWS Access Key ID used to connect to S3.

aws.secret.access.keystring<password>required

The AWS Secret Access Key used to connect to S3.

aws.sts.role.arnstringrequired

ARN of the IAM role Streamkap should assume to write to your S3 bucket (e.g. arn:aws:iam::<your-account-id>:role/<role-name>). The role's trust policy must allow the Streamkap account to assume it.

aws.sts.role.external.idstringrequired

The External ID configured in your role's trust-policy condition. Streamkap passes this value verbatim when assuming the role.

aws.s3.regionstring

The AWS region to be used

default: "us-west-2"
Allowed:ap-south-1eu-west-2eu-west-1ap-northeast-2ap-northeast-1ca-central-1sa-east-1cn-north-1us-gov-west-1ap-southeast-1ap-southeast-2eu-central-1us-east-1us-east-2us-west-1us-west-2
aws.s3.bucket.namestringrequired

The S3 Bucket to use.

format.user.definedstring

The format to use when writing data to the store.

default: "JSON Array"
Allowed:JSON LinesJSON ArrayParquet
file.name.templatestring

The format of the filename. Static text can be added anywhere in the template, including at the start, to act as a directory prefix (e.g. dir1/dir2/{{topic}}-{{partition}}-{{start_offset}}). See documentation for more information about formatting options.

default: "{{topic}}-{{partition}}-{{start_offset}}"
file.compression.typestring

Compression type for files written to S3.

default: "gzip"
Allowed:nonegzipsnappyzstd
file.max.recordsinteger

Maximum number of records buffered into a single file before it is rotated. The rotated file is still only uploaded to S3 on the next flush interval. Set to 0 for unlimited (one file per topic-partition per flush interval).

min 0 · max 100000 · default: 0
aws.s3.part.size.bytesinteger

Size of each part in a multipart upload to S3, in bytes. Larger parts mean fewer S3 API calls for big files but more memory used per upload. AWS requires multipart parts to be at least 5MB (except the last part of a file).

min 5242880 · max 104857600 · default: 5242880
format.output.envelopeboolean

When enabled (default), each output record is wrapped in an envelope with Kafka metadata (key, offset, timestamp, headers) alongside the value. Disable to write only the record's own value structure. No effect on CSV; for Parquet, only applies when the value is a record or map.

default: true
format.output.fields.user.definedstring[]

A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.

default: ["value"]
SQLServerDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

database.hostname.user.definedstringrequired

SQL Server Hostname

database.port.user.definedstringrequired

SQL Server Port. For example, 1433

default: "1433"
database.database.user.definedstringrequired

Database name

connection.usernamestringrequired

Username to access the database

connection.passwordstring<password>required

Password to access with the database

table.name.prefixstringrequired

Schema for the associated table name

schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
insert.modestring

Specifies the strategy used to insert events into the database

default: "insert"
Allowed:insertupsert
delete.enabledstring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database

default: false
primary.key.mode.user.definedstring

Specifies how the connector resolves the primary key columns from the event

default: "record_key"
Allowed:nonerecord_keyrecord_value
primary.key.fieldsstring

Optional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.

topic2table.map.user.definedstring

Falls back to Streamkap's default for tables where no match is found

default: false
transforms.changeTopicName.mappingstring

Map source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line

SnowflakeDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

snowflake.url.namestringrequired

The URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

snowflake.user.namestringrequired

User login name for the Snowflake account.

snowflake.private.keystring<password>required

The private key to authenticate the user. Include only the key, not the header or footer. If the key is split across multiple lines, remove the line breaks.

snowflake.private.key.passphrase.securedstring

If checked (default), provide your SSH key's passphrase, otherwise, uncheck for SSH keys without passphrase.

default: true
snowflake.private.key.passphrasestring<password>required

The passphrase is used to decrypt the private key.

sfwarehousestring

The name of the snowflake warehouse.

default: "STREAMKAP_WH"
snowflake.database.namestringrequired

The name of the database that contains the table to insert rows into.

snowflake.schema.namestringrequired

The name of the schema that contains the table to insert rows into.

create.schema.autostring

Automatically generates a Snowflake schema if it does not already exist.

default: true
snowflake.role.namestringrequired

The name of an existing role with necessary privileges (for Streamkap) assigned to the <Username>

default: "STREAMKAP_ROLE"
ingestion.modestring

<span>Upsert or append modes are available. NOTE: when switching append to upsert, existing data must be deduplicated or deleted. <a href='https://docs.streamkap.com/snowflake#upsert-mode' class='docs-url' target='_blank'>Read more about upsert mode</a> </span>

default: "append"
Allowed:[object Object][object Object]
hard.deletestring

Specifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)

default: true
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
use.hybrid.tablesstring

Specifies whether the connector should create Hybrid Tables (applies to upsert only)

default: false
apply.dynamic.table.scriptstring

Specifies whether the connector should create Dynamic Tables & Cleanup Tasks (applies to append only)

default: false
create.sql.executestring

These template queries run for each table the first time a record is streamed for them.

default: "CREATE OR REPLACE DYNAMIC TABLE {{table}}_DT TARGET_LAG='15 minutes' WAREHOUSE={{warehouse}} AS SELECT * EXCLUDE dedupe_id FROM( SELECT *, ROW_NUMBER() OVER (PARTITION BY {{primaryKeyColumns}} ORDER BY _streamkap_ts_ms DESC, _streamkap_offset DESC) AS dedupe_id FROM {{table}} ) WHERE dedupe_id = 1 AND __deleted = 'false';"
sql.table.namestring

Can be used as <code>{{dynamicTableName}}</code> in dynamic table creation SQL. It can use input JSON data for more complex mappings and logic.

default: "{{table}}_DT"
create.sql.datastring

Use <code>{"TABLE_DATA": {"{table_name}": {"{key}": "{value}"}, ...}, ...}</code> to set table specific data. This data will be available in the custom SQL templates e.g. <code>SELECT {{key}}</code>.

auto.qa.dedupe.table.mappingstring

Mapping between the tables that store append-only data and the deduplicated tables. The dedupeTable in mapping will be used for QA scripts. If dedupeSchema is not specified, the deduplicated table will be created in the same schema as the raw table.

snowflake.topic2table.mapstring

Define custom topic-to-table name mapping using regex. Format: <code>matching_pattern:replacement_pattern</code>. Use $1, $2, etc. for captured groups. Example: <code>^([-\w]+.)([-\w]+.)?([-\w]+.)?([-\w]+.)?([-\w]+):$5</code> uses only the last segment as table name.

default: "REGEX_MATCHER>^([-\\w]+\\.)([-\\w]+\\.)?([-\\w]+\\.)?([-\\w]+\\.)?([-\\w]+):$5"
transforms.KeyToValue.fields.include.liststring

Comma-separated list of key fields to copy into each record's value so they land as columns at the destination. Use * to copy all key fields, or <topic>.<field> patterns to scope by topic and field name (e.g. *.pk,*.sk where * matches any topic). Leave empty to disable.

StarburstDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

aws.access.key.idstringrequired

The AWS Access Key ID used to connect to Starburst.

aws.secret.access.keystring<password>required

The AWS Secret Access Key used to connect to Starburst.

aws.s3.regionstring

The AWS region to be used

default: "us-west-2"
Allowed:ap-south-1eu-west-2eu-west-1ap-northeast-2ap-northeast-1ca-central-1sa-east-1cn-north-1us-gov-west-1ap-southeast-1ap-southeast-2eu-central-1us-east-1us-east-2us-west-1us-west-2
aws.s3.bucket.namestringrequired

The Bucket to use.

format.user.definedstring

The format to use when writing data to the store.

default: "CSV"
Allowed:CSVJSON LinesJSON ArrayParquet
file.name.templatestring

The format of the filename. See documentation for more information about formatting options.

default: "{{topic}}-{{partition}}-{{start_offset}}"
file.name.prefixstring

Prefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).

file.compression.typestring

Compression type for files written to Starburst.

default: "gzip"
Allowed:nonegzipsnappyzstd
format.output.fields.user.definedstring[]

A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.

default: ["value"]
WeaviateDestinationConfig
consumer.override.max.poll.recordsinteger

The maximum number of records returned in a single call to poll()

min 1 · max 100000 · default: 10000
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
quote.identifiersstring

Whether to quote identifiers in SQL statements

default: true
transforms.ToIntJ.fields.include.liststring

Convert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToFloatJ.fields.include.liststring

Convert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.fields.include.liststring

Convert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToDecimalJ.truncate.to.max.precisionboolean

If true, truncate decimals to a 38 precision

default: false
transforms.ToStringJ.fields.include.liststring

Convert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.fields.include.liststring

Convert column(s) to JSON String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to JSON String? - if possible.

default: false
transforms.ToJsonbJ.fields.include.liststring

Convert column(s) to Binary JSON - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ToJsonbJ.convert.all.complex.types.user.definedboolean

Convert all Structs and Arrays to Binary JSON? - if possible.

default: false
transforms.ToJsonbJ.convert.all.jsonboolean

Converts all JSON String column(s) to Binary JSON - if possible.

default: false
transforms.StringReplace.fields.include.liststring

Replaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.StringReplace.regex.patternsstring

List of regex patterns to search for. Comma separated list in format 'regex1,regex2'

transforms.StringReplace.replacement.valuesstring

List of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'

transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.MaskField.fields.include.liststring

Mask (anonymise) string column(s) in-place. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*').

transforms.MaskField.fields.exclude.liststring

Columns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.

transforms.MaskField.mask.functionstring

Masking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.

default: "SHA256_TRUNCATE"
Allowed:SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFY
transforms.MaskField.mask.saltstring

Secret salt prepended before hashing (used by the SHA256/MD5 functions). Strongly recommended: without it, low-cardinality values (phone, SSN, email) are reversible via a precomputed rainbow table.

default: ""
transforms.MaskField.mask.charstring

Fill character used by the REDACT function (length is preserved).

default: "*"
transforms.MaskField.mask.fixed.valuestring

Constant replacement used by the FIXED function.

default: "***"
transforms.MaskField.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
transforms.AddStringSuffix.fields.include.liststring

Warning: Should only be used in conjunction with numeric conversion or other conversions. If field remained string after previous conversion, rename to field to <previous-field-name>_str. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.changeTopicName.match.regex.user.definedstring

Regular expression for matching topic name parts to use as the destination table (database) or file (file storage) name

transforms.RenameFields.renames.user.definedstring

JSON mapping of source to target column names. Keys should be schema.table.column, table.column or just column. Values must be valid column names (no dots or spaces).

Example: { "public.orders.amount": "Amount", "orders.quantity": "Qty", "customer_id": "CustomerId" }

transforms.DropFields.fields.include.liststring

Drop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'

transforms.MarkColumnsAsRequired.fields.include.allboolean

When enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.

default: false
transforms.MarkColumnsAsRequired.null.sentinel.modestring

Controls how NULL values are handled when columns become required. NONE: throws an error on NULL values. TYPE_MIN: replaces NULLs with type-specific sentinel values (e.g. MIN_VALUE for integers, 'null' for strings, epoch for dates).

default: "NONE"
Allowed:NONETYPE_MIN
transforms.MarkColumnsAsOptional.fields.include.liststring

Mark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.CopyField.copy.field.mappingstring

Comma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.

transforms.HeaderToFieldCustom.header.mappingsstring

Headers to columns. Comma separated list of headers using format <code><header name>:<header type>[:field name]</code> e.g. 'headerKey1:STRING,headerKey2:INT32:customKey2Name'

weaviate.connection.urlstringrequired

Weaviate connection URL

default: "http://localhost:8080"
weaviate.grpc.urlstringrequired

Weaviate gRPC connection URL

default: "localhost:50051"
weaviate.grpc.securedstring

Enable TLS encryption for gRPC connection

default: false
weaviate.auth.schemestring

Authentication mechanism to use to connect to Weaviate

default: "NONE"
Allowed:NONEAPI_KEYOIDC_CLIENT_CREDENTIALS
weaviate.api.keystring<password>required

User API Key for API Key authentication

weaviate.oidc.client.secretstring<password>required

User OIDC client secret for OIDC authentication

weaviate.oidc.scopesstring

OIDC client scopes (comma-separated)

default: "openid"
weaviate.headersstring

Custom headers to provide (format: key=value, one per line). Example: X-OpenAI-Api-Key=your-key

collection.mappingstring

Mapping between Kafka topic and Weaviate collection. Use ${topic} for dynamic topic name substitution

default: "${topic}"
schema.evolutionstring

Controls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE

default: "basic"
Allowed:[object Object][object Object]
document.id.strategy.user.definedstring

Strategy to generate document IDs

default: "None"
Allowed:NoneKafka IDField ID
document.id.field.namestring

Field name containing the ID in Kafka record

default: "id"
vector.strategy.user.definedstring

Strategy to generate or extract document embeddings

default: "None"
Allowed:NoneField Vector
vector.field.namestring

Field name containing the embedding vector

default: "vector"
weaviate.vectorizerstring

Sets the default Weaviate vectorizer to use for objects without explicit vector data. Applies to new collections only.

default: "text2vec-weaviate"
Allowed:nonetext2vec-weaviatetext2vec-coheretext2vec-jinaaitext2vec-openaitext2vec-voyageai
delete.enabledstring

Treat null record values as deletes. Requires Document ID Strategy to be set to either 'Kafka ID' or 'Field ID' (not 'None')

default: false
batch.sizestring

Number of records per batch

default: "100"
pool.sizestring

Number of thread pools to process batches

default: "1"
await.termination.msstring

Timeout for batch processing in milliseconds

default: "10000"
max.connection.retriesstring

Maximum number of retries for connection issues

default: "3"
max.timeout.retriesstring

Maximum number of retries for timeout issues

default: "3"
retry.intervalstring

Interval between retries in milliseconds

default: "2000"
retry.backoff.msstring

Backoff time between retries in milliseconds

default: "1000"
consistency.levelstring

Consistency level for writes (ALL, ONE, QUORUM)

default: "QUORUM"
Allowed:ALLONEQUORUM
any
any
topic_idsstring | integer[] | any

List of associated topic identifiers

Show properties
Any of:
string | integer[]
Array of string | integer
Any of:
string
string
integer
integer
any
any
topic_mapobject | any

Mapping of topics to their partitions or related entities

Show properties
Any of:
object
object
any
any
topicsstring | integer[] | any

List of topic names

Show properties
Any of:
string | integer[]
Array of string | integer
Any of:
string
string
integer
integer
any
any
tasksinteger[] | any

List of task identifiers

Show properties
Any of:
integer[]
Array of integer
integer
any
any
connector_statusstring | any

Current status: Active, Paused, Stopped, Broken, Starting, Unassigned, Unknown, Pending

Show properties
Any of:
string
string
any
any
desired_statestring | any

Desired state: Pending, Active, Paused, Stopped

Show properties
Any of:
string
string
any
any
kc_cluster_idstring | any

KC cluster this connector is deployed to. None means default cluster.

Show properties
Any of:
string
string
any
any
task_statusesobject | any

Status information for each connector task

Show properties
Any of:
object
object
any
any
tagsstring[] | any

List of tag IDs assigned to this destination

Show properties
Any of:
string[]
Array of string
string
any
any
422

Validation Error

detailValidationError[]
Show properties
Array of ValidationError
locstring | integer[]required
Show properties
Array of string | integer
Any of:
string
string
integer
integer
msgstringrequired
typestringrequired
inputany
ctxobject
Request
curl -X POST "https://api.streamkap.com/destinations" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "connector": "string",
  "config": {
    "consumer.override.max.poll.records": 10000,
    "tasks.max": 5,
    "preserve.null.values": false,
    "quote.identifiers": true,
    "transforms.ToIntJ.fields.include.list": "string",
    "transforms.ToFloatJ.fields.include.list": "string",
    "transforms.ToDecimalJ.fields.include.list": "string",
    "transforms.ToDecimalJ.truncate.to.max.precision": false,
    "transforms.ToStringJ.fields.include.list": "string",
    "transforms.ToJsonJ.fields.include.list": "string",
    "transforms.ToJsonJ.convert.all.complex.types.user.defined": false,
    "transforms.ToJsonbJ.fields.include.list": "string",
    "transforms.ToJsonbJ.convert.all.complex.types.user.defined": false,
    "transforms.ToJsonbJ.convert.all.json": false,
    "transforms.StringReplace.fields.include.list": "string",
    "transforms.StringReplace.regex.patterns": "string",
    "transforms.StringReplace.replacement.values": "string",
    "transforms.OversizedRecords.fields.include.list": "string",
    "transforms.OversizedRecords.fields.exclude.list": "string",
    "transforms.OversizedRecords.max.field.size.bytes": 1048576,
    "transforms.OversizedRecords.oversized.field.behavior": "TRUNCATE",
    "transforms.OversizedRecords.truncation.suffix": "",
    "transforms.OversizedRecords.max.record.size.bytes": -1,
    "transforms.OversizedRecords.semantic.types.exclude": "io.debezium.data.Json,io.debezium.data.Xml",
    "transforms.OversizedRecords.replace.null.with.default": true,
    "transforms.MaskField.fields.include.list": "string",
    "transforms.MaskField.fields.exclude.list": "string",
    "transforms.MaskField.mask.function": "SHA256_TRUNCATE",
    "transforms.MaskField.mask.salt": "",
    "transforms.MaskField.mask.char": "*",
    "transforms.MaskField.mask.fixed.value": "***",
    "transforms.MaskField.replace.null.with.default": true,
    "transforms.AddStringSuffix.fields.include.list": "string",
    "transforms.changeTopicName.match.regex.user.defined": "string",
    "transforms.RenameFields.renames.user.defined": "string",
    "transforms.DropFields.fields.include.list": "string",
    "transforms.MarkColumnsAsRequired.fields.include.all": false,
    "transforms.MarkColumnsAsRequired.null.sentinel.mode": "NONE",
    "transforms.MarkColumnsAsOptional.fields.include.list": "string",
    "transforms.CopyField.copy.field.mapping": "string",
    "transforms.HeaderToFieldCustom.header.mappings": "string",
    "keyfile": {},
    "defaultDataset": "string",
    "timePartitioningType": "DAY",
    "custom.partition.field": "string",
    "custom.clustering.fields": "string",
    "custom.partition.expiration.days": "string",
    "autoCreateTables": true,
    "allowNewBigQueryFields": true,
    "allowBigQueryRequiredFieldRelaxation": true
  },
  "created_from": "api",
  "desired_state": "Pending",
  "kc_cluster_id": "string",
  "tags": [
    "string"
  ]
}'
Response
{
  "name": "string",
  "connector": "string",
  "id": "string",
  "connector_display_name": "string",
  "created_timestamp": "string",
  "sub_id": "string",
  "tenant_id": "string",
  "config": {
    "consumer.override.max.poll.records": 10000,
    "tasks.max": 5,
    "preserve.null.values": false,
    "quote.identifiers": true,
    "transforms.ToIntJ.fields.include.list": "string",
    "transforms.ToFloatJ.fields.include.list": "string",
    "transforms.ToDecimalJ.fields.include.list": "string",
    "transforms.ToDecimalJ.truncate.to.max.precision": false,
    "transforms.ToStringJ.fields.include.list": "string",
    "transforms.ToJsonJ.fields.include.list": "string",
    "transforms.ToJsonJ.convert.all.complex.types.user.defined": false,
    "transforms.ToJsonbJ.fields.include.list": "string",
    "transforms.ToJsonbJ.convert.all.complex.types.user.defined": false,
    "transforms.ToJsonbJ.convert.all.json": false,
    "transforms.StringReplace.fields.include.list": "string",
    "transforms.StringReplace.regex.patterns": "string",
    "transforms.StringReplace.replacement.values": "string",
    "transforms.OversizedRecords.fields.include.list": "string",
    "transforms.OversizedRecords.fields.exclude.list": "string",
    "transforms.OversizedRecords.max.field.size.bytes": 1048576,
    "transforms.OversizedRecords.oversized.field.behavior": "TRUNCATE",
    "transforms.OversizedRecords.truncation.suffix": "",
    "transforms.OversizedRecords.max.record.size.bytes": -1,
    "transforms.OversizedRecords.semantic.types.exclude": "io.debezium.data.Json,io.debezium.data.Xml",
    "transforms.OversizedRecords.replace.null.with.default": true,
    "transforms.MaskField.fields.include.list": "string",
    "transforms.MaskField.fields.exclude.list": "string",
    "transforms.MaskField.mask.function": "SHA256_TRUNCATE",
    "transforms.MaskField.mask.salt": "",
    "transforms.MaskField.mask.char": "*",
    "transforms.MaskField.mask.fixed.value": "***",
    "transforms.MaskField.replace.null.with.default": true,
    "transforms.AddStringSuffix.fields.include.list": "string",
    "transforms.changeTopicName.match.regex.user.defined": "string",
    "transforms.RenameFields.renames.user.defined": "string",
    "transforms.DropFields.fields.include.list": "string",
    "transforms.MarkColumnsAsRequired.fields.include.all": false,
    "transforms.MarkColumnsAsRequired.null.sentinel.mode": "NONE",
    "transforms.MarkColumnsAsOptional.fields.include.list": "string",
    "transforms.CopyField.copy.field.mapping": "string",
    "transforms.HeaderToFieldCustom.header.mappings": "string",
    "keyfile": {},
    "defaultDataset": "string",
    "timePartitioningType": "DAY",
    "custom.partition.field": "string",
    "custom.clustering.fields": "string",
    "custom.partition.expiration.days": "string",
    "autoCreateTables": true,
    "allowNewBigQueryFields": true,
    "allowBigQueryRequiredFieldRelaxation": true
  },
  "topic_ids": [
    "string"
  ],
  "topic_map": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "topics": [
    "string"
  ],
  "tasks": [
    0
  ],
  "connector_status": "string",
  "desired_state": "string",
  "kc_cluster_id": "string",
  "task_statuses": {
    "property1": {
      "property1": "string",
      "property2": "string"
    },
    "property2": {
      "property1": "string",
      "property2": "string"
    }
  },
  "tags": [
    "string"
  ]
}