Manage SingleStore Data in DBArtisan as a JDBC Source

The CData JDBC Driver for SingleStore seamlessly integrates SingleStore data into database management tools like DBArtisan by enabling you to access SingleStore data as a database. This article shows how to create a JDBC source for SingleStore in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate SingleStore Data into DBArtisan Projects

Follow the steps below to register SingleStore data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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;
6. Finish the wizard to connect to SingleStore data. SingleStore entities are displayed in the Datasource Explorer.

You can now work with SingleStore data as you work with any other database. See the driver help documentation for more information on the queries supported by the SingleStore API.