Skip to content

Commit 156e193

Browse files
authored
SQL: [docs] Add beta[] markup to all SQL pages (#36471)
Closes: #36437
1 parent e493fc4 commit 156e193

34 files changed

+75
-9
lines changed

docs/reference/sql/appendix/syntax-reserved.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-syntax-reserved]]
44
== Reserved keywords
55

6+
beta[]
7+
68
Table with reserved keywords that need to be quoted. Also provide an example to make it more obvious.
79

810
The following table lists all of the keywords that are reserved in Presto,

docs/reference/sql/concepts.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-concepts]]
44
== Conventions and Terminology
55

6+
beta[]
7+
68
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}.
79

810
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).

docs/reference/sql/endpoints/cli.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-cli]]
44
== SQL CLI
55

6+
beta[]
7+
68
Elasticsearch ships with a script to run the SQL CLI in its `bin` directory:
79

810
[source,bash]

docs/reference/sql/endpoints/client-apps/dbeaver.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-client-apps-dbeaver]]
44
=== DBeaver
55

6+
beta[]
7+
68
[quote, https://dbeaver.io/]
79
____
810
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}.
5456

5557
Simply click on the {es} connection and start querying and exploring {es}:
5658

57-
image:images/sql/client-apps/dbeaver-6-data.png[]
59+
image:images/sql/client-apps/dbeaver-6-data.png[]

docs/reference/sql/endpoints/client-apps/dbvis.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-client-apps-dbvis]]
44
=== DbVisualizer
55

6+
beta[]
7+
68
[quote, http://www.dbvis.com/]
79
____
810
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
3941

4042
The setup is done. DbVisualizer can be used to run queries against {es} and explore its content:
4143

42-
image:images/sql/client-apps/dbvis-5-data.png[]
44+
image:images/sql/client-apps/dbvis-5-data.png[]

docs/reference/sql/endpoints/client-apps/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-client-apps]]
44
== SQL Client Applications
55

6+
beta[]
7+
68
Thanks to its <<sql-jdbc, JDBC>> interface, a broad range of third-party applications can use {es}'s SQL capabilities.
79
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):
810
as long as the app can use the {es-sql} driver, it can use {es-sql}.

docs/reference/sql/endpoints/client-apps/squirrel.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-client-apps-squirrel]]
44
=== SQquirelL SQL
55

6+
beta[]
7+
68
[quote, http://squirrel-sql.sourceforge.net/]
79
____
810
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*.
4749

4850
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}:
4951

50-
image:images/sql/client-apps/squirell-7-data.png[]
52+
image:images/sql/client-apps/squirell-7-data.png[]

docs/reference/sql/endpoints/client-apps/workbench.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-client-apps-workbench]]
44
=== SQL Workbench/J
55

6+
beta[]
7+
68
[quote, https://www.sql-workbench.eu/]
79
____
810
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.
3739

3840
SQL Workbench/J is ready to talk to {es} through SQL: click on the profile created to execute statements or explore the data:
3941

40-
image:images/sql/client-apps/workbench-4-data.png[]
42+
image:images/sql/client-apps/workbench-4-data.png[]

docs/reference/sql/endpoints/jdbc.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-jdbc]]
44
== SQL JDBC
55

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

docs/reference/sql/endpoints/rest.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-rest]]
44
== SQL REST API
55

6+
beta[]
7+
68
The SQL REST API accepts SQL in a JSON document, executes it,
79
and returns the results. For example:
810

docs/reference/sql/endpoints/translate.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-translate]]
44
== SQL Translate API
55

6+
beta[]
7+
68
The SQL Translate API accepts SQL in a JSON document and translates it
79
into native Elasticsearch queries. For example:
810

docs/reference/sql/functions/aggs.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-functions-aggs]]
44
=== Aggregate Functions
55

6+
beta[]
7+
68
Functions for computing a _single_ result from a set of input values.
79
{es-sql} supports aggregate functions only alongside <<sql-syntax-group-by,grouping>> (implicit or explicit).
810

@@ -165,4 +167,4 @@ https://en.wikipedia.org/wiki/Variance[Population] variance of input values.
165167
["source","sql",subs="attributes,callouts,macros"]
166168
----
167169
include-tagged::{sql-specs}/docs.csv-spec[aggVarPop]
168-
----
170+
----

docs/reference/sql/functions/conditional.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-functions-conditional]]
44
=== Conditional Functions
55

6+
beta[]
7+
68
Functions that return one of their arguments by evaluating in an if-else manner.
79

810
[[sql-functions-conditional-coalesce]]

docs/reference/sql/functions/date-time.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-functions-datetime]]
44
=== Date and Time Functions
55

6+
beta[]
7+
68
* Extract the year from a date (`YEAR`)
79

810
["source","sql",subs="attributes,callouts,macros"]
@@ -91,4 +93,4 @@ is the equivalent to
9193
["source","sql",subs="attributes,callouts,macros"]
9294
--------------------------------------------------
9395
include-tagged::{sql-specs}/datetime.csv-spec[dayOfYear]
94-
--------------------------------------------------
96+
--------------------------------------------------

