Ready to get started?

Learn more about the CData JDBC Driver for Elasticsearch or download a free trial:

Download Now

Feed Elasticsearch Data into FineReport

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

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

Set Up a JDBC Data Source of Elasticsearch Data

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

  1. Copy the cdata.jdbc.elasticsearch.jar file from the lib folder in the CData JDBC Driver for Elasticsearch installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.elasticsearch.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.elasticsearch.Elasticsearch Driver
  3. URL: A standard JDBC connection string using semicolon-separated connection properties.

    Set the Server and Port connection properties to connect. To authenticate, set the User and Password properties, PKI (public key infrastructure) properties, or both. To use PKI, set the SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword properties.

    The data provider uses X-Pack Security for TLS/SSL and authentication. To connect over TLS/SSL, prefix the Server value with 'https://'. Note: TLS/SSL and client authentication must be enabled on X-Pack to use PKI.

    Once the data provider is connected, X-Pack will then perform user authentication and grant role permissions based on the realms you have configured.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.elasticsearch.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:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;
  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 Elasticsearch set up, you can use it as FineReport data source.

Select Elasticsearch 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 Elasticsearch entities will appear as tables on the left pane.
  4. Write a SELECT statement for the Elasticsearch data tables and columns that you want to load.
  5. Click preview and data is shown as table.

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