How to Connect DBeaver to Elasticsearch via a JDBC Driver

The CData JDBC Driver for Elasticsearch implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Elasticsearch data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Elasticsearch Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Elasticsearch).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.elasticsearch.ElasticsearchDriver.
   • Set URL Template to jdbc:elasticsearch:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.Elasticsearch.jar).

Create a Connection to Elasticsearch Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Elasticsearch) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required 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.

   Below is a typical connection string:

   jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Elasticsearch Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial