Skip to main content

JDBC sink connector

The JDBC sink connector pulls messages from Pulsar topics and persists the messages to MySQL or SQlite.

Currently, INSERT, DELETE and UPDATE operations are supported.

Configuration

The configuration of the JDBC sink connector has the following properties.

Property

NameTypeRequiredDefaultDescription
userNameStringfalse" " (empty string)The username used to connect to the database specified by jdbcUrl.

Note: userName is case-sensitive.
passwordStringfalse" " (empty string)The password used to connect to the database specified by jdbcUrl.

Note: password is case-sensitive.
jdbcUrlStringtrue" " (empty string)The JDBC URL of the database to which the connector connects.
tableNameStringtrue" " (empty string)The name of the table to which the connector writes.
nonKeyStringfalse" " (empty string)A comma-separated list contains the fields used in updating events.
keyStringfalse" " (empty string)A comma-separated list contains the fields used in where condition of updating and deleting events.
timeoutMsintfalse500The JDBC operation timeout in milliseconds.
batchSizeintfalse200The batch size of updates made to the database.

Example

Before using the JDBC sink connector, you need to create a configuration file through one of the following methods.

  • JSON


    {
    "userName": "root",
    "password": "jdbc",
    "jdbcUrl": "jdbc:mysql://127.0.0.1:3306/pulsar_mysql_jdbc_sink",
    "tableName": "pulsar_mysql_jdbc_sink"
    }

  • YAML


    configs:
    userName: "root"
    password: "jdbc"
    jdbcUrl: "jdbc:mysql://127.0.0.1:3306/pulsar_mysql_jdbc_sink"
    tableName: "pulsar_mysql_jdbc_sink"

Usage

For more information about how to use a JDBC sink connector, see connect Pulsar to MySQL.