IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« SQL Client Applications DbVisualizer »
Elastic Docs ›Elasticsearch Guide [6.5] ›SQL Access ›SQL Client Applications

DBeaver

edit

DBeaver

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

DBeaver DBeaver is free and open source universal database tool for developers and database administrators.
-- https://dbeaver.io/

Prerequisites

edit
  • DBeaver version 5.1.4 or higher
  • Elasticsearch SQL JDBC driver

New Connection

edit

Create a new connection either through the menu File > New > Database Connection menu or directly through the Database Connection panel.

dbeaver 1 new conn

Select Elasticsearch type

edit

Select the Elasticsearch type from the available connection types:

dbeaver 2 conn es

Specify the Elasticsearch cluster information

edit

Configure the Elasticsearch SQL connection appropriately:

dbeaver 3 conn props

Verify the driver version

edit

Make sure the correct JDBC driver version is used by using the Edit Driver Settings button:

dbeaver 4 driver ver

DBeaver is aware of the Elasticsearch JDBC maven repository so simply Download/Update the artifact or add a new one. As an alternative one can add a local file instead if the Elasticsearch Maven repository is not an option.

When changing the driver, make sure to click on the Find Class button at the bottom - the Driver class should be picked out automatically however this provides a sanity check that the driver jar is properly found and it is not corrupt.

Test connectivity

edit

Once the driver version and the settings are in place, use Test Connection to check that everything works. If things are okay, one should get a confirmation window with the version of the driver and that of Elasticsearch SQL:

dbeaver 5 test conn

Click Finish and the new Elasticsearch connection appears in the Database Connection panel.

DBeaver is now configured to talk to Elasticsearch.

Connect to Elasticsearch

edit

Simply click on the Elasticsearch connection and start querying and exploring Elasticsearch:

dbeaver 6 data

« SQL Client Applications DbVisualizer »