Connect with Confluent Cloud

This tutorial shows how to connect to your SingleStore databases from Confluent Cloud using the SingleStore Debezium connector.

For related information, refer to Custom Connector for Confluent Cloud.

Prerequisites

  • Access to a Confluent Cloud cluster.

  • An active SingleStore deployment with OBSERVE (CDC) queries enabled. Refer to Enable CDC for more information. Run the following command to enable CDC:

    SET GLOBAL enable_observe_queries = 1;

Connect Confluent Cloud to SingleStore

To connect to your SingleStore databases from Confluent Cloud using the SingleStore Debezium connector,

  1. Launch a Confluent Cloud cluster. Refer to the Quick Start for Confluent Cloud for installation instructions.

  2. Download the SingleStore Debezium Connector .zip archive from GitHub.

  3. On Confluent Cloud, select Connectors > Add plugin.

  4. On the Add Custom Connector Plugin dialog, select or enter the following information:

    1. In the Connector plugin name box, enter SingleStore Debezium.

    2. In the Connector class box, enter com.singlestore.debezium.SingleStoreConnector.

    3. Under Connector type, select Source.

    4. Under Connector archive, upload the SingleStore Debezium connector archive.

    5. Under Sensitive properties, add the following properties to ensure that the passwords are masked in connector configuration:

      1. database.password

      2. database.ssl.keystore.password

      3. database.ssl.truststore.password

  5. Select Submit. The SingleStore Debezium connector is now available under Connector Plugins.

  6. On the Connector Plugins page, select the SingleStore Debezium plugin.

  7. On the Add SingleStore Debezium connector dialog, enter or select the following:

    1. Under Kafka cluster credentials, select one of the following:

      1. My account: Allows the connector to globally access everything that the user's account can access. With a user account, the connector uses an API key and secret to access the Kafka cluster. SingleStore does not recommend this option for production environments.

      2. Service account: Provides limited access to the connector by using a service account. SingleStore recommends this option for production environments.

      3. Use an existing API key: Allows access to the Kafka cluster via an API key and secret. SingleStore does not recommend this option for production environments.

    2. Select Continue.

    3. Under Configuration, enter the following connection configuration details in key-value pairs:

      Key

      Value

      database.hostname

      IP address or hostname of the SingleStore deployment.

      database.port

      Port of the SingleStore deployment.

      database.user

      Name of the SingleStore database user with which to access the database.

      database.password

      Password for the SingleStore database user.

      database.dbname

      Name of the SingleStore database to connect with.

      database.table

      Name of the SingleStore table from which the connector captures changes.

      topic.prefix

      Prefix for the Kafka topic.

      Refer to SingleStore Debezium Connector Properties for more information.

  8. Configure other connector configuration details as required.

  9. Provision the connector. Once the connector completes provisioning, its status changes to Running. The connector starts streaming changes to the table into the Kafka topic. The Kafka topic name is in the <topic.prefix>.<database.dbname>.<database.table> format.

  10. Select <your_Kafka_cluster> > Topics > <your_topic> > Messages to view the change events for the table.

Last modified: March 31, 2025

Was this article helpful?

Verification instructions

Note: You must install cosign to verify the authenticity of the SingleStore file.

Use the following steps to verify the authenticity of singlestoredb-server, singlestoredb-toolbox, singlestoredb-studio, and singlestore-client SingleStore files that have been downloaded.

You may perform the following steps on any computer that can run cosign, such as the main deployment host of the cluster.

  1. (Optional) Run the following command to view the associated signature files.

    curl undefined
  2. Download the signature file from the SingleStore release server.

    • Option 1: Click the Download Signature button next to the SingleStore file.

    • Option 2: Copy and paste the following URL into the address bar of your browser and save the signature file.

    • Option 3: Run the following command to download the signature file.

      curl -O undefined
  3. After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

    echo -n undefined |
    cosign verify-blob --certificate-oidc-issuer https://oidc.eks.us-east-1.amazonaws.com/id/CCDCDBA1379A5596AB5B2E46DCA385BC \
    --certificate-identity https://kubernetes.io/namespaces/freya-production/serviceaccounts/job-worker \
    --bundle undefined \
    --new-bundle-format -
    Verified OK