Download Elasticsearch JDBC Driver

Download the Elasticsearch JDBC driver, copy the JDBC URL into DbSchema, and start designing schemas with ER diagrams — free Community Edition.

About the Elasticsearch JDBC driver

A JDBC driver is a Java .jar library that lets applications connect to Elasticsearch. DbSchema uses JDBC to reverse engineer schemas, run SQL, and generate documentation. Driver files are usually published by the database vendor or an open-source project.

JDBC URL format

Host, port, database name, and SSL options are passed in a URL starting with jdbc:. Each Elasticsearch driver uses its own syntax — see the connection details below.

The Elasticsearch JDBC driver

Elasticsearch is a distributed search and analytics engine built on Apache Lucene. While primarily a full-text search store, it also functions as a document database for log analytics (the ELK stack), APM, and near-real-time search applications.

The Elasticsearch JDBC URL

• Required File(s): x-pack-sql-jdbc-xxx.jar
• Java Driver Class: org.elasticsearch.xpack.sql.jdbc.EsDriver
• JDBC URL: jdbc:es://https:HOST:PORT/DB
• Website: Elasticsearch

License Requirement

Note: The Elasticsearch JDBC driver requires a Platinum or higher Elastic license. It is a commercial feature of Elastic Stack. For open-source alternatives, consider community-built drivers.

Download Elasticsearch JDBC Driver

The driver archive is a zip file. Extract it and load the .jar files using DbSchema's Driver Manager.

Connecting to Elasticsearch

Elasticsearch is the one database here where a correct URL, a reachable port and valid credentials can still be refused — because SQL over JDBC is a licensed feature.

1. Check the licence first. The Elasticsearch SQL JDBC client needs a Platinum subscription or an active trial licence on the cluster. On a Basic licence the connection is rejected with a message about the current licence being non-compliant for jdbc. No client-side setting works around it — start a trial on the cluster or use a licensed one.
2. Let the node listen beyond localhost. Set network.host in elasticsearch.yml to an address clients can reach and restart the node. Be aware that moving off localhost makes Elasticsearch apply its production bootstrap checks, so a node that started happily in development may now refuse to start until those are satisfied.
3. Trust the HTTPS certificate. Recent versions enable TLS with a self-generated CA. Import that certificate into a Java truststore, otherwise the handshake fails before authentication.
4. Open port 9200 in the server's firewall. The database listens on port 9200 unless it was installed with a different one. A host firewall on the server blocks incoming connections on that port until a rule allows them. The firewall guide has the commands for Windows, ufw, firewalld and iptables.
5. Connect from DbSchema. In the Connection Dialog choose Remote computer or custom port, fill in the server host and the port, then press Test Connection to check that the server answers before you connect.

DbSchema and Elasticsearch

DbSchema connects to Elasticsearch using the official x-pack-sql JDBC driver and renders index mappings as table schemas. Use the SQL Editor to run Elasticsearch SQL queries against your indices and export results to CSV.