Connect to SingleStore Data in Aqua Data Studio

The CData JDBC Driver for SingleStore integrates SingleStore data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to SingleStore data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The SingleStore data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, SingleStore.
   • Driver Location: Click the Browse button and select the cdata.jdbc.singlestore.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.singlestore.SingleStoreDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:singlestore: and is followed by a semicolon-separated list of 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

     jdbc:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query SingleStore Data

You can now query the tables exposed.