SQL: [docs] Add `beta[]` markup to all SQL pages (#36471)
Closes: #36437
This commit is contained in:
parent
d01b30acba
commit
031d0566b0
|
@ -3,6 +3,8 @@
|
|||
[[sql-syntax-reserved]]
|
||||
== Reserved keywords
|
||||
|
||||
beta[]
|
||||
|
||||
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,
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-concepts]]
|
||||
== 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}.
|
||||
|
||||
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).
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-cli]]
|
||||
== SQL CLI
|
||||
|
||||
beta[]
|
||||
|
||||
Elasticsearch ships with a script to run the SQL CLI in its `bin` directory:
|
||||
|
||||
[source,bash]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-client-apps-dbeaver]]
|
||||
=== DBeaver
|
||||
|
||||
beta[]
|
||||
|
||||
[quote, https://dbeaver.io/]
|
||||
____
|
||||
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}:
|
||||
|
||||
image:images/sql/client-apps/dbeaver-6-data.png[]
|
||||
image:images/sql/client-apps/dbeaver-6-data.png[]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-client-apps-dbvis]]
|
||||
=== DbVisualizer
|
||||
|
||||
beta[]
|
||||
|
||||
[quote, http://www.dbvis.com/]
|
||||
____
|
||||
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:
|
||||
|
||||
image:images/sql/client-apps/dbvis-5-data.png[]
|
||||
image:images/sql/client-apps/dbvis-5-data.png[]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-client-apps]]
|
||||
== SQL Client Applications
|
||||
|
||||
beta[]
|
||||
|
||||
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):
|
||||
as long as the app can use the {es-sql} driver, it can use {es-sql}.
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-client-apps-squirrel]]
|
||||
=== SQquirelL SQL
|
||||
|
||||
beta[]
|
||||
|
||||
[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 [...].
|
||||
|
@ -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}:
|
||||
|
||||
image:images/sql/client-apps/squirell-7-data.png[]
|
||||
image:images/sql/client-apps/squirell-7-data.png[]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-client-apps-workbench]]
|
||||
=== SQL Workbench/J
|
||||
|
||||
beta[]
|
||||
|
||||
[quote, https://www.sql-workbench.eu/]
|
||||
____
|
||||
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:
|
||||
|
||||
image:images/sql/client-apps/workbench-4-data.png[]
|
||||
image:images/sql/client-apps/workbench-4-data.png[]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-jdbc]]
|
||||
== SQL JDBC
|
||||
|
||||
beta[]
|
||||
|
||||
{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,
|
||||
pure Java driver that converts JDBC calls to {es-sql}.
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-rest]]
|
||||
== SQL REST API
|
||||
|
||||
beta[]
|
||||
|
||||
The SQL REST API accepts SQL in a JSON document, executes it,
|
||||
and returns the results. For example:
|
||||
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-translate]]
|
||||
== SQL Translate API
|
||||
|
||||
beta[]
|
||||
|
||||
The SQL Translate API accepts SQL in a JSON document and translates it
|
||||
into native Elasticsearch queries. For example:
|
||||
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-functions-aggs]]
|
||||
=== Aggregate Functions
|
||||
|
||||
beta[]
|
||||
|
||||
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).
|
||||
|
||||
|
@ -165,4 +167,4 @@ https://en.wikipedia.org/wiki/Variance[Population] variance of input values.
|
|||
["source","sql",subs="attributes,callouts,macros"]
|
||||
----
|
||||
include-tagged::{sql-specs}/docs.csv-spec[aggVarPop]
|
||||
----
|
||||
----
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-functions-conditional]]
|
||||
=== Conditional Functions
|
||||
|
||||
beta[]
|
||||
|
||||
Functions that return one of their arguments by evaluating in an if-else manner.
|
||||
|
||||
[[sql-functions-conditional-coalesce]]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-functions-datetime]]
|
||||
=== Date and Time Functions
|
||||
|
||||
beta[]
|
||||
|
||||
* Extract the year from a date (`YEAR`)
|
||||
|
||||
["source","sql",subs="attributes,callouts,macros"]
|
||||
|
@ -91,4 +93,4 @@ is the equivalent to
|
|||
["source","sql",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{sql-specs}/datetime.csv-spec[dayOfYear]
|
||||
--------------------------------------------------
|
||||
--------------------------------------------------
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-functions]]
|
||||
== Functions and Operators
|
||||
|
||||
beta[]
|
||||
|
||||
{es-sql} provides a comprehensive set of built-in operators and functions:
|
||||
|
||||
* <<sql-operators, Operators>>
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-functions-math]]
|
||||
=== Math Functions
|
||||
|
||||
beta[]
|
||||
|
||||
All math and trigonometric functions require their input (where applicable)
|
||||
to be numeric.
|
||||
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-operators]]
|
||||
=== Comparison Operators
|
||||
|
||||
beta[]
|
||||
|
||||
Boolean operator for comparing against one or multiple expressions.
|
||||
|
||||
* Equality (`=`)
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-functions-search]]
|
||||
=== Full-Text Search Functions
|
||||
|
||||
beta[]
|
||||
|
||||
Search functions should be used when performing full-text search, namely
|
||||
when the `MATCH` or `QUERY` predicates are being used.
|
||||
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"]
|
||||
----
|
||||
include-tagged::{sql-specs}/docs.csv-spec[scoreWithMatch]
|
||||
----
|
||||
----
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-functions-string]]
|
||||
=== String Functions
|
||||
|
||||
beta[]
|
||||
|
||||
Functions for performing string manipulation.
|
||||
|
||||
[[sql-functions-string-ascii]]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-functions-system]]
|
||||
=== System Functions
|
||||
|
||||
beta[]
|
||||
|
||||
These functions return metadata type of information about the system being queried.
|
||||
|
||||
[[sql-functions-system-database]]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-functions-type-conversion]]
|
||||
=== Type Conversion Functions
|
||||
|
||||
beta[]
|
||||
|
||||
Functions for converting an expression of one data type to another.
|
||||
|
||||
[[sql-functions-type-conversion-cast]]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-getting-started]]
|
||||
== Getting Started with SQL
|
||||
|
||||
beta[]
|
||||
|
||||
To start using {es-sql}, create
|
||||
an index with some data to experiment with:
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
[partintro]
|
||||
--
|
||||
|
||||
experimental[]
|
||||
beta[]
|
||||
|
||||
X-Pack includes a SQL feature to execute SQL against Elasticsearch
|
||||
indices and return results in tabular format.
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-data-types]]
|
||||
== Data Types
|
||||
|
||||
beta[]
|
||||
|
||||
Most of {es} <<mapping-types, data types>> are available in {es-sql}, as indicated below:
|
||||
|
||||
[cols="^,^,^",options="header"]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-index-patterns]]
|
||||
== Index patterns
|
||||
|
||||
beta[]
|
||||
|
||||
{es-sql} supports two types of patterns for matching multiple indices or tables:
|
||||
|
||||
* {es} multi-index
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-spec]]
|
||||
== SQL Language
|
||||
|
||||
beta[]
|
||||
|
||||
This chapter describes the SQL semantics supported in X-Pack namely:
|
||||
|
||||
<<sql-data-types>>:: Data types
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-syntax-describe-table]]
|
||||
=== DESCRIBE TABLE
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-commands]]
|
||||
== SQL Commands
|
||||
|
||||
beta[]
|
||||
|
||||
This section contains the list of SQL commands supported by {es-sql} along with their syntax:
|
||||
|
||||
<<sql-syntax-describe-table>>:: Describe a table.
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-syntax-select]]
|
||||
=== SELECT
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
@ -363,4 +365,4 @@ To return
|
|||
["source","sql",subs="attributes,callouts,macros"]
|
||||
----
|
||||
include-tagged::{sql-specs}/docs.csv-spec[limitBasic]
|
||||
----
|
||||
----
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-syntax-show-columns]]
|
||||
=== SHOW COLUMNS
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-syntax-show-functions]]
|
||||
=== SHOW FUNCTIONS
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-syntax-show-tables]]
|
||||
=== SHOW TABLES
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-overview]]
|
||||
== Overview
|
||||
|
||||
beta[]
|
||||
|
||||
{es-sql} aims to provide a powerful yet lightweight SQL interface to {es}.
|
||||
|
||||
[[sql-introduction]]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
[[sql-security]]
|
||||
== Security
|
||||
|
||||
beta[]
|
||||
|
||||
{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).
|
||||
|
||||
|
|
Loading…
Reference in New Issue