Query Elasticsearch Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Elasticsearch, DataGrip can work with live Elasticsearch data. This article shows how to establish a connection to Elasticsearch data in DataGrip and use the table editor to load Elasticsearch data.

Create a New Driver Definition for Elasticsearch

The steps below describe how to create a new Data Source in DataGrip for Elasticsearch.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Elasticsearch Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.elasticsearch.jar).
   • Set Class to cdata.jdbc.elasticsearch.Elasticsearch.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Elasticsearch

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Elasticsearch Driver" to create a new Elasticsearch Data Source.
2. In the new window, configure the connection to Elasticsearch with a JDBC URL.

   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.

   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.

3. Set URL to the connection string, e.g., jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Elasticsearch

To browse through the Elasticsearch entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Orders.Freight, Customers.ContactName FROM Customers INNER JOIN Orders ON Customers.CustomerId=Orders.CustomerId

Download a free, 30-day trial of the CData JDBC Driver for Elasticsearch and start working with your live Elasticsearch data in DataGrip. Reach out to our Support Team if you have any questions.