Create New Destination
/destinationsAuthorizationBearer token · headerrequiredsecret_returnedbooleanWhether to include secret values in the response
waitbooleanWhen False, save config and return immediately without waiting for KC deployment
application/jsonnamestringrequiredDisplay name for the destination connector.
connectorstringrequiredConnector 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 | WeaviateDestinationConfigrequiredConnector-specific configuration properties. The schema depends on the connector type specified in the 'connector' field.
Show propertiesHide properties
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks.
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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>requiredUpload the BigQuery service-account JSON key file.
defaultDatasetstringrequiredName of the destination BigQuery dataset. The dataset must already exist.
timePartitioningTypestringTime partitioning granularity used when auto-creating tables. Select NONE to create non-partitioned tables.
DAYHOURMONTHYEARNONEcustom.partition.fieldstringOptional record field to partition by. Leave blank for ingestion-time partitioning.
custom.clustering.fieldsstringOptional comma-separated list of fields to cluster the table by (max 4).
custom.partition.expiration.daysstringOptional. 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.
autoCreateTablesstringAutomatically create BigQuery tables for new topics.
allowNewBigQueryFieldsstringAllow adding new columns to BigQuery tables when the schema evolves.
allowBigQueryRequiredFieldRelaxationstringAllow changing BigQuery columns from REQUIRED to NULLABLE when the schema evolves.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active task
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.modestringUpsert or append modes are available
[object Object][object Object]hard.deletestringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)
hostnamestringrequiredClickHouse Hostname Or IP address
connection.usernamestringrequiredUsername to access ClickHouse
connection.passwordstring<password>requiredPassword to access the ClickHouse
portstringrequiredClickHouse Port. For example, 8443
databasestringrequiredClickHouse database
sslstringEnable TLS for network connections
topics.config.mapstringPer topic configuration in JSON format
clickhouse.json.supportstringAllow JSON data type in ClickHouse, make sure the ClickHouse server supports it. If not set, the connector will use String type for JSON data.
table.name.prefixstringOptional prefix prepended to every destination table name (e.g. 'prod_' produces tables like 'prod_customers'). Only letters, digits, and underscores are allowed.
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredCockroachDB Hostname
database.port.user.definedstringrequiredCockroachDB Port. For example, 26257
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
table.name.prefixstringrequiredSchema for the associated table name
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
tasks.maxintegerThe maximum number of active tasks. NOTE: Increasing this value may increase parallelism and throughput but can also lead to higher costs on databricks side.
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.modestringUpsert or append modes are available
[object Object][object Object]databricks.tokenstring<password>requiredToken
connection.url.user.definedstringrequiredJDBC URL
connection.timeout.user.definedintegerConnection Timeout
databricks.catalog.user.definedstringThe name of the Databricks catalog to use.
partition.modestringPartition tables or not
by_topicby_partitionby_topic_and_partitionschema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]table.name.prefixstringSchema for the associated table name
hard.deletestringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
consumer.wait.time.for.larger.batch.msstringControls 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.
[object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object]topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredDb2 Hostname
database.port.user.definedstringrequiredDb2 Port. For example, 50000
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.namestringrequiredThe GCS Bucket to use.
format.user.definedstringThe format to use when writing data to the store.
CSVJSON LinesJSON ArrayParquetfile.name.templatestringThe format of the filename. See documentation for more information about formatting options.
file.name.prefixstringPrefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).
file.compression.typestringCompression type for files written to GCS.
nonegzipsnappyzstdformat.output.fields.user.definedstring[]A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.urlstringrequiredThe URL to send data to.
http.authorization.typestringThe HTTP authorization type.
nonestaticoauth2http.headers.authorizationstringStatic content of Authorization header (required for STATIC authorization).
oauth2.access.token.urlstringrequiredURL for fetching OAuth2 access token.
oauth2.client.idstringrequiredOAuth2 client id.
oauth2.client.secretstring<password>requiredOAuth2 client secret.
oauth2.scopestringrequiredOAuth2 client scope.
http.headers.content.typestringValue of Content-Type header for each request.
http.headers.additionalstringAdditional headers in header:value format, comma-separated.
http.proxy.hoststringProxy hostname.
http.proxy.portstringProxy port.
batching.enabledstringEnable batching multiple records in a single HTTP request.
batch.max.sizeintegerMaximum size of a record batch (1 to 1,000,000).
batch.buffering.enabledstringEnable buffering and only send records when batch.max.size reaches or batch.max.time.ms hits.
batch.max.time.msintegerMaximum time to wait before flushing a batch (1 to 1,000,000,000 ms).
batch.prefixstringPrefix for record batches.
batch.suffixstringSuffix for record batches.
batch.separatorstringSeparator for records in a batch.
max.retriesintegerMaximum number of retries on errors.
retry.backoff.msintegerTime in ms to wait before retrying.
http.timeoutintegerHTTP response timeout in seconds.
decimal.formatstringFormat for serializing decimals: BASE64 (default) or NUMERIC.
BASE64NUMERICerrors.tolerance.user.definedstringError tolerance setting. Note: Cannot be used when Batching is enabled.
noneallconsumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.typestringType of Iceberg catalog
[object Object][object Object][object Object]iceberg.catalog.auth.modestringHow 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).
[object Object][object Object][object Object]iceberg.catalog.namestringIceberg catalog name
iceberg.catalog.client.assume-role.arnstringAWS IAM role (e.g., arn:aws:iam::<your-account>:role/<role-name>)
iceberg.catalog.uristringCatalog endpoint URL. For REST catalogs use https://… ; for Hive Metastore use thrift://… ; AWS Glue uses the regional endpoint.
iceberg.catalog.tokenstring<password>requiredBearer token used for catalog authentication.
iceberg.catalog.credentialstring<password>requiredOAuth2 client credential in client_id:client_secret format.
iceberg.catalog.scopestringrequiredOAuth2 scope for catalog authentication (e.g., PRINCIPAL_ROLE:ALL).
iceberg.catalog.oauth2-server-uristringOAuth2 token endpoint URI. Required when the REST catalog endpoint is not also the OAuth2 authorization server.
iceberg.catalog.audiencestringOptional OAuth2 audience parameter to request from the token endpoint.
iceberg.catalog.resourcestringOptional OAuth2 resource parameter to request from the token endpoint.
iceberg.catalog.s3.credentials.enabledbooleanEnable to provide your own S3 access key and secret. Disable if the catalog vends storage credentials automatically.
iceberg.catalog.s3.access-key-idstringrequiredThe access key ID used to connect to S3 or S3-compatible storage.
iceberg.catalog.s3.secret-access-keystring<password>requiredThe secret access key used to connect to S3 or S3-compatible storage.
iceberg.catalog.client.region.user.definedstringThe AWS region to be used. For Cloudflare R2, select 'auto'.
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-2autoiceberg.catalog.warehousestringrequiredThe 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.prefixstringrequiredName of the database schema that contains the table (e.g., public, sales, analytics).
insert.mode.user.definedstringSpecifies the strategy used to insert events into the database
[object Object][object Object]iceberg.tables.default-id-columnsstringOptional. 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-enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)
iceberg.tables.compaction.enabledstringEnable lightweight compaction of small data files after commits
iceberg.tables.compaction.target-file-size-bytesstringTarget file size in bytes for compaction. Files smaller than this are candidates for merging
iceberg.tables.compaction.min-small-filesstringMinimum number of small files required before triggering compaction
iceberg.tables.compaction.max-files-per-runstringMaximum number of small files to compact in a single run
iceberg.tables.compaction.commit-thresholdstringNumber of Iceberg commits between compaction checks
iceberg.tables.compaction.expire-snapshotsstringExpire old snapshots and delete unreferenced data files after compaction
iceberg.tables.compaction.retain-laststringNumber of most recent snapshots to retain when expiring snapshots after compaction
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerMaximum number of tasks for the connector
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.bootstrapstringrequiredA 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.formatstringThe format to use when writing data to kafka
avrojsonjson.schema.enablestringInclude schema in json message
schema.registry.url.user.definedstringrequiredDestination kafka schema registry url
topic.prefixstringPrefix for destination topics
topic.suffixstringSuffix for destination topics
transforms.InsertField.offset.fieldstringIf 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
transforms.changeTopicName.add.original.topicstringAdd 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.
offheaderfieldpasswordstring<password>requiredPassword for setting up the Kafka proxy
whitelist.ips.user.definedstringrequiredA comma-separated list of IPs/CIDRs
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.modestringUpsert or append modes are available
[object Object][object Object]motherduck.tokenstring<password>requiredMotherduck Token
motherduck.catalog.user.definedstringrequiredThe name of the Motherduck database/catalog to use.
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]table.name.prefixstringSchema for the associated table name
hard.deletestringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredMySQL Hostname
database.port.user.definedstringrequiredMySQL Port. For example, 3306
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredOracle Hostname
database.port.user.definedstringrequiredOracle Port. For example, 1521
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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>requiredAPI key for authenticating with Pinecone
pinecone.index.namestringrequiredName of the target Pinecone index
pinecone.proxy.hoststringProxy host for Pinecone connections
pinecone.proxy.portstringProxy port for Pinecone connections (required if Proxy Host is set)
collection.mappingstringMapping between Kafka topic and Pinecone namespace. Use ${topic} for dynamic topic name substitution
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created namespaces, set to NONE
[object Object][object Object]document.id.strategy.user.definedstringStrategy to generate document IDs. 'None' uses random UUIDs (append-only, no upsert/delete support)
NoneKafka IDField IDdocument.id.field.namestringField name containing the ID in Kafka record
vector.field.namestringrequiredField name containing the embedding vector
delete.enabledstringTreat null record values or __deleted=true as deletes. Requires Document ID Strategy to be set to 'Kafka ID' (not 'None')
batch.sizestringNumber of records per batch
retry.maxstringMaximum number of retry attempts for failed operations
retry.backoff.msstringBackoff time between retries in milliseconds
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredPostgreSQL Hostname
database.port.user.definedstringrequiredPostgreSQL Port. For example, 5432
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword 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>
ssh.hoststringrequiredHostname of your SSH server
ssh.portstringrequiredPort of your SSH server
ssh.userstringrequiredUser that allows Streamkap to connect to SSH server
table.name.prefixstringrequiredSchema for the associated table name
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
transforms.TopicRegexRouter1.regexstringRename 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.replacementstringThe 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>.
transforms.TopicRegexRouter2.regexstringOptional second rename rule, applied after the first. Use when a single regex is not enough. Leave empty to skip.
transforms.TopicRegexRouter2.replacementstringThe replacement value for the second rename rule. Use <code>$1</code>, <code>$2</code> etc. to reference capture groups.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap 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.displayedstringrequiredPublic key to add to SSH server
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredCloudflare R2 account ID. This is the account ID you see in the Cloudflare dashboard.
aws.access.key.idstringrequiredThe Access Key ID used to connect to R2.
aws.secret.access.keystring<password>requiredThe Secret Access Key used to connect to R2.
aws.s3.bucket.namestringrequiredThe R2 Bucket to use.
format.user.definedstringThe format to use when writing data to the store.
JSON LinesJSON ArrayParquetfile.name.templatestringThe format of the filename. See documentation for more information about formatting options.
file.name.prefixstringPrefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).
file.compression.typestringCompression type for files written to S3.
nonegzipsnappyzstdformat.output.fields.user.definedstring[]A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredRedis Hostname
redis.port.user.definedstringrequiredRedis Port. For example, 6379
redis.usernamestringrequiredUsername to access the Redis database
redis.passwordstring<password>requiredPassword to access the Redis database
ssl.enabledstringEnable TLS for network connections
redis.keystringrequiredRedis key to stream the data
redis.key.data.typestringData Type of Redis Key. At the moment, only Stream and List are supported
StreamListHashconsumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.domainstringrequiredDomain of the leader of the cluster
aws.redshift.portstringrequiredPort number for incoming connections to the leader
aws.redshift.databasestringrequiredName of the database on the cluster
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
primary.key.fieldsstringrequiredList of comma-separated primary key field names
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]table.name.prefixstringrequiredSchema for the associated table name
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.modestringrequiredHow 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).
Access KeysCross-Account Roleaws.access.key.idstringrequiredThe AWS Access Key ID used to connect to S3.
aws.secret.access.keystring<password>requiredThe AWS Secret Access Key used to connect to S3.
aws.sts.role.arnstringrequiredARN 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.idstringrequiredThe External ID configured in your role's trust-policy condition. Streamkap passes this value verbatim when assuming the role.
aws.s3.regionstringThe AWS region to be used
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-2aws.s3.bucket.namestringrequiredThe S3 Bucket to use.
format.user.definedstringThe format to use when writing data to the store.
JSON LinesJSON ArrayParquetfile.name.templatestringThe 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.
file.compression.typestringCompression type for files written to S3.
nonegzipsnappyzstdfile.max.recordsintegerMaximum 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).
aws.s3.part.size.bytesintegerSize 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).
format.output.envelopebooleanWhen 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.
format.output.fields.user.definedstring[]A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredSQL Server Hostname
database.port.user.definedstringrequiredSQL Server Port. For example, 1433
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
table.name.prefixstringrequiredSchema for the associated table name
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.namestringrequiredThe 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.namestringrequiredUser login name for the Snowflake account.
snowflake.private.keystring<password>requiredThe 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.securedstringIf checked (default), provide your SSH key's passphrase, otherwise, uncheck for SSH keys without passphrase.
snowflake.private.key.passphrasestring<password>requiredThe passphrase is used to decrypt the private key.
sfwarehousestringThe name of the snowflake warehouse.
snowflake.database.namestringrequiredThe name of the database that contains the table to insert rows into.
snowflake.schema.namestringrequiredThe name of the schema that contains the table to insert rows into.
create.schema.autostringAutomatically generates a Snowflake schema if it does not already exist.
snowflake.role.namestringrequiredThe name of an existing role with necessary privileges (for Streamkap) assigned to the <Username>
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>
[object Object][object Object]hard.deletestringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]use.hybrid.tablesstringSpecifies whether the connector should create Hybrid Tables (applies to upsert only)
apply.dynamic.table.scriptstringSpecifies whether the connector should create Dynamic Tables & Cleanup Tasks (applies to append only)
create.sql.executestringThese template queries run for each table the first time a record is streamed for them.
sql.table.namestringCan be used as <code>{{dynamicTableName}}</code> in dynamic table creation SQL. It can use input JSON data for more complex mappings and logic.
create.sql.datastringUse <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.mappingstringMapping 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.mapstringDefine 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.
transforms.KeyToValue.fields.include.liststringComma-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.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.idstringrequiredThe AWS Access Key ID used to connect to Starburst.
aws.secret.access.keystring<password>requiredThe AWS Secret Access Key used to connect to Starburst.
aws.s3.regionstringThe AWS region to be used
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-2aws.s3.bucket.namestringrequiredThe Bucket to use.
format.user.definedstringThe format to use when writing data to the store.
CSVJSON LinesJSON ArrayParquetfile.name.templatestringThe format of the filename. See documentation for more information about formatting options.
file.name.prefixstringPrefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).
file.compression.typestringCompression type for files written to Starburst.
nonegzipsnappyzstdformat.output.fields.user.definedstring[]A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.urlstringrequiredWeaviate connection URL
weaviate.grpc.urlstringrequiredWeaviate gRPC connection URL
weaviate.grpc.securedstringEnable TLS encryption for gRPC connection
weaviate.auth.schemestringAuthentication mechanism to use to connect to Weaviate
NONEAPI_KEYOIDC_CLIENT_CREDENTIALSweaviate.api.keystring<password>requiredUser API Key for API Key authentication
weaviate.oidc.client.secretstring<password>requiredUser OIDC client secret for OIDC authentication
weaviate.oidc.scopesstringOIDC client scopes (comma-separated)
weaviate.headersstringCustom headers to provide (format: key=value, one per line). Example: X-OpenAI-Api-Key=your-key
collection.mappingstringMapping between Kafka topic and Weaviate collection. Use ${topic} for dynamic topic name substitution
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]document.id.strategy.user.definedstringStrategy to generate document IDs
NoneKafka IDField IDdocument.id.field.namestringField name containing the ID in Kafka record
vector.strategy.user.definedstringStrategy to generate or extract document embeddings
NoneField Vectorvector.field.namestringField name containing the embedding vector
weaviate.vectorizerstringSets the default Weaviate vectorizer to use for objects without explicit vector data. Applies to new collections only.
nonetext2vec-weaviatetext2vec-coheretext2vec-jinaaitext2vec-openaitext2vec-voyageaidelete.enabledstringTreat null record values as deletes. Requires Document ID Strategy to be set to either 'Kafka ID' or 'Field ID' (not 'None')
batch.sizestringNumber of records per batch
pool.sizestringNumber of thread pools to process batches
await.termination.msstringTimeout for batch processing in milliseconds
max.connection.retriesstringMaximum number of retries for connection issues
max.timeout.retriesstringMaximum number of retries for timeout issues
retry.intervalstringInterval between retries in milliseconds
retry.backoff.msstringBackoff time between retries in milliseconds
consistency.levelstringConsistency level for writes (ALL, ONE, QUORUM)
ALLONEQUORUMcreated_fromEntityOriginEnum | anyOrigin of the entity creation.
Show propertiesHide properties
stringanydesired_stateDesiredStateEnum | anyDesired operational state of the destination.
Show propertiesHide properties
stringanykc_cluster_idstring | anyKC cluster to deploy this connector to. Omit for default cluster.
Show propertiesHide properties
stringanytagsstring[] | anyList of tag IDs to assign to this destination
Show propertiesHide properties
stringstringanySuccessful Response
namestring | anyUser-defined connector name
Show propertiesHide properties
stringanyconnectorstring | anyConnector type (e.g., 'snowflake', 'bigquery', 'clickhouse')
Show propertiesHide properties
stringanyidstring | anyUnique identifier
Show propertiesHide properties
stringanyconnector_display_namestring | anyHuman-readable connector type name
Show propertiesHide properties
stringanycreated_timestampstring | string<date-time> | anyCreation timestamp (ISO 8601)
Show propertiesHide properties
stringstring<date-time>anysub_idstring | anySubscription identifier
Show propertiesHide properties
stringanytenant_idstring | anyTenant identifier for multi-tenancy
Show propertiesHide properties
stringanyconfigBigQueryDestinationConfig | ClickhouseDestinationConfig | CockroachDBDestinationConfig | DatabricksDestinationConfig | Db2DestinationConfig | GCSDestinationConfig | HttpSinkDestinationConfig | IcebergDestinationConfig | KafkaDestinationConfig | KafkaDirectDestinationConfig | MotherduckDestinationConfig | MySQLDestinationConfig | OracleDestinationConfig | PineconeDestinationConfig | PostgreSQLDestinationConfig | R2DestinationConfig | RedisDestinationConfig | RedshiftDestinationConfig | S3DestinationConfig | SQLServerDestinationConfig | SnowflakeDestinationConfig | StarburstDestinationConfig | WeaviateDestinationConfig | anyConnector configuration parameters
Show propertiesHide properties
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks.
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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>requiredUpload the BigQuery service-account JSON key file.
defaultDatasetstringrequiredName of the destination BigQuery dataset. The dataset must already exist.
timePartitioningTypestringTime partitioning granularity used when auto-creating tables. Select NONE to create non-partitioned tables.
DAYHOURMONTHYEARNONEcustom.partition.fieldstringOptional record field to partition by. Leave blank for ingestion-time partitioning.
custom.clustering.fieldsstringOptional comma-separated list of fields to cluster the table by (max 4).
custom.partition.expiration.daysstringOptional. 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.
autoCreateTablesstringAutomatically create BigQuery tables for new topics.
allowNewBigQueryFieldsstringAllow adding new columns to BigQuery tables when the schema evolves.
allowBigQueryRequiredFieldRelaxationstringAllow changing BigQuery columns from REQUIRED to NULLABLE when the schema evolves.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active task
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.modestringUpsert or append modes are available
[object Object][object Object]hard.deletestringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)
hostnamestringrequiredClickHouse Hostname Or IP address
connection.usernamestringrequiredUsername to access ClickHouse
connection.passwordstring<password>requiredPassword to access the ClickHouse
portstringrequiredClickHouse Port. For example, 8443
databasestringrequiredClickHouse database
sslstringEnable TLS for network connections
topics.config.mapstringPer topic configuration in JSON format
clickhouse.json.supportstringAllow JSON data type in ClickHouse, make sure the ClickHouse server supports it. If not set, the connector will use String type for JSON data.
table.name.prefixstringOptional prefix prepended to every destination table name (e.g. 'prod_' produces tables like 'prod_customers'). Only letters, digits, and underscores are allowed.
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredCockroachDB Hostname
database.port.user.definedstringrequiredCockroachDB Port. For example, 26257
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
table.name.prefixstringrequiredSchema for the associated table name
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
tasks.maxintegerThe maximum number of active tasks. NOTE: Increasing this value may increase parallelism and throughput but can also lead to higher costs on databricks side.
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.modestringUpsert or append modes are available
[object Object][object Object]databricks.tokenstring<password>requiredToken
connection.url.user.definedstringrequiredJDBC URL
connection.timeout.user.definedintegerConnection Timeout
databricks.catalog.user.definedstringThe name of the Databricks catalog to use.
partition.modestringPartition tables or not
by_topicby_partitionby_topic_and_partitionschema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]table.name.prefixstringSchema for the associated table name
hard.deletestringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
consumer.wait.time.for.larger.batch.msstringControls 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.
[object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object]topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredDb2 Hostname
database.port.user.definedstringrequiredDb2 Port. For example, 50000
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.namestringrequiredThe GCS Bucket to use.
format.user.definedstringThe format to use when writing data to the store.
CSVJSON LinesJSON ArrayParquetfile.name.templatestringThe format of the filename. See documentation for more information about formatting options.
file.name.prefixstringPrefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).
file.compression.typestringCompression type for files written to GCS.
nonegzipsnappyzstdformat.output.fields.user.definedstring[]A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.urlstringrequiredThe URL to send data to.
http.authorization.typestringThe HTTP authorization type.
nonestaticoauth2http.headers.authorizationstringStatic content of Authorization header (required for STATIC authorization).
oauth2.access.token.urlstringrequiredURL for fetching OAuth2 access token.
oauth2.client.idstringrequiredOAuth2 client id.
oauth2.client.secretstring<password>requiredOAuth2 client secret.
oauth2.scopestringrequiredOAuth2 client scope.
http.headers.content.typestringValue of Content-Type header for each request.
http.headers.additionalstringAdditional headers in header:value format, comma-separated.
http.proxy.hoststringProxy hostname.
http.proxy.portstringProxy port.
batching.enabledstringEnable batching multiple records in a single HTTP request.
batch.max.sizeintegerMaximum size of a record batch (1 to 1,000,000).
batch.buffering.enabledstringEnable buffering and only send records when batch.max.size reaches or batch.max.time.ms hits.
batch.max.time.msintegerMaximum time to wait before flushing a batch (1 to 1,000,000,000 ms).
batch.prefixstringPrefix for record batches.
batch.suffixstringSuffix for record batches.
batch.separatorstringSeparator for records in a batch.
max.retriesintegerMaximum number of retries on errors.
retry.backoff.msintegerTime in ms to wait before retrying.
http.timeoutintegerHTTP response timeout in seconds.
decimal.formatstringFormat for serializing decimals: BASE64 (default) or NUMERIC.
BASE64NUMERICerrors.tolerance.user.definedstringError tolerance setting. Note: Cannot be used when Batching is enabled.
noneallconsumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.typestringType of Iceberg catalog
[object Object][object Object][object Object]iceberg.catalog.auth.modestringHow 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).
[object Object][object Object][object Object]iceberg.catalog.namestringIceberg catalog name
iceberg.catalog.client.assume-role.arnstringAWS IAM role (e.g., arn:aws:iam::<your-account>:role/<role-name>)
iceberg.catalog.uristringCatalog endpoint URL. For REST catalogs use https://… ; for Hive Metastore use thrift://… ; AWS Glue uses the regional endpoint.
iceberg.catalog.tokenstring<password>requiredBearer token used for catalog authentication.
iceberg.catalog.credentialstring<password>requiredOAuth2 client credential in client_id:client_secret format.
iceberg.catalog.scopestringrequiredOAuth2 scope for catalog authentication (e.g., PRINCIPAL_ROLE:ALL).
iceberg.catalog.oauth2-server-uristringOAuth2 token endpoint URI. Required when the REST catalog endpoint is not also the OAuth2 authorization server.
iceberg.catalog.audiencestringOptional OAuth2 audience parameter to request from the token endpoint.
iceberg.catalog.resourcestringOptional OAuth2 resource parameter to request from the token endpoint.
iceberg.catalog.s3.credentials.enabledbooleanEnable to provide your own S3 access key and secret. Disable if the catalog vends storage credentials automatically.
iceberg.catalog.s3.access-key-idstringrequiredThe access key ID used to connect to S3 or S3-compatible storage.
iceberg.catalog.s3.secret-access-keystring<password>requiredThe secret access key used to connect to S3 or S3-compatible storage.
iceberg.catalog.client.region.user.definedstringThe AWS region to be used. For Cloudflare R2, select 'auto'.
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-2autoiceberg.catalog.warehousestringrequiredThe 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.prefixstringrequiredName of the database schema that contains the table (e.g., public, sales, analytics).
insert.mode.user.definedstringSpecifies the strategy used to insert events into the database
[object Object][object Object]iceberg.tables.default-id-columnsstringOptional. 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-enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)
iceberg.tables.compaction.enabledstringEnable lightweight compaction of small data files after commits
iceberg.tables.compaction.target-file-size-bytesstringTarget file size in bytes for compaction. Files smaller than this are candidates for merging
iceberg.tables.compaction.min-small-filesstringMinimum number of small files required before triggering compaction
iceberg.tables.compaction.max-files-per-runstringMaximum number of small files to compact in a single run
iceberg.tables.compaction.commit-thresholdstringNumber of Iceberg commits between compaction checks
iceberg.tables.compaction.expire-snapshotsstringExpire old snapshots and delete unreferenced data files after compaction
iceberg.tables.compaction.retain-laststringNumber of most recent snapshots to retain when expiring snapshots after compaction
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerMaximum number of tasks for the connector
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.bootstrapstringrequiredA 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.formatstringThe format to use when writing data to kafka
avrojsonjson.schema.enablestringInclude schema in json message
schema.registry.url.user.definedstringrequiredDestination kafka schema registry url
topic.prefixstringPrefix for destination topics
topic.suffixstringSuffix for destination topics
transforms.InsertField.offset.fieldstringIf 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
transforms.changeTopicName.add.original.topicstringAdd 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.
offheaderfieldpasswordstring<password>requiredPassword for setting up the Kafka proxy
whitelist.ips.user.definedstringrequiredA comma-separated list of IPs/CIDRs
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.modestringUpsert or append modes are available
[object Object][object Object]motherduck.tokenstring<password>requiredMotherduck Token
motherduck.catalog.user.definedstringrequiredThe name of the Motherduck database/catalog to use.
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]table.name.prefixstringSchema for the associated table name
hard.deletestringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredMySQL Hostname
database.port.user.definedstringrequiredMySQL Port. For example, 3306
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredOracle Hostname
database.port.user.definedstringrequiredOracle Port. For example, 1521
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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>requiredAPI key for authenticating with Pinecone
pinecone.index.namestringrequiredName of the target Pinecone index
pinecone.proxy.hoststringProxy host for Pinecone connections
pinecone.proxy.portstringProxy port for Pinecone connections (required if Proxy Host is set)
collection.mappingstringMapping between Kafka topic and Pinecone namespace. Use ${topic} for dynamic topic name substitution
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created namespaces, set to NONE
[object Object][object Object]document.id.strategy.user.definedstringStrategy to generate document IDs. 'None' uses random UUIDs (append-only, no upsert/delete support)
NoneKafka IDField IDdocument.id.field.namestringField name containing the ID in Kafka record
vector.field.namestringrequiredField name containing the embedding vector
delete.enabledstringTreat null record values or __deleted=true as deletes. Requires Document ID Strategy to be set to 'Kafka ID' (not 'None')
batch.sizestringNumber of records per batch
retry.maxstringMaximum number of retry attempts for failed operations
retry.backoff.msstringBackoff time between retries in milliseconds
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredPostgreSQL Hostname
database.port.user.definedstringrequiredPostgreSQL Port. For example, 5432
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword 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>
ssh.hoststringrequiredHostname of your SSH server
ssh.portstringrequiredPort of your SSH server
ssh.userstringrequiredUser that allows Streamkap to connect to SSH server
table.name.prefixstringrequiredSchema for the associated table name
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
transforms.TopicRegexRouter1.regexstringRename 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.replacementstringThe 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>.
transforms.TopicRegexRouter2.regexstringOptional second rename rule, applied after the first. Use when a single regex is not enough. Leave empty to skip.
transforms.TopicRegexRouter2.replacementstringThe replacement value for the second rename rule. Use <code>$1</code>, <code>$2</code> etc. to reference capture groups.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap 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.displayedstringrequiredPublic key to add to SSH server
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredCloudflare R2 account ID. This is the account ID you see in the Cloudflare dashboard.
aws.access.key.idstringrequiredThe Access Key ID used to connect to R2.
aws.secret.access.keystring<password>requiredThe Secret Access Key used to connect to R2.
aws.s3.bucket.namestringrequiredThe R2 Bucket to use.
format.user.definedstringThe format to use when writing data to the store.
JSON LinesJSON ArrayParquetfile.name.templatestringThe format of the filename. See documentation for more information about formatting options.
file.name.prefixstringPrefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).
file.compression.typestringCompression type for files written to S3.
nonegzipsnappyzstdformat.output.fields.user.definedstring[]A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredRedis Hostname
redis.port.user.definedstringrequiredRedis Port. For example, 6379
redis.usernamestringrequiredUsername to access the Redis database
redis.passwordstring<password>requiredPassword to access the Redis database
ssl.enabledstringEnable TLS for network connections
redis.keystringrequiredRedis key to stream the data
redis.key.data.typestringData Type of Redis Key. At the moment, only Stream and List are supported
StreamListHashconsumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.domainstringrequiredDomain of the leader of the cluster
aws.redshift.portstringrequiredPort number for incoming connections to the leader
aws.redshift.databasestringrequiredName of the database on the cluster
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
primary.key.fieldsstringrequiredList of comma-separated primary key field names
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]table.name.prefixstringrequiredSchema for the associated table name
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.modestringrequiredHow 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).
Access KeysCross-Account Roleaws.access.key.idstringrequiredThe AWS Access Key ID used to connect to S3.
aws.secret.access.keystring<password>requiredThe AWS Secret Access Key used to connect to S3.
aws.sts.role.arnstringrequiredARN 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.idstringrequiredThe External ID configured in your role's trust-policy condition. Streamkap passes this value verbatim when assuming the role.
aws.s3.regionstringThe AWS region to be used
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-2aws.s3.bucket.namestringrequiredThe S3 Bucket to use.
format.user.definedstringThe format to use when writing data to the store.
JSON LinesJSON ArrayParquetfile.name.templatestringThe 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.
file.compression.typestringCompression type for files written to S3.
nonegzipsnappyzstdfile.max.recordsintegerMaximum 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).
aws.s3.part.size.bytesintegerSize 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).
format.output.envelopebooleanWhen 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.
format.output.fields.user.definedstring[]A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
tasks.maxintegerThe maximum number of active tasks
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.definedstringrequiredSQL Server Hostname
database.port.user.definedstringrequiredSQL Server Port. For example, 1433
database.database.user.definedstringrequiredDatabase name
connection.usernamestringrequiredUsername to access the database
connection.passwordstring<password>requiredPassword to access with the database
table.name.prefixstringrequiredSchema for the associated table name
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]insert.modestringSpecifies the strategy used to insert events into the database
insertupsertdelete.enabledstringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database
primary.key.mode.user.definedstringSpecifies how the connector resolves the primary key columns from the event
nonerecord_keyrecord_valueprimary.key.fieldsstringOptional. Either the name of the primary key column or a comma-separated list of fields to derive the primary key from.
topic2table.map.user.definedstringFalls back to Streamkap's default for tables where no match is found
transforms.changeTopicName.mappingstringMap source tables to specific destination tables. Input should be the format of source_table_name:destination_table_name separated by a new line
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.namestringrequiredThe 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.namestringrequiredUser login name for the Snowflake account.
snowflake.private.keystring<password>requiredThe 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.securedstringIf checked (default), provide your SSH key's passphrase, otherwise, uncheck for SSH keys without passphrase.
snowflake.private.key.passphrasestring<password>requiredThe passphrase is used to decrypt the private key.
sfwarehousestringThe name of the snowflake warehouse.
snowflake.database.namestringrequiredThe name of the database that contains the table to insert rows into.
snowflake.schema.namestringrequiredThe name of the schema that contains the table to insert rows into.
create.schema.autostringAutomatically generates a Snowflake schema if it does not already exist.
snowflake.role.namestringrequiredThe name of an existing role with necessary privileges (for Streamkap) assigned to the <Username>
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>
[object Object][object Object]hard.deletestringSpecifies whether the connector processes DELETE or tombstone events and removes the corresponding row from the database (applies to upsert only)
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]use.hybrid.tablesstringSpecifies whether the connector should create Hybrid Tables (applies to upsert only)
apply.dynamic.table.scriptstringSpecifies whether the connector should create Dynamic Tables & Cleanup Tasks (applies to append only)
create.sql.executestringThese template queries run for each table the first time a record is streamed for them.
sql.table.namestringCan be used as <code>{{dynamicTableName}}</code> in dynamic table creation SQL. It can use input JSON data for more complex mappings and logic.
create.sql.datastringUse <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.mappingstringMapping 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.mapstringDefine 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.
transforms.KeyToValue.fields.include.liststringComma-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.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.idstringrequiredThe AWS Access Key ID used to connect to Starburst.
aws.secret.access.keystring<password>requiredThe AWS Secret Access Key used to connect to Starburst.
aws.s3.regionstringThe AWS region to be used
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-2aws.s3.bucket.namestringrequiredThe Bucket to use.
format.user.definedstringThe format to use when writing data to the store.
CSVJSON LinesJSON ArrayParquetfile.name.templatestringThe format of the filename. See documentation for more information about formatting options.
file.name.prefixstringPrefix for the filename. Prefixes can be used to specify a directory for the file (e.g. dir1/dir2/).
file.compression.typestringCompression type for files written to Starburst.
nonegzipsnappyzstdformat.output.fields.user.definedstring[]A comma separated list of fields to include in output? Options to include key, offset, timestamp, value, headers.
consumer.override.max.poll.recordsintegerThe maximum number of records returned in a single call to poll()
preserve.null.valuesbooleanWhen 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.
quote.identifiersstringWhether to quote identifiers in SQL statements
transforms.ToIntJ.fields.include.liststringConvert column(s) to Integer - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToFloatJ.fields.include.liststringConvert column(s) to Float - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.fields.include.liststringConvert column(s) to Decimal - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToDecimalJ.truncate.to.max.precisionbooleanIf true, truncate decimals to a 38 precision
transforms.ToStringJ.fields.include.liststringConvert column(s) to String - if possible. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.ToJsonJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to JSON String? - if possible.
transforms.ToJsonbJ.fields.include.liststringConvert 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.definedbooleanConvert all Structs and Arrays to Binary JSON? - if possible.
transforms.ToJsonbJ.convert.all.jsonbooleanConverts all JSON String column(s) to Binary JSON - if possible.
transforms.StringReplace.fields.include.liststringReplaces column(s) value with a user-defined string. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.StringReplace.regex.patternsstringList of regex patterns to search for. Comma separated list in format 'regex1,regex2'
transforms.StringReplace.replacement.valuesstringList of replacement values for each regex pattern. Comma separated list in format 'regex1,regex2'
transforms.OversizedRecords.fields.include.liststringTruncate 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.liststringColumns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.
transforms.OversizedRecords.max.field.size.bytesintegerMaximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.
transforms.OversizedRecords.oversized.field.behaviorstringAction for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).
TRUNCATENULLIFYtransforms.OversizedRecords.truncation.suffixstringSuffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.
transforms.OversizedRecords.max.record.size.bytesintegerOptional 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.
transforms.OversizedRecords.semantic.types.excludestringColumn data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.
transforms.OversizedRecords.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.MaskField.fields.include.liststringMask (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.liststringColumns to exclude from masking. Comma separated list in format 'table1.column1,table2.column2'.
transforms.MaskField.mask.functionstringMasking algorithm. Hash functions are deterministic (same input -> same token) and length-preserving.
SHA256_TRUNCATEMD5_TRUNCATESHA256MD5REDACTFIXEDNULLIFYtransforms.MaskField.mask.saltstringSecret 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.
transforms.MaskField.mask.charstringFill character used by the REDACT function (length is preserved).
transforms.MaskField.mask.fixed.valuestringConstant replacement used by the FIXED function.
transforms.MaskField.replace.null.with.defaultbooleanWhether null fields should use schema default values. Set to false to preserve user-set NULLs from source.
transforms.AddStringSuffix.fields.include.liststringWarning: 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.definedstringRegular expression for matching topic name parts to use as the destination table (database) or file (file storage) name
transforms.RenameFields.renames.user.definedstringJSON 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.liststringDrop columns. Comma separated list of table columns to drop in format 'table1.column1,table2.column2'
transforms.MarkColumnsAsRequired.fields.include.allbooleanWhen enabled, converts ALL optional columns to required (NOT NULL). The exclude list is still respected. Enabling this automatically disables 'Mark Column(s) as Optional'.
transforms.MarkColumnsAsRequired.null.sentinel.modestringControls 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).
NONETYPE_MINtransforms.MarkColumnsAsOptional.fields.include.liststringMark columns as optional/nullable. Comma separated list of table columns in format 'table1.column1,table2.column2'
transforms.CopyField.copy.field.mappingstringComma-separated list of field mappings e.g. <code>field1:newField1,field2:newField2</code>.
transforms.HeaderToFieldCustom.header.mappingsstringHeaders 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.urlstringrequiredWeaviate connection URL
weaviate.grpc.urlstringrequiredWeaviate gRPC connection URL
weaviate.grpc.securedstringEnable TLS encryption for gRPC connection
weaviate.auth.schemestringAuthentication mechanism to use to connect to Weaviate
NONEAPI_KEYOIDC_CLIENT_CREDENTIALSweaviate.api.keystring<password>requiredUser API Key for API Key authentication
weaviate.oidc.client.secretstring<password>requiredUser OIDC client secret for OIDC authentication
weaviate.oidc.scopesstringOIDC client scopes (comma-separated)
weaviate.headersstringCustom headers to provide (format: key=value, one per line). Example: X-OpenAI-Api-Key=your-key
collection.mappingstringMapping between Kafka topic and Weaviate collection. Use ${topic} for dynamic topic name substitution
schema.evolutionstringControls how schema evolution is handled by the sink connector. For pipelines with pre-created destination tables, set to NONE
[object Object][object Object]document.id.strategy.user.definedstringStrategy to generate document IDs
NoneKafka IDField IDdocument.id.field.namestringField name containing the ID in Kafka record
vector.strategy.user.definedstringStrategy to generate or extract document embeddings
NoneField Vectorvector.field.namestringField name containing the embedding vector
weaviate.vectorizerstringSets the default Weaviate vectorizer to use for objects without explicit vector data. Applies to new collections only.
nonetext2vec-weaviatetext2vec-coheretext2vec-jinaaitext2vec-openaitext2vec-voyageaidelete.enabledstringTreat null record values as deletes. Requires Document ID Strategy to be set to either 'Kafka ID' or 'Field ID' (not 'None')
batch.sizestringNumber of records per batch
pool.sizestringNumber of thread pools to process batches
await.termination.msstringTimeout for batch processing in milliseconds
max.connection.retriesstringMaximum number of retries for connection issues
max.timeout.retriesstringMaximum number of retries for timeout issues
retry.intervalstringInterval between retries in milliseconds
retry.backoff.msstringBackoff time between retries in milliseconds
consistency.levelstringConsistency level for writes (ALL, ONE, QUORUM)
ALLONEQUORUManytopic_idsstring | integer[] | anyList of associated topic identifiers
Show propertiesHide properties
string | integerstringintegeranytopic_mapobject | anyMapping of topics to their partitions or related entities
Show propertiesHide properties
objectanytopicsstring | integer[] | anyList of topic names
Show propertiesHide properties
string | integerstringintegeranytasksinteger[] | anyList of task identifiers
Show propertiesHide properties
integerintegeranyconnector_statusstring | anyCurrent status: Active, Paused, Stopped, Broken, Starting, Unassigned, Unknown, Pending
Show propertiesHide properties
stringanydesired_statestring | anyDesired state: Pending, Active, Paused, Stopped
Show propertiesHide properties
stringanykc_cluster_idstring | anyKC cluster this connector is deployed to. None means default cluster.
Show propertiesHide properties
stringanytask_statusesobject | anyStatus information for each connector task
Show propertiesHide properties
objectanytagsstring[] | anyList of tag IDs assigned to this destination
Show propertiesHide properties
stringstringanyValidation Error
detailValidationError[]Show propertiesHide properties
ValidationErrorlocstring | integer[]requiredShow propertiesHide properties
string | integerstringintegermsgstringrequiredtypestringrequiredinputanyctxobject