Connect to SingleStore Data in DBVisualizer

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SingleStore JDBC Driver

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



Integrate SingleStore data with visual data analysis tools and data connection wizards in DBVisualizer

The CData JDBC Driver for SingleStore implements JDBC standards to provide connectivity to SingleStore data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to SingleStore data in DBVisualizer and use the table editor to edit and save SingleStore data.

Create a New JDBC Data Source for SingleStore Data

Follow the steps below to use the Driver Manager to provide connectivity to SingleStore data from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
  2. Enter a name for the data source.
  3. Enter the following in the URL Format box: jdbc:singlestore:
    The DBVisualizer Driver Manager.
  4. In the User Specified tab, click the Open File button and select the cdata.jdbc.singlestore.jar file, located in the lib subfolder of the installation directory.
  5. In the Driver Class menu, select the SingleStoreDriver class, cdata.jdbc.singlestore.SingleStoreDriver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

  1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.
  2. In the Connection section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:singlestore: followed by the connection properties in a semicolon-separated list of name-value pairs.

      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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;
    • Database UserId: The username to use to authenticate to SingleStore.
    • Database Password: The password to use to authenticate to SingleStore.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the SingleStore JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.