2017-12-13 10:19:31 -05:00
|
|
|
[role="xpack"]
|
2018-06-22 18:40:25 -04:00
|
|
|
[testenv="basic"]
|
2017-12-13 10:19:31 -05:00
|
|
|
[[xpack-sql]]
|
2018-09-27 11:36:18 -04:00
|
|
|
= SQL access
|
2017-12-13 10:19:31 -05:00
|
|
|
|
2018-10-30 15:47:25 -04:00
|
|
|
:sql-tests: {xes-repo-dir}/../../plugin/sql/qa
|
2019-03-25 09:22:59 -04:00
|
|
|
:sql-specs: {sql-tests}/src/main/resources/
|
2018-10-30 15:47:25 -04:00
|
|
|
:jdbc-tests: {sql-tests}/src/main/java/org/elasticsearch/xpack/sql/qa/jdbc
|
|
|
|
|
:security-tests: {sql-tests}/security/src/test/java/org/elasticsearch/xpack/sql/qa/security
|
2018-06-13 06:53:08 -04:00
|
|
|
:es-sql: Elasticsearch SQL
|
2017-12-13 10:19:31 -05:00
|
|
|
|
|
|
|
|
[partintro]
|
|
|
|
|
--
|
2018-06-12 12:46:08 -04:00
|
|
|
|
2019-02-15 08:24:03 -05:00
|
|
|
X-Pack includes a SQL feature to execute SQL queries against {es}
|
2018-06-13 06:53:08 -04:00
|
|
|
indices and return results in tabular format.
|
2017-12-13 10:19:31 -05:00
|
|
|
|
2019-02-15 08:24:03 -05:00
|
|
|
The following chapters aim to cover everything from usage, to syntax and drivers.
|
|
|
|
|
Experience users or those in a hurry might want to jump directly to
|
|
|
|
|
the list of SQL <<sql-commands, commands>> and <<sql-functions, functions>>.
|
|
|
|
|
|
2018-06-13 06:53:08 -04:00
|
|
|
<<sql-overview, Overview>>::
|
|
|
|
|
Overview of {es-sql} and its features.
|
|
|
|
|
<<sql-getting-started, Getting Started>>::
|
2018-06-20 14:40:13 -04:00
|
|
|
Start using SQL right away in {es}.
|
|
|
|
|
<<sql-concepts, Concepts and Terminology>>::
|
|
|
|
|
Language conventions across SQL and {es}.
|
|
|
|
|
<<sql-security,Security>>::
|
2019-02-15 08:24:03 -05:00
|
|
|
Secure {es-sql} and {es}.
|
2017-12-13 10:19:31 -05:00
|
|
|
<<sql-rest,REST API>>::
|
2019-02-15 08:24:03 -05:00
|
|
|
Execute SQL in JSON format over REST.
|
2017-12-13 10:19:31 -05:00
|
|
|
<<sql-translate,Translate API>>::
|
2019-02-15 08:24:03 -05:00
|
|
|
Translate SQL in JSON format to {es} native query.
|
2017-12-13 10:19:31 -05:00
|
|
|
<<sql-cli,CLI>>::
|
2019-02-15 08:24:03 -05:00
|
|
|
Command-line application for executing SQL against {es}.
|
2017-12-13 10:19:31 -05:00
|
|
|
<<sql-jdbc,JDBC>>::
|
2019-02-15 08:24:03 -05:00
|
|
|
JDBC driver for {es}.
|
2018-12-27 04:55:20 -05:00
|
|
|
<<sql-odbc,ODBC>>::
|
2019-02-15 08:24:03 -05:00
|
|
|
ODBC driver for {es}.
|
2018-09-08 09:23:43 -04:00
|
|
|
<<sql-client-apps,Client Applications>>::
|
2019-02-15 08:24:03 -05:00
|
|
|
Setup various SQL/BI tools with {es-sql}.
|
2018-06-13 06:53:08 -04:00
|
|
|
<<sql-spec,SQL Language>>::
|
2018-11-14 18:23:28 -05:00
|
|
|
Overview of the {es-sql} language, such as supported data types, commands and
|
2018-06-20 14:40:13 -04:00
|
|
|
syntax.
|
2018-06-21 17:16:03 -04:00
|
|
|
<<sql-functions,Functions and Operators>>::
|
|
|
|
|
List of functions and operators supported.
|
2018-12-21 16:25:54 -05:00
|
|
|
<<sql-limitations,Limitations>>::
|
|
|
|
|
{es-sql} current limitations.
|
2017-12-13 10:19:31 -05:00
|
|
|
--
|
|
|
|
|
|
2018-06-13 06:53:08 -04:00
|
|
|
include::overview.asciidoc[]
|
2018-01-03 15:06:36 -05:00
|
|
|
include::getting-started.asciidoc[]
|
2018-06-20 14:40:13 -04:00
|
|
|
include::concepts.asciidoc[]
|
|
|
|
|
include::security.asciidoc[]
|
2018-01-03 15:06:36 -05:00
|
|
|
include::endpoints/index.asciidoc[]
|
|
|
|
|
include::language/index.asciidoc[]
|
2018-06-21 17:16:03 -04:00
|
|
|
include::functions/index.asciidoc[]
|
2018-06-20 14:40:13 -04:00
|
|
|
include::appendix/index.asciidoc[]
|
2018-12-21 16:25:54 -05:00
|
|
|
include::limitations.asciidoc[]
|
2017-12-13 10:19:31 -05:00
|
|
|
|
|
|
|
|
:jdbc-tests!:
|