docs/reference/sql/functions/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-functions]]
44
== Functions and Operators
55

6+
beta[]
7+
68
{es-sql} provides a comprehensive set of built-in operators and functions:
79

810
* <<sql-operators, Operators>>

docs/reference/sql/functions/math.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-functions-math]]
44
=== Math Functions
55

6+
beta[]
7+
68
All math and trigonometric functions require their input (where applicable)
79
to be numeric.
810

docs/reference/sql/functions/operators.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-operators]]
44
=== Comparison Operators
55

6+
beta[]
7+
68
Boolean operator for comparing against one or multiple expressions.
79

810
* Equality (`=`)

docs/reference/sql/functions/search.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-functions-search]]
44
=== Full-Text Search Functions
55

6+
beta[]
7+
68
Search functions should be used when performing full-text search, namely
79
when the `MATCH` or `QUERY` predicates are being used.
810
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:
3234
["source","sql",subs="attributes,callouts,macros"]
3335
----
3436
include-tagged::{sql-specs}/docs.csv-spec[scoreWithMatch]
35-
----
37+
----

docs/reference/sql/functions/string.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-functions-string]]
44
=== String Functions
55

6+
beta[]
7+
68
Functions for performing string manipulation.
79

810
[[sql-functions-string-ascii]]

docs/reference/sql/functions/system.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-functions-system]]
44
=== System Functions
55

6+
beta[]
7+
68
These functions return metadata type of information about the system being queried.
79

810
[[sql-functions-system-database]]

docs/reference/sql/functions/type-conversion.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-functions-type-conversion]]
44
=== Type Conversion Functions
55

6+
beta[]
7+
68
Functions for converting an expression of one data type to another.
79

810
[[sql-functions-type-conversion-cast]]

docs/reference/sql/getting-started.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-getting-started]]
44
== Getting Started with SQL
55

6+
beta[]
7+
68
To start using {es-sql}, create
79
an index with some data to experiment with:
810

docs/reference/sql/index.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
[partintro]
1313
--
1414

15-
experimental[]
15+
beta[]
1616

1717
X-Pack includes a SQL feature to execute SQL against Elasticsearch
1818
indices and return results in tabular format.

docs/reference/sql/language/data-types.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-data-types]]
44
== Data Types
55

6+
beta[]
7+
68
Most of {es} <<mapping-types, data types>> are available in {es-sql}, as indicated below:
79

810
[cols="^,^,^",options="header"]

docs/reference/sql/language/index-patterns.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-index-patterns]]
44
== Index patterns
55

6+
beta[]
7+
68
{es-sql} supports two types of patterns for matching multiple indices or tables:
79

810
* {es} multi-index

docs/reference/sql/language/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-spec]]
44
== SQL Language
55

6+
beta[]
7+
68
This chapter describes the SQL semantics supported in X-Pack namely:
79

810
<<sql-data-types>>:: Data types

docs/reference/sql/language/syntax/describe-table.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-syntax-describe-table]]
44
=== DESCRIBE TABLE
55

6+
beta[]
7+
68
.Synopsis
79
[source, sql]
810
----

docs/reference/sql/language/syntax/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-commands]]
44
== SQL Commands
55

6+
beta[]
7+
68
This section contains the list of SQL commands supported by {es-sql} along with their syntax:
79

810
<<sql-syntax-describe-table>>:: Describe a table.

docs/reference/sql/language/syntax/select.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-syntax-select]]
44
=== SELECT
55

6+
beta[]
7+
68
.Synopsis
79
[source, sql]
810
----
@@ -363,4 +365,4 @@ To return
363365
["source","sql",subs="attributes,callouts,macros"]
364366
----
365367
include-tagged::{sql-specs}/docs.csv-spec[limitBasic]
366-
----
368+
----

docs/reference/sql/language/syntax/show-columns.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-syntax-show-columns]]
44
=== SHOW COLUMNS
55

6+
beta[]
7+
68
.Synopsis
79
[source, sql]
810
----

docs/reference/sql/language/syntax/show-functions.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-syntax-show-functions]]
44
=== SHOW FUNCTIONS
55

6+
beta[]
7+
68
.Synopsis
79
[source, sql]
810
----

docs/reference/sql/language/syntax/show-tables.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-syntax-show-tables]]
44
=== SHOW TABLES
55

6+
beta[]
7+
68
.Synopsis
79
[source, sql]
810
----

docs/reference/sql/overview.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-overview]]
44
== Overview
55

6+
beta[]
7+
68
{es-sql} aims to provide a powerful yet lightweight SQL interface to {es}.
79

810
[[sql-introduction]]

docs/reference/sql/security.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[[sql-security]]
44
== Security
55

6+
beta[]
7+
68
{es-sql} integrates with security, if this is enabled on your cluster.
79
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).
810

0 commit comments

Comments
 (0)