DBeaver

DBeaver connects to Elasticsearch using either the JDBC driver or the Arrow Flight SQL protocol.

Option 1: JDBC Driver

1. Register the Driver

1. Open Database > Driver Manager
2. Click New
3. Fill in:
   • Driver Name: SoftClient4ES
   • Driver Type: Generic
   • Class Name: app.softnetwork.elastic.jdbc.ElasticDriver
   • URL Template: jdbc:elastic://{host}:{port}
4. In the Libraries tab, click Add File and select the fat JAR:
   • softclient4es8-jdbc-driver-0.1.4.jar (for ES 8.x)
5. Click OK

2. Create a Connection

1. Open Database > New Database Connection
2. Select the SoftClient4ES driver
3. Fill in:
   • Host: localhost
   • Port: 9200
4. If using authentication, go to the Driver Properties tab and set:
   • user = your username
   • password = your password
5. Click Test Connection to verify
6. Click Finish

3. Execute SQL

Open a SQL editor and run queries:

SHOW TABLES;

SELECT * FROM my_index LIMIT 10;

DESCRIBE TABLE my_index;

Option 2: Arrow Flight SQL

DBeaver also supports Arrow Flight SQL connections.

1. Install the Flight SQL Plugin

1. Go to Database > Driver Manager
2. Search for Apache Arrow Flight SQL
3. Install if not already present

2. Create a Connection

1. Open Database > New Database Connection
2. Select Apache Arrow Flight SQL
3. Set the URL: grpc://localhost:32010
4. Click Test Connection then Finish

Supported Features

Both JDBC and Arrow Flight SQL connections support:

• Full DDL (CREATE/ALTER/DROP TABLE, pipelines, watchers, enrich policies)
• Full DML (INSERT, UPDATE, DELETE, COPY INTO)
• Full DQL (SELECT with all supported clauses)
• SHOW/DESCRIBE commands
• Schema browsing in the database navigator