Connect to Elasticsearch Data in IntelliJ

The CData JDBC Driver for Elasticsearch enables you to access Elasticsearch as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Elasticsearch data in IntelliJ.

Create a JBDC Data Source for Elasticsearch

Follow the steps below to add the driver JAR and define connection properties required to connect to Elasticsearch data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.elasticsearch.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.elasticsearch.ElasticsearchDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:elasticsearch: and includes connection properties separated with semicolons.

     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 the following:

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

Edit and Save Elasticsearch Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.