Ready to get started?

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

 Download Now

Learn more:

CockroachDB Icon CockroachDB JDBC Driver

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

Feed CockroachDB Data into FineReport



How to set CockroachDB data as a JDBC data source in FineReport.

The CData JDBC Driver for CockroachDB fully implements the JDBC standard and can provide CockroachDB data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set CockroachDB data as JDBC data source in FineReport and view CockroachDB data as a table in the Report Designer.

Set Up a JDBC Data Source of CockroachDB Data

Follow the instruction below to set CockroachDB data as a FineReport database connection.

  1. Copy the cdata.jdbc.cockroachdb.jar file from the lib folder in the CData JDBC Driver for CockroachDB installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.cockroachdb.lic file as well.
  2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.

Next we will set up the data connection definition in the window.

  1. Database: Others
  2. JDBC Driver: cdata.jdbc.cockroachdb.CockroachDBDriver
  3. URL: A standard JDBC connection string using semicolon-separated connection properties.

    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.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.cockroachdb.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.

    A typical JDBC URL is below:

    jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257
  4. Click Connection pool attributes and set Test before getting connections to No.

Click Test connection to ensure you have configured the connection properly. With the connection to CockroachDB set up, you can use it as FineReport data source.

Select CockroachDB Data in the Report Designer.

  1. Click to add a new template data set and select DB query to open the database query window.
  2. Choose the JDBC connection that you created from the dropdown list.
  3. The CockroachDB entities will appear as tables on the left pane.
  4. Write a SELECT statement for the CockroachDB data tables and columns that you want to load.
  5. Click preview and data is shown as table.

With these simple steps, CockroachDB can be used as a JDBC data source in FineReport.