Ready to get started?

Download a free trial of the CouchDB Driver to get started:

 Download Now

Learn more:

CouchDB Icon CouchDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with CouchDB.

Integrate CouchDB Data in the Pentaho Report Designer

Publish reports based on CouchDB data in the Pentaho BI tool.

The CData JDBC Driver for CouchDB data enables access to live data from dashboards and reports. This article shows how to connect to CouchDB data as a JDBC data source and publish reports based on CouchDB data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new CouchDB connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:apachecouchdb: and is followed by a semicolon-separated list of connection properties.

      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.

      When you configure the JDBC URL, 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.

      Below is a typical JDBC URL:

    • Custom Driver Class Name: Enter cdata.jdbc.apachecouchdb.ApacheCouchDBDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add CouchDB Data to a Report

You are now ready to create a report with CouchDB data.

  1. Add the CouchDB source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT MovieRuntime, MovieRating FROM Movies WHERE MovieRating = 'R'
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Movies table.
  4. Finally, run the report to see the chart.