Query CockroachDB Data in MySQL Workbench

Ready to get started?

Download for a free trial:

Download Now

Learn more:

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.

Execute MySQL queries against live CockroachDB data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for CockroachDB to query CockroachDB data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live CockroachDB data in MySQL Workbench.

Connect to CockroachDB Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. 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.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to CockroachDB data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query CockroachDB from MySQL Workbench

The steps below outline connecting to the virtual CockroachDB database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live CockroachDB data.

Connect to CockroachDB through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for CockroachDB).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query CockroachDB Data

  1. Open the connection you just created (CData SQL Gateway for CockroachDB).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve CockroachDB data, like SELECT * FROM `CData CockroachDB Sys`.Orders;

With access to live CockroachDB data from MySQL Workbench, you can easily query and update CockroachDB, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for CockroachDB and the CData SQL Gateway.