Query CouchDB Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for CouchDB, DataGrip can work with live CouchDB data. This article shows how to establish a connection to CouchDB data in DataGrip and use the table editor to load CouchDB data.

Create a New Driver Definition for CouchDB

The steps below describe how to create a new Data Source in DataGrip for CouchDB.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData CouchDB Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.apachecouchdb.jar).
   • Set Class to cdata.jdbc.apachecouchdb.ApacheCouchDB.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to CouchDB

1. Once the connection is saved, click the plus (), then "Data Source" then "CData CouchDB Driver" to create a new CouchDB Data Source.
2. In the new window, configure the connection to CouchDB with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the CouchDB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.apachecouchdb.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   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.
3. Set URL to the connection string, e.g., jdbc:apachecouchdb:Url=http://localhost:5984;User=abc123;Password=abcdef;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against CouchDB

To browse through the CouchDB entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT MovieRuntime, MovieRating FROM Movies WHERE MovieRating = 'R'

Download a free, 30-day trial of the CData JDBC Driver for CouchDB and start working with your live CouchDB data in DataGrip. Reach out to our Support Team if you have any questions.