From 031d0566b0bbf33e47f9914da1f68d5abb394668 Mon Sep 17 00:00:00 2001 From: Marios Trivyzas Date: Tue, 11 Dec 2018 12:29:44 +0200 Subject: [PATCH] SQL: [docs] Add `beta[]` markup to all SQL pages (#36471) Closes: #36437 --- docs/reference/sql/appendix/syntax-reserved.asciidoc | 2 ++ docs/reference/sql/concepts.asciidoc | 2 ++ docs/reference/sql/endpoints/cli.asciidoc | 2 ++ docs/reference/sql/endpoints/client-apps/dbeaver.asciidoc | 4 +++- docs/reference/sql/endpoints/client-apps/dbvis.asciidoc | 4 +++- docs/reference/sql/endpoints/client-apps/index.asciidoc | 2 ++ docs/reference/sql/endpoints/client-apps/squirrel.asciidoc | 4 +++- docs/reference/sql/endpoints/client-apps/workbench.asciidoc | 4 +++- docs/reference/sql/endpoints/jdbc.asciidoc | 2 ++ docs/reference/sql/endpoints/rest.asciidoc | 2 ++ docs/reference/sql/endpoints/translate.asciidoc | 2 ++ docs/reference/sql/functions/aggs.asciidoc | 4 +++- docs/reference/sql/functions/conditional.asciidoc | 2 ++ docs/reference/sql/functions/date-time.asciidoc | 4 +++- docs/reference/sql/functions/index.asciidoc | 2 ++ docs/reference/sql/functions/math.asciidoc | 2 ++ docs/reference/sql/functions/operators.asciidoc | 2 ++ docs/reference/sql/functions/search.asciidoc | 4 +++- docs/reference/sql/functions/string.asciidoc | 2 ++ docs/reference/sql/functions/system.asciidoc | 2 ++ docs/reference/sql/functions/type-conversion.asciidoc | 2 ++ docs/reference/sql/getting-started.asciidoc | 2 ++ docs/reference/sql/index.asciidoc | 2 +- docs/reference/sql/language/data-types.asciidoc | 2 ++ docs/reference/sql/language/index-patterns.asciidoc | 2 ++ docs/reference/sql/language/index.asciidoc | 2 ++ docs/reference/sql/language/syntax/describe-table.asciidoc | 2 ++ docs/reference/sql/language/syntax/index.asciidoc | 2 ++ docs/reference/sql/language/syntax/select.asciidoc | 4 +++- docs/reference/sql/language/syntax/show-columns.asciidoc | 2 ++ docs/reference/sql/language/syntax/show-functions.asciidoc | 2 ++ docs/reference/sql/language/syntax/show-tables.asciidoc | 2 ++ docs/reference/sql/overview.asciidoc | 2 ++ docs/reference/sql/security.asciidoc | 2 ++ 34 files changed, 75 insertions(+), 9 deletions(-) diff --git a/docs/reference/sql/appendix/syntax-reserved.asciidoc b/docs/reference/sql/appendix/syntax-reserved.asciidoc index 6bbd81233bf..977e6a7328c 100644 --- a/docs/reference/sql/appendix/syntax-reserved.asciidoc +++ b/docs/reference/sql/appendix/syntax-reserved.asciidoc @@ -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, diff --git a/docs/reference/sql/concepts.asciidoc b/docs/reference/sql/concepts.asciidoc index aceea1949a2..617091446ea 100644 --- a/docs/reference/sql/concepts.asciidoc +++ b/docs/reference/sql/concepts.asciidoc @@ -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). diff --git a/docs/reference/sql/endpoints/cli.asciidoc b/docs/reference/sql/endpoints/cli.asciidoc index eef2fbfbf59..c5d0290ca2c 100644 --- a/docs/reference/sql/endpoints/cli.asciidoc +++ b/docs/reference/sql/endpoints/cli.asciidoc @@ -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] diff --git a/docs/reference/sql/endpoints/client-apps/dbeaver.asciidoc b/docs/reference/sql/endpoints/client-apps/dbeaver.asciidoc index ac5ea875e1c..63d7040692f 100644 --- a/docs/reference/sql/endpoints/client-apps/dbeaver.asciidoc +++ b/docs/reference/sql/endpoints/client-apps/dbeaver.asciidoc @@ -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[] \ No newline at end of file +image:images/sql/client-apps/dbeaver-6-data.png[] diff --git a/docs/reference/sql/endpoints/client-apps/dbvis.asciidoc b/docs/reference/sql/endpoints/client-apps/dbvis.asciidoc index dabee6430fa..3e8092babe8 100644 --- a/docs/reference/sql/endpoints/client-apps/dbvis.asciidoc +++ b/docs/reference/sql/endpoints/client-apps/dbvis.asciidoc @@ -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[] \ No newline at end of file +image:images/sql/client-apps/dbvis-5-data.png[] diff --git a/docs/reference/sql/endpoints/client-apps/index.asciidoc b/docs/reference/sql/endpoints/client-apps/index.asciidoc index 2c497518328..c06e5899d57 100644 --- a/docs/reference/sql/endpoints/client-apps/index.asciidoc +++ b/docs/reference/sql/endpoints/client-apps/index.asciidoc @@ -3,6 +3,8 @@ [[sql-client-apps]] == SQL Client Applications +beta[] + Thanks to its <> 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}. diff --git a/docs/reference/sql/endpoints/client-apps/squirrel.asciidoc b/docs/reference/sql/endpoints/client-apps/squirrel.asciidoc index c5a30ab15c9..2c2e59a24a2 100644 --- a/docs/reference/sql/endpoints/client-apps/squirrel.asciidoc +++ b/docs/reference/sql/endpoints/client-apps/squirrel.asciidoc @@ -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[] \ No newline at end of file +image:images/sql/client-apps/squirell-7-data.png[] diff --git a/docs/reference/sql/endpoints/client-apps/workbench.asciidoc b/docs/reference/sql/endpoints/client-apps/workbench.asciidoc index e50a086ab3b..e462d6a9690 100644 --- a/docs/reference/sql/endpoints/client-apps/workbench.asciidoc +++ b/docs/reference/sql/endpoints/client-apps/workbench.asciidoc @@ -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[] \ No newline at end of file +image:images/sql/client-apps/workbench-4-data.png[] diff --git a/docs/reference/sql/endpoints/jdbc.asciidoc b/docs/reference/sql/endpoints/jdbc.asciidoc index 1a5b45f1a0f..47e5e465e06 100644 --- a/docs/reference/sql/endpoints/jdbc.asciidoc +++ b/docs/reference/sql/endpoints/jdbc.asciidoc @@ -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}. diff --git a/docs/reference/sql/endpoints/rest.asciidoc b/docs/reference/sql/endpoints/rest.asciidoc index 15e31896e11..901d34113ae 100644 --- a/docs/reference/sql/endpoints/rest.asciidoc +++ b/docs/reference/sql/endpoints/rest.asciidoc @@ -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: diff --git a/docs/reference/sql/endpoints/translate.asciidoc b/docs/reference/sql/endpoints/translate.asciidoc index 7c6ad7de14b..2bb7bfae4d2 100644 --- a/docs/reference/sql/endpoints/translate.asciidoc +++ b/docs/reference/sql/endpoints/translate.asciidoc @@ -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: diff --git a/docs/reference/sql/functions/aggs.asciidoc b/docs/reference/sql/functions/aggs.asciidoc index c2d485dbe6a..c64417cae07 100644 --- a/docs/reference/sql/functions/aggs.asciidoc +++ b/docs/reference/sql/functions/aggs.asciidoc @@ -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 <> (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] ----- \ No newline at end of file +---- diff --git a/docs/reference/sql/functions/conditional.asciidoc b/docs/reference/sql/functions/conditional.asciidoc index c4947c713e2..dd5de6d58e8 100644 --- a/docs/reference/sql/functions/conditional.asciidoc +++ b/docs/reference/sql/functions/conditional.asciidoc @@ -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]] diff --git a/docs/reference/sql/functions/date-time.asciidoc b/docs/reference/sql/functions/date-time.asciidoc index f0d90cbb07e..51d11c296d6 100644 --- a/docs/reference/sql/functions/date-time.asciidoc +++ b/docs/reference/sql/functions/date-time.asciidoc @@ -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] --------------------------------------------------- \ No newline at end of file +-------------------------------------------------- diff --git a/docs/reference/sql/functions/index.asciidoc b/docs/reference/sql/functions/index.asciidoc index 40d4e344a52..552a70955cf 100644 --- a/docs/reference/sql/functions/index.asciidoc +++ b/docs/reference/sql/functions/index.asciidoc @@ -3,6 +3,8 @@ [[sql-functions]] == Functions and Operators +beta[] + {es-sql} provides a comprehensive set of built-in operators and functions: * <> diff --git a/docs/reference/sql/functions/math.asciidoc b/docs/reference/sql/functions/math.asciidoc index 975feac7429..2ad40a17de8 100644 --- a/docs/reference/sql/functions/math.asciidoc +++ b/docs/reference/sql/functions/math.asciidoc @@ -3,6 +3,8 @@ [[sql-functions-math]] === Math Functions +beta[] + All math and trigonometric functions require their input (where applicable) to be numeric. diff --git a/docs/reference/sql/functions/operators.asciidoc b/docs/reference/sql/functions/operators.asciidoc index 81b0963fd59..7eb0b3e08f4 100644 --- a/docs/reference/sql/functions/operators.asciidoc +++ b/docs/reference/sql/functions/operators.asciidoc @@ -3,6 +3,8 @@ [[sql-operators]] === Comparison Operators +beta[] + Boolean operator for comparing against one or multiple expressions. * Equality (`=`) diff --git a/docs/reference/sql/functions/search.asciidoc b/docs/reference/sql/functions/search.asciidoc index 564f57dcbdd..c6284b27411 100644 --- a/docs/reference/sql/functions/search.asciidoc +++ b/docs/reference/sql/functions/search.asciidoc @@ -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] ----- \ No newline at end of file +---- diff --git a/docs/reference/sql/functions/string.asciidoc b/docs/reference/sql/functions/string.asciidoc index 04b2937e6f9..a2832b5525d 100644 --- a/docs/reference/sql/functions/string.asciidoc +++ b/docs/reference/sql/functions/string.asciidoc @@ -3,6 +3,8 @@ [[sql-functions-string]] === String Functions +beta[] + Functions for performing string manipulation. [[sql-functions-string-ascii]] diff --git a/docs/reference/sql/functions/system.asciidoc b/docs/reference/sql/functions/system.asciidoc index d2918043b44..82182339d53 100644 --- a/docs/reference/sql/functions/system.asciidoc +++ b/docs/reference/sql/functions/system.asciidoc @@ -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]] diff --git a/docs/reference/sql/functions/type-conversion.asciidoc b/docs/reference/sql/functions/type-conversion.asciidoc index 7075e7f2846..3ff0bfed242 100644 --- a/docs/reference/sql/functions/type-conversion.asciidoc +++ b/docs/reference/sql/functions/type-conversion.asciidoc @@ -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]] diff --git a/docs/reference/sql/getting-started.asciidoc b/docs/reference/sql/getting-started.asciidoc index 3ce7b6ebdf3..96cd3433099 100644 --- a/docs/reference/sql/getting-started.asciidoc +++ b/docs/reference/sql/getting-started.asciidoc @@ -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: diff --git a/docs/reference/sql/index.asciidoc b/docs/reference/sql/index.asciidoc index 65e5313de4a..3c9b628a14d 100644 --- a/docs/reference/sql/index.asciidoc +++ b/docs/reference/sql/index.asciidoc @@ -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. diff --git a/docs/reference/sql/language/data-types.asciidoc b/docs/reference/sql/language/data-types.asciidoc index 9cf9c4eed62..0b2384de1ff 100644 --- a/docs/reference/sql/language/data-types.asciidoc +++ b/docs/reference/sql/language/data-types.asciidoc @@ -3,6 +3,8 @@ [[sql-data-types]] == Data Types +beta[] + Most of {es} <> are available in {es-sql}, as indicated below: [cols="^,^,^",options="header"] diff --git a/docs/reference/sql/language/index-patterns.asciidoc b/docs/reference/sql/language/index-patterns.asciidoc index 655ab575c1a..bc2352d3854 100644 --- a/docs/reference/sql/language/index-patterns.asciidoc +++ b/docs/reference/sql/language/index-patterns.asciidoc @@ -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 diff --git a/docs/reference/sql/language/index.asciidoc b/docs/reference/sql/language/index.asciidoc index f63afd6ebd8..df0cd9359aa 100644 --- a/docs/reference/sql/language/index.asciidoc +++ b/docs/reference/sql/language/index.asciidoc @@ -3,6 +3,8 @@ [[sql-spec]] == SQL Language +beta[] + This chapter describes the SQL semantics supported in X-Pack namely: <>:: Data types diff --git a/docs/reference/sql/language/syntax/describe-table.asciidoc b/docs/reference/sql/language/syntax/describe-table.asciidoc index ebefe9bc34b..ac07b35ac33 100644 --- a/docs/reference/sql/language/syntax/describe-table.asciidoc +++ b/docs/reference/sql/language/syntax/describe-table.asciidoc @@ -3,6 +3,8 @@ [[sql-syntax-describe-table]] === DESCRIBE TABLE +beta[] + .Synopsis [source, sql] ---- diff --git a/docs/reference/sql/language/syntax/index.asciidoc b/docs/reference/sql/language/syntax/index.asciidoc index 4af8f19d703..fd20af5c8ff 100644 --- a/docs/reference/sql/language/syntax/index.asciidoc +++ b/docs/reference/sql/language/syntax/index.asciidoc @@ -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: <>:: Describe a table. diff --git a/docs/reference/sql/language/syntax/select.asciidoc b/docs/reference/sql/language/syntax/select.asciidoc index d1df5934678..d82a5b95b87 100644 --- a/docs/reference/sql/language/syntax/select.asciidoc +++ b/docs/reference/sql/language/syntax/select.asciidoc @@ -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] ----- \ No newline at end of file +---- diff --git a/docs/reference/sql/language/syntax/show-columns.asciidoc b/docs/reference/sql/language/syntax/show-columns.asciidoc index 92743000362..754ce7d6f43 100644 --- a/docs/reference/sql/language/syntax/show-columns.asciidoc +++ b/docs/reference/sql/language/syntax/show-columns.asciidoc @@ -3,6 +3,8 @@ [[sql-syntax-show-columns]] === SHOW COLUMNS +beta[] + .Synopsis [source, sql] ---- diff --git a/docs/reference/sql/language/syntax/show-functions.asciidoc b/docs/reference/sql/language/syntax/show-functions.asciidoc index d77aa008586..4f9207a045e 100644 --- a/docs/reference/sql/language/syntax/show-functions.asciidoc +++ b/docs/reference/sql/language/syntax/show-functions.asciidoc @@ -3,6 +3,8 @@ [[sql-syntax-show-functions]] === SHOW FUNCTIONS +beta[] + .Synopsis [source, sql] ---- diff --git a/docs/reference/sql/language/syntax/show-tables.asciidoc b/docs/reference/sql/language/syntax/show-tables.asciidoc index 5748ae31806..10934e25373 100644 --- a/docs/reference/sql/language/syntax/show-tables.asciidoc +++ b/docs/reference/sql/language/syntax/show-tables.asciidoc @@ -3,6 +3,8 @@ [[sql-syntax-show-tables]] === SHOW TABLES +beta[] + .Synopsis [source, sql] ---- diff --git a/docs/reference/sql/overview.asciidoc b/docs/reference/sql/overview.asciidoc index 3da070a447a..814742b5f78 100644 --- a/docs/reference/sql/overview.asciidoc +++ b/docs/reference/sql/overview.asciidoc @@ -3,6 +3,8 @@ [[sql-overview]] == Overview +beta[] + {es-sql} aims to provide a powerful yet lightweight SQL interface to {es}. [[sql-introduction]] diff --git a/docs/reference/sql/security.asciidoc b/docs/reference/sql/security.asciidoc index a317355866b..fa370b00807 100644 --- a/docs/reference/sql/security.asciidoc +++ b/docs/reference/sql/security.asciidoc @@ -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).