How to Query CouchDB Data in MySQL Workbench

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

Connect to CouchDB 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:

• Url: The Url of your instance. For example: http://localhost:5984
• User The Apache CouchDB user account used to authenticate.
• Password The Apache CouchDB password associated with the authenticating user.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to CouchDB 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 CouchDB from MySQL Workbench

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

Connect to CouchDB through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for CouchDB).
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.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query CouchDB Data

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

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