Ready to get started?

Download a free trial of the SingleStore ODBC Driver to get started:

 Download Now

Learn more:

SingleStore Icon SingleStore ODBC Driver

The SingleStore ODBC Driver is a powerful tool that allows you to connect with live data from SingleStore, directly from any applications that support ODBC connectivity.

Access SingleStore data like you would a database - read, write, and update SingleStore. through a standard ODBC Driver interface.

Build Dashboards with SingleStore Data in Dundas BI



Create dynamic dashboards and perform analytics based on SingleStore data in Dundas BI.

The CData ODBC Driver for SingleStore enables access to live data from SingleStore under the ODBC standard, allowing you work with SingleStore data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to SingleStore data as a generic ODBC Data Provider and create charts, reports, and dashboards based on SingleStore data in Dundas BI.

Connect to SingleStore Data

  1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

    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.

    When you configure the DSN, 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.

  2. Open the Dundas BI interface, open the menu, and click New Data Connector.
  3. Configure the Dundas BI Data Connector:
    • Name the Data Connector.
    • Select "ODBC generic" as the Data Provider.
    • Check the "Use System DSN" checkbox.
    • Select the appropriate System DSN.

Add SingleStore Data to a Dashboard

You are now ready to create a dashboard with SingleStore data.

  1. Navigate to the Home page.
  2. Click Explore Data.
  3. Expand the appropriate Data Connector.
  4. Drag the relevant data from the Connector to the panel.
    • You can select an entire "table" to add, but you may need to remove Measures/Rows from the Metric Set to build an appropriate visualization. Alternatively, you can select only the fields you wish to include in the visualization.
    • With the fields selected, you can add any filters or conditions on the Measures and Rows, further customizing the visualization.
  5. Click Re-visualize from the menu bar and select the appropriate visualization for the data.
  6. Click Add To New Dashboard to add the visualization to a new dashboard.
  7. Configure the dashboard, creating dynamic visualizations of SingleStore data.