# SingleStore Kafka Sink Connector Properties The SingleStore Kafka Sink Connector ("the connector") supports the following configuration properties: | **Property** | **Default Value** | **Description** | | ---------------------------------------------------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `connection.ddlEndpoint` | | The hostname or IP address of the Master Aggregator in theSingleStoredeployment in the`host[:port]`format, where`port`is an optional parameter.For example:`master-agg.abc.internal:3308`or`master-agg.abc.internal`. | | `connection.dmlEndpoints` | The value of`connection.ddlEndpoint`. | The hostname or IP address of the aggregator nodes in theSingleStoredeployment on which the queries are run. The endpoint is specified in the`host[:port],host[:port],...`format, where`port`is an optional parameter and multiple hosts are separated by a comma.For example:`child-agg:3308`,`child-agg2`. | | `connection.database` | | Specifies the default database to connect with. If set, all connections use the specified database by default. | | `connection.user` | `root` | The username of theSingleStoredatabase user to connect with. | | `connection.password` | An empty string. | The password for theSingleStoredatabase user. | | `params.` | | Specifies a[JDBC parameter](https://docs.singlestore.com/db/v9.1/developer-resources/connect-with-application-development-tools/connect-with-java-jdbc/the-singlestore-jdbc-driver/#section-idm4492642533297632740896869469.md). This parameter is injected into the connection URI. | | `max.retries` | `10` | Specifies the maximum number of times to retry on errors before failing a task. | | `fields.whitelist` | By default, all fields are inserted. | Specifies a comma-separated list of fields to be inserted in the table. Refer to[Data Mapping](https://docs.singlestore.com/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/data-mapping.md)for more information. | | `retry.backoff.ms` | `3000` | Specifies the time (in milliseconds) to wait following an error before making a retry attempt. | | `tableKey.[.name]` | | Specifies additional keys to add to tables created by the connector as a comma-separated list, where,Refer to[Table Keys](https://docs.singlestore.com/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/how-the-singlestore-kafka-sink-connector-works/#section-idm235064278366122.md)for more information. | | `singlestore.loadDataCompression` | `GZip` | Compresses data on load. It can have the following values:`GZip`,`LZ4`, or`Skip`. | | `singlestore.metadata.allow` | `true` | Enables the use of an additional metadata table to save Kafka transaction metadata. Refer to[Exactly-Once Delivery](https://docs.singlestore.com/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/how-the-singlestore-kafka-sink-connector-works/#section-idm235065099958771.md)for more information. | | `singlestore.metadata.table` | `kafka_connect_transaction_metadata` | Specifies the name of the table where the Kafka transaction metadata is saved. Refer to[Exactly-Once Delivery](https://docs.singlestore.com/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/how-the-singlestore-kafka-sink-connector-works/#section-idm235065099958771.md)for more information. | | `singlestore.tableName.` | | Specifies an explicit table name to use for the specified topic. Refer to[Data Mapping](https://docs.singlestore.com/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/data-mapping.md)for more information. | | `singlestore.filter` | | Specifies a SQL expression to filter incoming data. This parameter is inserted directly into the query's`WHERE`clause.SingleStoredoes not recommend using this property because it is vulnerable to SQL-injection attacks. | | `singlestore.columnToField..` | | Specifies a mapping betweenSingleStoretable column names and the Kafka record fields. Nested fields are specified as a sequence of field names separated by`.`.For example, for a record with the value`{"a": {"b": 1}, "c": "d"}`, the mapping for the field`b`is`a.b`.Refer to[Data Mapping](https://docs.singlestore.com/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/data-mapping.md)for more information. | | `singlestore.recordToTable.mappingField` | | Specifies the Kafka record field that defines theSingleStoretable where the Kafka records are written. This property is used with`singlestore.recordToTable.mapping.`.Refer to[Data Mapping](https://docs.singlestore.com/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/data-mapping.md)for more information. | | `singlestore.recordToTable.mapping.` | | Specifies a mapping between the Kafka record and theSingleStoretable name. This property is used with`singlestore.recordToTable.mappingField`.Refer to[Data Mapping](https://docs.singlestore.com/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/data-mapping.md)for more information. | | `singlestore.upsert` | `false` | If enabled, updates a row in case of a duplicate key. | *** Modified at: August 5, 2025 Source: [/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/singlestore-kafka-sink-connector-properties/](https://docs.singlestore.com/db/v9.1/load-data/integrate-with-singlestore/singlestore-kafka-sink-connector/singlestore-kafka-sink-connector-properties/) (An index of the documentation is available at /llms.txt)