Connect to Elasticsearch Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Elasticsearch into your processes in RapidMiner. This article uses the CData JDBC Driver for Elasticsearch to transfer Elasticsearch data to a process in RapidMiner.

Connect to Elasticsearch in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Elasticsearch:

1. Add a new database driver for Elasticsearch: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL: jdbc:elasticsearch:
4. Enter the path to the cdata.jdbc.elasticsearch.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class: cdata.jdbc.elasticsearch.ElasticsearchDriver
6. Create a new Elasticsearch connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Elasticsearch driver you configured previously.
9. Enter your connection string in the Host box.

   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 connection string is below:

   Server=127.0.0.1;Port=9200;User=admin;Password=123456;
10. Enter your username and password if necessary.

You can now use your Elasticsearch connection with the various RapidMiner operators in your process. To retrieve Elasticsearch data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Elasticsearch data.