Ready to get started?

Download a free trial of the SingleStore Driver to get started:

 Download Now

Learn more:

SingleStore Icon SingleStore JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SingleStore.

Connect to SingleStore Data in DBeaver



Manage SingleStore data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for SingleStore implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to SingleStore data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for SingleStore Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
  2. In the Settings tab:
    • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for SingleStore).
    • Set Class Name to the class name for the JDBC driver: cdata.jdbc.singlestore.SingleStoreDriver.
    • Set URL Template to jdbc:singlestore:.
  3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData\CData JDBC Driver for SingleStore XXXX\) and select the JAR file (cdata.jdbc.SingleStore.jar).

Create a Connection to SingleStore Data

Follow the steps below to add credentials and other required connection properties.

  1. In the "Database" menu, click "New Database Connection."
  2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for SingleStore) and click "Next >."
  3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

    The following connection properties are required in order to connect to data.

    • Server: The host name or IP of the server hosting the SingleStore database.
    • Port: The port of the server hosting the SingleStore database.
    • Database (Optional): The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.

    Connect Using Standard Authentication

    To authenticate using standard authentication, set the following:

    • User: The user which will be used to authenticate with the SingleStore server.
    • Password: The password which will be used to authenticate with the SingleStore server.

    Connect Using Integrated Security

    As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.

    Connect Using SSL Authentication

    You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:

    • SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
    • SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
    • SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
    • SSLClientCertType: The certificate type of the client store.
    • SSLServerCert: The certificate to be accepted from the server.

    Connect Using SSH Authentication

    Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:

    • SSHClientCert: Set this to the name of the certificate store for the client certificate.
    • SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
    • SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
    • SSHClientCertType: The certificate type of the client store.
    • SSHPassword: The password that you use to authenticate with the SSH server.
    • SSHPort: The port used for SSH operations.
    • SSHServer: The SSH authentication server you are trying to authenticate against.
    • SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
    • SSHUser: Set this to the username that you use to authenticate with the SSH server.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the SingleStore JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.singlestore.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    Below is a typical connection string:

    jdbc:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;
  4. Click "Test Connection ..." to ensure you have configured the connection properly.
  5. Click "Finish."

Query SingleStore Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for SingleStore and start working with your live SingleStore data in DBeaver. Join the CData Community or reach out to our Support Team if you have any questions.