Learn more
 

Ready to get started?

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

 Download Now

Learn more:

CockroachDB Icon CockroachDB ODBC Driver

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

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

In this article

Related articles

Use the CData ODBC Driver for CockroachDB in MicroStrategy Desktop


Connect to CockroachDB data in MicroStrategy Desktop using the CData ODBC Driver for CockroachDB.

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When paired with the CData ODBC Driver for CockroachDB, you gain database-like access to live CockroachDB data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through adding CockroachDB as a data source in MicroStrategy Desktop and creating a simple visualization of CockroachDB data.

The CData ODBC Driver offers unmatched performance for interacting with live CockroachDB data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to CockroachDB, the driver pushes supported SQL operations, like filters and aggregations, directly to CockroachDB and utilizes the embedded SQL Engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze CockroachDB data using native MicroStrategy data types.

Connect to CockroachDB as an ODBC Data Source

Information for connecting to CockroachDB follows, along with different instructions for configuring a DSN in Windows and Linux environments.

Set the following to connect to CockroachDB.

  • Server: The host name or IP address of the server.
  • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
  • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
  • User: The Cockroach DB user account used to authenticate.
  • Password: The password used to authenticate the user.

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 have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Linux

If you are installing the CData ODBC Driver for CockroachDB 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 CockroachDB Sys] Driver = CData ODBC Driver for CockroachDB Description = My Description User = root Password = root Database = system Server = localhost Port = 26257

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

Connect to and Visualize CockroachDB Data using MicroStrategy Desktop

In addition to connecting CockroachDB in MicroStrategy enterprise products, you can connect to CockroachDB in MicroStrategy Desktop. Follow the steps below to add CockroachDB data as a dataset and create visualizations and reports of CockroachDB data.

  1. Open MicroStrategy Desktop and create a new dossier.
  2. In the datasets panel, click New Data, select Databases, and select Type a Query as the Import Option.
  3. Add a new data source and choose DSN data sources.
  4. Choose the DSN you previously configured (likely CData CockroachDB Sys) and select Generic DBMS in the Version menu.
  5. Set the User and Password properties for the DSN (or use placeholder values) and name the data source.
  6. Select the new database instance to view the tables. You may need to manually click the search icon in the Available Tables section to see the tables.
  7. Create a SQL query for the CockroachDB data (see below) and click Execute SQL to test the query. SELECT * FROM Orders NOTE: Since we create a live connection, we can execute a SELECT * query and utilize the filtering and aggregation features native to the MicroStrategy products.
  8. Click Finish and choose to connect live.
  9. Choose a visualization, choose fields to display (data types are discovered automatically through dynamic metadata discovery) and apply any filters to create a new visualization of CockroachDB data. Where possible, the complex queries generated by the filters and aggregations will be pushed down to CockroachDB, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL Engine embedded in the driver.
  10. Once you are finished configuring the dossier, click File -> Save.

Using the CData ODBC Driver for CockroachDB in MicroStrategy Desktop, you can easily create robust visualizations and reports on CockroachDB data. Read our other articles on connecting to CockroachDB in MicroStrategy and connecting to CockroachDB in MicroStrategy Web for more examples.