2017-08-28 11:41:43 -07:00
|
|
|
[role="xpack"]
|
|
|
|
[[xpack-sql]]
|
|
|
|
= SQL Access
|
|
|
|
|
2017-11-09 17:06:32 +02:00
|
|
|
:sql-tests: {docdir}/../../../qa/sql
|
2017-10-30 17:23:27 +00:00
|
|
|
:sql-specs: {sql-tests}/src/main/resources
|
|
|
|
:jdbc-tests: {sql-tests}/src/main/java/org/elasticsearch/xpack/qa/sql/jdbc
|
|
|
|
:security-tests: {sql-tests}/security/src/test/java/org/elasticsearch/xpack/qa/sql/security
|
2017-08-29 15:32:44 -04:00
|
|
|
|
2017-08-28 11:41:43 -07:00
|
|
|
[partintro]
|
|
|
|
--
|
2017-10-30 17:23:27 +00:00
|
|
|
X-Pack includes a SQL feature to execute SQL against Elasticsearch
|
|
|
|
indices and return tabular results. There are four main components:
|
2017-08-28 11:41:43 -07:00
|
|
|
|
2017-10-30 17:23:27 +00:00
|
|
|
<<sql-rest,REST API>>::
|
|
|
|
Accepts SQL in a JSON document, executes it, and returns the
|
|
|
|
results.
|
|
|
|
<<sql-translate,Translate API>>::
|
|
|
|
Accepts SQL in a JSON document and translates it into a native
|
|
|
|
Elasticsearch query and returns that.
|
|
|
|
<<sql-cli,CLI>>::
|
|
|
|
Command line application that connects to Elasticsearch to excute
|
|
|
|
SQL and print tabular results.
|
|
|
|
<<sql-jdbc,JDBC>>::
|
|
|
|
A JDBC driver for Elasticsearch.
|
2017-08-28 11:41:43 -07:00
|
|
|
--
|
|
|
|
|
2017-11-09 18:45:49 +02:00
|
|
|
include::sql-overview.asciidoc[]
|
|
|
|
include::sql-getting-started.asciidoc[]
|
|
|
|
include::endpoints/sql-endpoints.asciidoc[]
|
|
|
|
include::functions/sql-functions.asciidoc[]
|
|
|
|
include::language/sql-language.asciidoc[]
|
2017-08-29 15:32:44 -04:00
|
|
|
|
|
|
|
:jdbc-tests!:
|
2017-11-09 18:45:49 +02:00
|
|
|
|