IMPORTANT: Version 6.6 of Elasticsearch has passed its maintenance date.
This documentation is no longer being updated. For the latest information, see the current release documentation.
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
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 from:
<dependency> <groupId>org.elasticsearch.plugin</groupId> <artifactId>x-pack-sql-jdbc</artifactId> <version>6.6.2</version> </dependency>
artifacts.elastic.co/maven by adding it to the repositories list:
<repositories> <repository> <id>elastic.co</id> <url>https://artifacts.elastic.co/maven</url> </repository> </repositories>
The driver main class is
Note the driver implements the JDBC 4.0
Service Provider mechanism meaning it is registered automatically
as long as it is 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
- Host (
localhostby default) and port (
9200by 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 properties:
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.
- Connection timeout (in seconds). That is the maximum amount of time waiting to make a connection to the server.
- Network timeout (in seconds). That is the maximum amount of time waiting for the network.
- Page timeout (in seconds). That is the maximum amount of time waiting for a page.
- Page size (in entries). The number of results returned per page by the server.
- Query timeout (in seconds). That is the maximum amount of time waiting for a query to return.
- Basic Authentication user name
- Basic Authentication password
- Enable SSL
- key store (if used) location
- key store password
- key store type.
PKCS12is a common, alternative format
- trust store location
- trust store password
- SSL protocol to be used
- Http proxy host name
- SOCKS proxy host name
- If disabled, it will ignore any misspellings or unrecognizable properties. When enabled, an exception will be thrown if the provided property cannot be recognized.
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