SQL: [docs] Add `beta[]` markup to all SQL pages (#36471)

Closes: #36437
This commit is contained in:
Marios Trivyzas 2018-12-11 12:29:44 +02:00
parent d01b30acba
commit 031d0566b0
No known key found for this signature in database
GPG Key ID: 8817B46B0CF36A3F
34 changed files with 75 additions and 9 deletions

View File

@ -3,6 +3,8 @@
[[sql-syntax-reserved]] [[sql-syntax-reserved]]
== Reserved keywords == Reserved keywords
beta[]
Table with reserved keywords that need to be quoted. Also provide an example to make it more obvious. Table with reserved keywords that need to be quoted. Also provide an example to make it more obvious.
The following table lists all of the keywords that are reserved in Presto, The following table lists all of the keywords that are reserved in Presto,

View File

@ -3,6 +3,8 @@
[[sql-concepts]] [[sql-concepts]]
== Conventions and Terminology == Conventions and Terminology
beta[]
For clarity, it is important to establish the meaning behind certain words as, the same wording might convey different meanings to different readers depending on one's familiarity with SQL versus {es}. For clarity, it is important to establish the meaning behind certain words as, the same wording might convey different meanings to different readers depending on one's familiarity with SQL versus {es}.
NOTE: This documentation while trying to be complete, does assume the reader has _basic_ understanding of {es} and/or SQL. If that is not the case, please continue reading the documentation however take notes and pursue the topics that are unclear either through the main {es} documentation or through the plethora of SQL material available in the open (there are simply too many excellent resources here to enumerate). NOTE: This documentation while trying to be complete, does assume the reader has _basic_ understanding of {es} and/or SQL. If that is not the case, please continue reading the documentation however take notes and pursue the topics that are unclear either through the main {es} documentation or through the plethora of SQL material available in the open (there are simply too many excellent resources here to enumerate).

View File

@ -3,6 +3,8 @@
[[sql-cli]] [[sql-cli]]
== SQL CLI == SQL CLI
beta[]
Elasticsearch ships with a script to run the SQL CLI in its `bin` directory: Elasticsearch ships with a script to run the SQL CLI in its `bin` directory:
[source,bash] [source,bash]

View File

@ -3,6 +3,8 @@
[[sql-client-apps-dbeaver]] [[sql-client-apps-dbeaver]]
=== DBeaver === DBeaver
beta[]
[quote, https://dbeaver.io/] [quote, https://dbeaver.io/]
____ ____
https://dbeaver.io/[DBeaver] DBeaver is free and open source universal database tool for developers and database administrators. https://dbeaver.io/[DBeaver] DBeaver is free and open source universal database tool for developers and database administrators.
@ -54,4 +56,4 @@ DBeaver is now configured to talk to {es}.
Simply click on the {es} connection and start querying and exploring {es}: Simply click on the {es} connection and start querying and exploring {es}:
image:images/sql/client-apps/dbeaver-6-data.png[] image:images/sql/client-apps/dbeaver-6-data.png[]

View File

@ -3,6 +3,8 @@
[[sql-client-apps-dbvis]] [[sql-client-apps-dbvis]]
=== DbVisualizer === DbVisualizer
beta[]
[quote, http://www.dbvis.com/] [quote, http://www.dbvis.com/]
____ ____
https://www.dbvis.com/[DbVisualizer] is a database management and analysis tool for all major databases. https://www.dbvis.com/[DbVisualizer] is a database management and analysis tool for all major databases.
@ -39,4 +41,4 @@ Press *Connect* and the driver version (as that of the cluster) should show up u
The setup is done. DbVisualizer can be used to run queries against {es} and explore its content: The setup is done. DbVisualizer can be used to run queries against {es} and explore its content:
image:images/sql/client-apps/dbvis-5-data.png[] image:images/sql/client-apps/dbvis-5-data.png[]

View File

@ -3,6 +3,8 @@
[[sql-client-apps]] [[sql-client-apps]]
== SQL Client Applications == SQL Client Applications
beta[]
Thanks to its <<sql-jdbc, JDBC>> interface, a broad range of third-party applications can use {es}'s SQL capabilities. Thanks to its <<sql-jdbc, JDBC>> interface, a broad range of third-party applications can use {es}'s SQL capabilities.
This section lists, in alphabetical order, a number of them and their respective configuration - the list however is by no means comprehensive (feel free to https://www.elastic.co/blog/art-of-pull-request[submit a PR] to improve it): This section lists, in alphabetical order, a number of them and their respective configuration - the list however is by no means comprehensive (feel free to https://www.elastic.co/blog/art-of-pull-request[submit a PR] to improve it):
as long as the app can use the {es-sql} driver, it can use {es-sql}. as long as the app can use the {es-sql} driver, it can use {es-sql}.

View File

@ -3,6 +3,8 @@
[[sql-client-apps-squirrel]] [[sql-client-apps-squirrel]]
=== SQquirelL SQL === SQquirelL SQL
beta[]
[quote, http://squirrel-sql.sourceforge.net/] [quote, http://squirrel-sql.sourceforge.net/]
____ ____
http://squirrel-sql.sourceforge.net/[SQuirelL SQL] is a graphical, [multi-platform] Java program that will allow you to view the structure of a JDBC compliant database [...]. http://squirrel-sql.sourceforge.net/[SQuirelL SQL] is a graphical, [multi-platform] Java program that will allow you to view the structure of a JDBC compliant database [...].
@ -47,4 +49,4 @@ The setup is completed. Double check it by clicking on *Test Connection*.
The connection should open automatically (if it has been created before simply click on *Connect* in the *Alias* panel). SQuirelL SQL can now issue SQL commands to {es}: The connection should open automatically (if it has been created before simply click on *Connect* in the *Alias* panel). SQuirelL SQL can now issue SQL commands to {es}:
image:images/sql/client-apps/squirell-7-data.png[] image:images/sql/client-apps/squirell-7-data.png[]

View File

@ -3,6 +3,8 @@
[[sql-client-apps-workbench]] [[sql-client-apps-workbench]]
=== SQL Workbench/J === SQL Workbench/J
beta[]
[quote, https://www.sql-workbench.eu/] [quote, https://www.sql-workbench.eu/]
____ ____
https://www.sql-workbench.eu/[SQL Workbench/J] is a free, DBMS-independent, cross-platform SQL query tool. https://www.sql-workbench.eu/[SQL Workbench/J] is a free, DBMS-independent, cross-platform SQL query tool.
@ -37,4 +39,4 @@ The setup is complete.
SQL Workbench/J is ready to talk to {es} through SQL: click on the profile created to execute statements or explore the data: SQL Workbench/J is ready to talk to {es} through SQL: click on the profile created to execute statements or explore the data:
image:images/sql/client-apps/workbench-4-data.png[] image:images/sql/client-apps/workbench-4-data.png[]

View File

@ -3,6 +3,8 @@
[[sql-jdbc]] [[sql-jdbc]]
== SQL JDBC == SQL JDBC
beta[]
{es}'s SQL jdbc driver is a rich, fully featured JDBC driver for {es}. {es}'s SQL jdbc driver is a rich, fully featured JDBC driver for {es}.
It is Type 4 driver, meaning it is a platform independent, stand-alone, Direct to Database, It is Type 4 driver, meaning it is a platform independent, stand-alone, Direct to Database,
pure Java driver that converts JDBC calls to {es-sql}. pure Java driver that converts JDBC calls to {es-sql}.

View File

@ -3,6 +3,8 @@
[[sql-rest]] [[sql-rest]]
== SQL REST API == SQL REST API
beta[]
The SQL REST API accepts SQL in a JSON document, executes it, The SQL REST API accepts SQL in a JSON document, executes it,
and returns the results. For example: and returns the results. For example:

View File

@ -3,6 +3,8 @@
[[sql-translate]] [[sql-translate]]
== SQL Translate API == SQL Translate API
beta[]
The SQL Translate API accepts SQL in a JSON document and translates it The SQL Translate API accepts SQL in a JSON document and translates it
into native Elasticsearch queries. For example: into native Elasticsearch queries. For example:

View File

@ -3,6 +3,8 @@
[[sql-functions-aggs]] [[sql-functions-aggs]]
=== Aggregate Functions === Aggregate Functions
beta[]
Functions for computing a _single_ result from a set of input values. Functions for computing a _single_ result from a set of input values.
{es-sql} supports aggregate functions only alongside <<sql-syntax-group-by,grouping>> (implicit or explicit). {es-sql} supports aggregate functions only alongside <<sql-syntax-group-by,grouping>> (implicit or explicit).
@ -165,4 +167,4 @@ https://en.wikipedia.org/wiki/Variance[Population] variance of input values.
["source","sql",subs="attributes,callouts,macros"] ["source","sql",subs="attributes,callouts,macros"]
---- ----
include-tagged::{sql-specs}/docs.csv-spec[aggVarPop] include-tagged::{sql-specs}/docs.csv-spec[aggVarPop]
---- ----

View File

@ -3,6 +3,8 @@
[[sql-functions-conditional]] [[sql-functions-conditional]]
=== Conditional Functions === Conditional Functions
beta[]
Functions that return one of their arguments by evaluating in an if-else manner. Functions that return one of their arguments by evaluating in an if-else manner.
[[sql-functions-conditional-coalesce]] [[sql-functions-conditional-coalesce]]

View File

@ -3,6 +3,8 @@
[[sql-functions-datetime]] [[sql-functions-datetime]]
=== Date and Time Functions === Date and Time Functions
beta[]
* Extract the year from a date (`YEAR`) * Extract the year from a date (`YEAR`)
["source","sql",subs="attributes,callouts,macros"] ["source","sql",subs="attributes,callouts,macros"]
@ -91,4 +93,4 @@ is the equivalent to
["source","sql",subs="attributes,callouts,macros"] ["source","sql",subs="attributes,callouts,macros"]
-------------------------------------------------- --------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[dayOfYear] include-tagged::{sql-specs}/datetime.csv-spec[dayOfYear]
-------------------------------------------------- --------------------------------------------------

View File

@ -3,6 +3,8 @@
[[sql-functions]] [[sql-functions]]
== Functions and Operators == Functions and Operators
beta[]
{es-sql} provides a comprehensive set of built-in operators and functions: {es-sql} provides a comprehensive set of built-in operators and functions:
* <<sql-operators, Operators>> * <<sql-operators, Operators>>

View File

@ -3,6 +3,8 @@
[[sql-functions-math]] [[sql-functions-math]]
=== Math Functions === Math Functions
beta[]
All math and trigonometric functions require their input (where applicable) All math and trigonometric functions require their input (where applicable)
to be numeric. to be numeric.

View File

@ -3,6 +3,8 @@
[[sql-operators]] [[sql-operators]]
=== Comparison Operators === Comparison Operators
beta[]
Boolean operator for comparing against one or multiple expressions. Boolean operator for comparing against one or multiple expressions.
* Equality (`=`) * Equality (`=`)

View File

@ -3,6 +3,8 @@
[[sql-functions-search]] [[sql-functions-search]]
=== Full-Text Search Functions === Full-Text Search Functions
beta[]
Search functions should be used when performing full-text search, namely Search functions should be used when performing full-text search, namely
when the `MATCH` or `QUERY` predicates are being used. when the `MATCH` or `QUERY` predicates are being used.
Outside a, so-called, search context, these functions will return default values Outside a, so-called, search context, these functions will return default values
@ -32,4 +34,4 @@ However, it is perfectly fine to return the score without sorting by it:
["source","sql",subs="attributes,callouts,macros"] ["source","sql",subs="attributes,callouts,macros"]
---- ----
include-tagged::{sql-specs}/docs.csv-spec[scoreWithMatch] include-tagged::{sql-specs}/docs.csv-spec[scoreWithMatch]
---- ----

View File

@ -3,6 +3,8 @@
[[sql-functions-string]] [[sql-functions-string]]
=== String Functions === String Functions
beta[]
Functions for performing string manipulation. Functions for performing string manipulation.
[[sql-functions-string-ascii]] [[sql-functions-string-ascii]]

View File

@ -3,6 +3,8 @@
[[sql-functions-system]] [[sql-functions-system]]
=== System Functions === System Functions
beta[]
These functions return metadata type of information about the system being queried. These functions return metadata type of information about the system being queried.
[[sql-functions-system-database]] [[sql-functions-system-database]]

View File

@ -3,6 +3,8 @@
[[sql-functions-type-conversion]] [[sql-functions-type-conversion]]
=== Type Conversion Functions === Type Conversion Functions
beta[]
Functions for converting an expression of one data type to another. Functions for converting an expression of one data type to another.
[[sql-functions-type-conversion-cast]] [[sql-functions-type-conversion-cast]]

View File

@ -3,6 +3,8 @@
[[sql-getting-started]] [[sql-getting-started]]
== Getting Started with SQL == Getting Started with SQL
beta[]
To start using {es-sql}, create To start using {es-sql}, create
an index with some data to experiment with: an index with some data to experiment with:

View File

@ -12,7 +12,7 @@
[partintro] [partintro]
-- --
experimental[] beta[]
X-Pack includes a SQL feature to execute SQL against Elasticsearch X-Pack includes a SQL feature to execute SQL against Elasticsearch
indices and return results in tabular format. indices and return results in tabular format.

View File

@ -3,6 +3,8 @@
[[sql-data-types]] [[sql-data-types]]
== Data Types == Data Types
beta[]
Most of {es} <<mapping-types, data types>> are available in {es-sql}, as indicated below: Most of {es} <<mapping-types, data types>> are available in {es-sql}, as indicated below:
[cols="^,^,^",options="header"] [cols="^,^,^",options="header"]

View File

@ -3,6 +3,8 @@
[[sql-index-patterns]] [[sql-index-patterns]]
== Index patterns == Index patterns
beta[]
{es-sql} supports two types of patterns for matching multiple indices or tables: {es-sql} supports two types of patterns for matching multiple indices or tables:
* {es} multi-index * {es} multi-index

View File

@ -3,6 +3,8 @@
[[sql-spec]] [[sql-spec]]
== SQL Language == SQL Language
beta[]
This chapter describes the SQL semantics supported in X-Pack namely: This chapter describes the SQL semantics supported in X-Pack namely:
<<sql-data-types>>:: Data types <<sql-data-types>>:: Data types

View File

@ -3,6 +3,8 @@
[[sql-syntax-describe-table]] [[sql-syntax-describe-table]]
=== DESCRIBE TABLE === DESCRIBE TABLE
beta[]
.Synopsis .Synopsis
[source, sql] [source, sql]
---- ----

View File

@ -3,6 +3,8 @@
[[sql-commands]] [[sql-commands]]
== SQL Commands == SQL Commands
beta[]
This section contains the list of SQL commands supported by {es-sql} along with their syntax: This section contains the list of SQL commands supported by {es-sql} along with their syntax:
<<sql-syntax-describe-table>>:: Describe a table. <<sql-syntax-describe-table>>:: Describe a table.

View File

@ -3,6 +3,8 @@
[[sql-syntax-select]] [[sql-syntax-select]]
=== SELECT === SELECT
beta[]
.Synopsis .Synopsis
[source, sql] [source, sql]
---- ----
@ -363,4 +365,4 @@ To return
["source","sql",subs="attributes,callouts,macros"] ["source","sql",subs="attributes,callouts,macros"]
---- ----
include-tagged::{sql-specs}/docs.csv-spec[limitBasic] include-tagged::{sql-specs}/docs.csv-spec[limitBasic]
---- ----

View File

@ -3,6 +3,8 @@
[[sql-syntax-show-columns]] [[sql-syntax-show-columns]]
=== SHOW COLUMNS === SHOW COLUMNS
beta[]
.Synopsis .Synopsis
[source, sql] [source, sql]
---- ----

View File

@ -3,6 +3,8 @@
[[sql-syntax-show-functions]] [[sql-syntax-show-functions]]
=== SHOW FUNCTIONS === SHOW FUNCTIONS
beta[]
.Synopsis .Synopsis
[source, sql] [source, sql]
---- ----

View File

@ -3,6 +3,8 @@
[[sql-syntax-show-tables]] [[sql-syntax-show-tables]]
=== SHOW TABLES === SHOW TABLES
beta[]
.Synopsis .Synopsis
[source, sql] [source, sql]
---- ----

View File

@ -3,6 +3,8 @@
[[sql-overview]] [[sql-overview]]
== Overview == Overview
beta[]
{es-sql} aims to provide a powerful yet lightweight SQL interface to {es}. {es-sql} aims to provide a powerful yet lightweight SQL interface to {es}.
[[sql-introduction]] [[sql-introduction]]

View File

@ -3,6 +3,8 @@
[[sql-security]] [[sql-security]]
== Security == Security
beta[]
{es-sql} integrates with security, if this is enabled on your cluster. {es-sql} integrates with security, if this is enabled on your cluster.
In such a scenario, {es-sql} supports both security at the transport layer (by encrypting the communication between the consumer and the server) and authentication (for the access layer). In such a scenario, {es-sql} supports both security at the transport layer (by encrypting the communication between the consumer and the server) and authentication (for the access layer).