How to connect to SingleStore Data from IntelliJ

The CData JDBC Driver for SingleStore enables you to access SingleStore as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to SingleStore data in IntelliJ.

Create a JBDC Data Source for SingleStore

Follow the steps below to add the driver JAR and define connection properties required to connect to SingleStore data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.singlestore.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.singlestore.SingleStoreDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:singlestore: and includes connection properties separated with semicolons.

     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.

     A typical JDBC URL is the following:

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

Edit and Save SingleStore Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.