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 as an External Source in Dremio



Use the CData JDBC Driver to connect to SingleStore as an External Source in Dremio.

The CData JDBC Driver for SingleStore implements JDBC Standards and allows various applications, including Dremio, to work with live SingleStore data. Dremio is a data lakehouse platform designed to empower self-service, interactive analytics on the data lake. With the CData JDBC Driver, you can include live SingleStore data as a part of your enterprise data lake. This article describes how to connect to SingleStore data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live SingleStore data in Dremio. Once you install the driver, authenticate with SingleStore and gain immediate access to SingleStore data within your data lake. By surfacing SingleStore data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to SingleStore data.

Build the ARP Connector

To use the CData JDBC Driver in Dremio, you need to build an Advanced Relation Pushdown (ARP) Connector. You can view the source code for the Connector on GitHub or download the ZIP file (GitHub.com) directly. Once you copy or extract the files, run the following command from the root directory of the connector (the directory containing the pom.xml file) to build the connector.

mvn clean install

Once the JAR file for the connector is built (in the target directory), you are ready to copy the ARP connector and JDBC Driver to your Dremio instance.

Installing the Connector and JDBC Driver

Install the ARP Connector to %DREMIO_HOME%/jars/ and the JDBC Driver for SingleStore to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-singlestore-plugin-20.0.0.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for SingleStore

docker cp PATH\TO\cdata.jdbc.singlestore.jar dremio_image_name:/opt/dremio/jars/3rdparty/

Connecting to SingleStore

SingleStore will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to SingleStore data. The JDBC Driver has a built-in connection string designer that you can use (see below).

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the SingleStore JDBC Driver. 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.

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.

NOTE: To use the JDBC Driver in Dremio, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Add the Runtime Key (RTK) to the JDBC URL. You will end up with a JDBC URL similar to the following:

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

Access SingleStore as an External Source

To add SingleStore as an External Source, click to add a new source and select SingleStore. Copy the JDBC URL and paste it into the New SingleStore Source wizard.

Save the connection and you are ready to query live SingleStore data in Dremio, easily incorporating SingleStore data into your data lake.

More Information & Free Trial

Using the CData JDBC Driver for SingleStore in Dremio, you can incorporate live SingleStore data into your data lake. Check out our CData JDBC Driver for SingleStore page for more information about connecting to SingleStore. Download a free, 30 day trial of the CData JDBC Driver for SingleStore and get started today.