Ready to get started?

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

 Download Now

Learn more:

Elasticsearch Icon Elasticsearch JDBC Driver

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

Connect to Elasticsearch Data in CloverDX (formerly CloverETL)



Transfer Elasticsearch data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Elasticsearch enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Elasticsearch as sources and destinations. In this article, you will use the JDBC Driver for Elasticsearch to set up a simple transfer into a flat file. The CData JDBC Driver for Elasticsearch enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Elasticsearch as sources and destinations. In this article, you will use the JDBC Driver for Elasticsearch to set up a simple transfer into a flat file.

Connect to Elasticsearch as a JDBC Data Source

  1. Create the connection to Elasticsearch data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.elasticsearch.jar file.
  3. Enter the JDBC URL.

    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.

    A typical JDBC URL is below:

    jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;

Query Elasticsearch Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Elasticsearch JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Orders.Freight, Customers.ContactName FROM Customers INNER JOIN Orders ON Customers.CustomerId=Orders.CustomerId

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Orders table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.