Elasticsearch’s SQL jdbc driver is a rich, fully featured JDBC driver for Elasticsearch. It is Type 4 driver, meaning it is a platform independent, stand-alone, Direct to Database, pure Java driver that converts JDBC calls to Elasticsearch SQL.


The JDBC driver can be obtained either by downloading it from the elastic.co site or by using a Maven-compatible tool with the following dependency:


from artifacts.elastic.co/maven by adding it to the repositories list:



The driver main class is org.elasticsearch.xpack.sql.jdbc.jdbc.JdbcDriver. Note the driver implements the JDBC 4.0 Service Provider mechanism meaning it is registerd automatically as long as its available in the classpath.

Once registered, the driver understands the following syntax as an URL:

Prefix. Mandatory.
Type of HTTP connection to make. Possible values are http (default) or https. Optional.
Host (localhost by default) and port (9200 by default). Optional.
Prefix (empty by default). Typically used when hosting Elasticsearch under a certain path. Optional.
Properties for the JDBC driver. Empty by default. Optional.

The driver recognized the following parameters:

timezone (default JVM timezone)
Timezone used by the driver per connection indicated by its ID. Highly recommended to set it (to, say, UTC) as the JVM timezone can vary, is global for the entire JVM and can’t be changed easily when running under a security manager.
connect.timeout (default 30s)
Connection timeout (in seconds). That is the maximum amount of time waiting to make a connection to the server.
network.timeout (default 60s)
Network timeout (in seconds). That is the maximum amount of time waiting for the network.
page.timeout (default 45s)
Page timeout (in seconds). That is the maximum amount of time waiting for a page.
page.size (default 1000)
Page size (in entries). The number of results returned per page by the server.
query.timeout (default 90s)
Query timeout (in seconds). That is the maximum amount of time waiting for a query to return.

Basic Authenticationedit

Basic Authentication user name
Basic Authentication password


ssl (default false)
Enable SSL
key store (if used) location
key store password
ssl.keystore.type (default JKS)
key store type. PKCS12 is a common, alternative format
trust store location
trust store password
ssl.cert.allow.self.signed (default false)
Whether or not to allow self signed certificates
ssl.protocol(default TLS)
SSL protocol to be used


Http proxy host name
SOCKS proxy host name

To put all of it together, the following URL:


Opens up a Elasticsearch SQL connection to server on port 3456, setting the JDBC connection timezone to UTC and its pagesize to 250 entries.