Learn more
 

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.

In this article

Related articles

How to publish and share SingleStore Data dashboards with Tableau Server


The CData ODBC driver for SingleStore enables you integrate SingleStore data into Tableau dashboards.

Integrate connectivity to SingleStore data into your enterprise reporting capabilities. The CData ODBC Driver for SingleStore enables you to access live SingleStore data in business intelligence tools like Tableau Server. Connectivity to SingleStore APIs enables you to monitor changes to your data in real time. Other members of your organization can access your dashboards from a Web browser and get updates from their mobile phone.

This article walks through the process of configuring a DSN on the client and server machines, publishing a data source for SingleStore to Tableau Server, and publishing an entire Workbook to Tableau Server (including the data source). If you publish a data source, you will be able to create new, refreshable workbooks in Tableau Server.

Connect to SingleStore as an ODBC Data Source

To create a data source or workbook in Tableau Desktop and publish the data source or workbook to Tableau server, you will need to configure a DSN on each machine (Desktop and Server), specifying connection properties and creating DSNs using the same name on each machine. Information for connecting to SingleStore follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

Windows

If you are installing the CData ODBC Driver for SingleStore on Windows, DSN configuration is the last step of the driver installation. If you already have the driver installed, or you wish to configure new DSNs, you can use the Microsoft ODBC Data Source Administrator.

Linux

If you are installing the CData ODBC Driver for SingleStore in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData SingleStore Source] Driver = CData ODBC Driver for SingleStore Description = My Description User = myUser Password = myPassword Database = NorthWind Server = myServer Port = 3306

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Publish the SingleStore Data Source to Tableau Server

With the connections to SingleStore data configured, you are ready to publish a SingleStore data source on Tableau, ready to be leveraged by users in your organization to create workbooks based on SingleStore data.

Create and Publish a Data Source

  1. In the Connect pane, click More -> Other Databases (ODBC). Select CData SingleStore Sys, the system DSN.

    The driver installation automatically creates matching user and system DSNs: The system DSN is needed to connect from Tableau Server.

  2. In the Database menu, select CData.
  3. In the Table box, enter a table name or click New Custom SQL to enter an SQL query.
  4. Drag the table onto the join area.
  5. From the Server menu, click Publish Data Source -> (YOUR DATA SOURCE).
  6. Enter the URL to the server. For most instances, you will authenticate with the Tableau Server username and password. Other authentication scenarios can be found below:
    • If Tableau is configured to use Kerberos and your computer has valid Active Directory credentials, Tableau connects to the server.
    • If Tableau is configured to use SAML, a login prompt for your external identity provider is displayed.
    • If Tableau is configured to use Active Directory, enter your Windows username and password.
  7. In the resulting dialog, set the Project, Data Source, and other properties. If you want to schedule refreshes, select Embedded Password in the Authentication menu. Click Publish.

You and other users in your organization can now create and share workbooks based on the published data source.

Refresh Workbooks

With a system DSN configured on the client (Tableau Desktop) machine and server (Tableau Server) machine, you can refresh workbooks connected to the SingleStore data source. From the Web interface for Tableau Sever, click Data -> (YOUR DATA SOURCE) -> Refresh.

Publish a Completed Workbook with SingleStore Data to Tableau Server

If you have a specific Workbook that you wish to share with your organization, you can create the Workbook on Tableau Desktop and publish the Workbook directly to Tableau Server.

  1. To connect to SingleStore and select data, follow steps 1-5 above.
  2. Click Server -> Sign in and configure the connection to the server. For most instances, you will authenticate with the Tableau Server username and password. Other authentication scenarios can be found below:
    • If Tableau is configured to use Kerberos and your computer has valid Active Directory credentials, Tableau connects to the server.
    • If Tableau is configured to use SAML, a login prompt for your external identity provider is displayed.
    • If Tableau is configured to use Active Directory, enter your Windows username and password.
  3. With the data selected, select dimensions and measures to visualize and select a type of chart or graph to build your visualization(s).
  4. Once the Workbook is complete, click Server -> Publish Workbook to publish the Workbook to Tableau Server.
  5. In the resulting dialog, set the Project, Name, Description and other properties. If you want to schedule refreshes, click Edit under Data Sources and change the Authentication option to Embedded Password. Click Publish.

You and other users in your organization can now review the published workbook from Tableau Server.