How to connect to CouchDB Data from IntelliJ

The CData JDBC Driver for CouchDB enables you to access CouchDB as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to CouchDB data in IntelliJ.

Create a JBDC Data Source for CouchDB

Follow the steps below to add the driver JAR and define connection properties required to connect to CouchDB data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.apachecouchdb.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.apachecouchdb.ApacheCouchDBDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:apachecouchdb: and includes connection properties separated with semicolons.

     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.

     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.

     A typical JDBC URL is the following:

     jdbc:apachecouchdb:Url=http://localhost:5984;User=abc123;Password=abcdef;

Edit and Save CouchDB Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.