mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 04:58:50 +00:00
f0f8fb6e5f
The docs include portions of the SQL tests and for that to work they need to point to position of the tests. They use a relative directory but relative to *what*? That turns out to be a fairly complex thing to answer, luckilly, `index.x.asciidoc` defines `xes-repo-dir` which points to the root of the xpack docs. We can use that to find the sql tests without having to answer the "relative to what?" question in two places. Original commit: elastic/x-pack-elasticsearch@ebea586fdf
34 lines
1.0 KiB
Plaintext
34 lines
1.0 KiB
Plaintext
[role="xpack"]
|
|
[[xpack-sql]]
|
|
= SQL Access
|
|
|
|
:sql-tests: {xes-repo-dir}/../../qa/sql
|
|
: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
|
|
|
|
[partintro]
|
|
--
|
|
X-Pack includes a SQL feature to execute SQL against Elasticsearch
|
|
indices and return tabular results. There are four main components:
|
|
|
|
<<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 execute
|
|
SQL and print tabular results.
|
|
<<sql-jdbc,JDBC>>::
|
|
A JDBC driver for Elasticsearch.
|
|
--
|
|
|
|
include::getting-started.asciidoc[]
|
|
include::endpoints/index.asciidoc[]
|
|
include::functions/index.asciidoc[]
|
|
include::language/index.asciidoc[]
|
|
|
|
:jdbc-tests!:
|