mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-25 06:16:40 +00:00
SQL: remove beta marker from documentation (#38661)
(cherry picked from commit fb6e7a30c9eed1e8b83496aaf1efe7e2288f9dd8)
This commit is contained in:
Costin Leau
Costin Leau
parent
56edc8e37f
commit
5b112b1d9d
@ -3,8 +3,6 @@
|
||||
[[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,8 +3,6 @@
|
||||
[[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).
|
||||
@ -15,8 +13,6 @@ Last but not least, {es-sql} tries to obey the https://en.wikipedia.org/wiki/Pri
|
||||
|
||||
=== Mapping concepts across SQL and {es}
|
||||
|
||||
beta[]
|
||||
|
||||
While SQL and {es} have different terms for the way the data is organized (and different semantics), essentially their purpose is the same.
|
||||
|
||||
So let's start from the bottom; these roughly are:
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-cli]]
|
||||
== SQL CLI
|
||||
|
||||
beta[]
|
||||
|
||||
Elasticsearch ships with a script to run the SQL CLI in its `bin` directory:
|
||||
|
||||
[source,bash]
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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.
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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.
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-client-apps-excel]]
|
||||
=== Microsoft Excel
|
||||
|
||||
experimental[]
|
||||
|
||||
[quote, https://www.techopedia.com/definition/5430/microsoft-excel]
|
||||
____
|
||||
https://products.office.com/en/excel[Microsoft Excel] is a software program [...] that allows users to organize, format and calculate data
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-client-apps]]
|
||||
== SQL Client Applications
|
||||
|
||||
beta[]
|
||||
|
||||
Thanks to its <<sql-jdbc, JDBC>> and <<sql-odbc, ODBC>> interfaces, 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,8 +3,6 @@
|
||||
[[sql-client-apps-microstrat]]
|
||||
=== MicroStrategy Desktop
|
||||
|
||||
experimental[]
|
||||
|
||||
[quote, https://www.microstrategy.com/us/resources/library/videos/new-microstrategy-desktop]
|
||||
____
|
||||
https://www.microstrategy.com/us/get-started/desktop[MicroStrategy Desktop] is a free data discovery tool that helps people bring data to
|
||||
@ -19,7 +17,7 @@ ____
|
||||
|
||||
==== Data loading
|
||||
|
||||
To use the {product} to load data into MicroStrategy Desktop perform the following steps in sequence.
|
||||
To use the {odbc} to load data into MicroStrategy Desktop perform the following steps in sequence.
|
||||
|
||||
. Create a New Dossier
|
||||
+
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-client-apps-powerbi]]
|
||||
=== Microsoft Power BI Desktop
|
||||
|
||||
experimental[]
|
||||
|
||||
[quote, https://powerbi.microsoft.com/en-us/what-is-power-bi/]
|
||||
____
|
||||
https://powerbi.microsoft.com/en-us/desktop/[Power BI] is a business analytics solution that lets you visualize your data and share
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-client-apps-ps1]]
|
||||
=== Microsoft PowerShell
|
||||
|
||||
experimental[]
|
||||
|
||||
[quote, https://docs.microsoft.com/en-us/powershell/scripting/powershell-scripting]
|
||||
____
|
||||
https://docs.microsoft.com/en-us/powershell/[PowerShell] is a task-based command-line shell and scripting language built on .NET.
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-client-apps-qlik]]
|
||||
=== Qlik Sense Desktop
|
||||
|
||||
experimental[]
|
||||
|
||||
[quote, https://help.qlik.com/en-US/sense/February2018/Subsystems/Hub/Content/Introduction/at-a-glance.htm]
|
||||
____
|
||||
https://www.qlik.com/us/try-or-buy/download-qlik-sense[Qlik Sense Desktop] is a Windows application that gives individuals the opportunity
|
||||
@ -20,7 +18,7 @@ ____
|
||||
|
||||
==== Data loading
|
||||
|
||||
To use the {product} to load data into Qlik Sense Desktop perform the following steps in sequence.
|
||||
To use the {odbc} to load data into Qlik Sense Desktop perform the following steps in sequence.
|
||||
|
||||
. Create new app
|
||||
+
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-client-apps-squirrel]]
|
||||
=== SQuirreL SQL
|
||||
|
||||
beta[]
|
||||
|
||||
[quote, http://squirrel-sql.sourceforge.net/]
|
||||
____
|
||||
http://squirrel-sql.sourceforge.net/[SQuirreL SQL] is a graphical, [multi-platform] Java program that will allow you to view the structure of a JDBC compliant database [...].
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-client-apps-tableau]]
|
||||
=== Tableau Desktop
|
||||
|
||||
experimental[]
|
||||
|
||||
[quote, https://www.tableau.com/products/what-is-tableau]
|
||||
____
|
||||
https://www.tableau.com/products/desktop[Tableau] is the most powerful, secure, and flexible end-to-end analytics platform
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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.
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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}.
|
||||
@ -136,8 +134,6 @@ Opens up a {es-sql} connection to `server` on port `3456`, setting the JDBC conn
|
||||
|
||||
=== API usage
|
||||
|
||||
beta[]
|
||||
|
||||
One can use JDBC through the official `java.sql` and `javax.sql` packages:
|
||||
|
||||
==== `java.sql`
|
||||
|
||||
@ -1,7 +1,4 @@
|
||||
:es: Elasticsearch
|
||||
:es-sql: {es} SQL
|
||||
:version: 6.5.0
|
||||
:product: {es-sql} ODBC Driver
|
||||
:odbc: {es-sql} ODBC Driver
|
||||
|
||||
[role="xpack"]
|
||||
[testenv="platinum"]
|
||||
@ -12,9 +9,7 @@
|
||||
[float]
|
||||
=== Overview
|
||||
|
||||
experimental[]
|
||||
|
||||
{product} is a feature-rich 3.80 ODBC driver for {es}.
|
||||
{odbc} is a feature-rich 3.80 ODBC driver for {es}.
|
||||
It is a core level driver, exposing all of the functionality accessible through the {es}'s SQL ODBC API, converting ODBC calls into
|
||||
{es-sql}.
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-odbc-setup]]
|
||||
=== Configuration
|
||||
|
||||
experimental[]
|
||||
|
||||
Once the driver has been installed, in order for an application to be able to connect to {es} through ODBC, a set of configuration parameters must be provided to the driver. Depending on the application, there are generally three ways of providing these parameters:
|
||||
|
||||
* through a connection string;
|
||||
@ -63,7 +61,7 @@ Such a file can be then shared among multiple systems and the user will need to
|
||||
The configuration steps are similar for all the above points. Following is an example of configuring a System DSN.
|
||||
|
||||
[float]
|
||||
===== 2.1 Launch {product} DSN Editor
|
||||
===== 2.1 Launch {odbc} DSN Editor
|
||||
Click on the _System DSN_ tab, then on the _Add..._ button:
|
||||
|
||||
[[system_add]]
|
||||
@ -76,10 +74,10 @@ A new window will open, listing all available installed drivers. Click on _{es}
|
||||
.Launch the DSN Editor
|
||||
image:images/sql/odbc/administrator_launch_editor.png[]
|
||||
|
||||
This action closes the previously opened second window and open a new one instead, {product}'s DSN Editor:
|
||||
This action closes the previously opened second window and open a new one instead, {odbc}'s DSN Editor:
|
||||
|
||||
[[dsn_editor]]
|
||||
.{product} DSN Editor
|
||||
.{odbc} DSN Editor
|
||||
image:images/sql/odbc/dsn_editor_basic.png[]
|
||||
|
||||
This new window has three tabs, each responsible for a set of configuration parameters, as follows.
|
||||
@ -173,7 +171,7 @@ image:images/sql/odbc/dsn_editor_security_cert.png[]
|
||||
|
||||
[float]
|
||||
===== 2.4 Logging parameters
|
||||
For troubleshooting purposes, the {product} offers functionality to log the API calls that an application makes; this is enabled in the Administrator application:
|
||||
For troubleshooting purposes, the {odbc} offers functionality to log the API calls that an application makes; this is enabled in the Administrator application:
|
||||
|
||||
[[administrator_tracing]]
|
||||
.Enable Application ODBC API logging
|
||||
@ -241,7 +239,7 @@ image:images/sql/odbc/administrator_system_added.png[]
|
||||
Due to the specification of the ODBC API, the driver will receive the configured DSN parameters - including the logging ones - only once a
|
||||
connection API is invoked (such as _SQLConnect_ or _SQLDriverConnect_). The _Driver Manager_ will however always make a set of API calls
|
||||
into the driver before attempting to establish a connection. To capture those calls as well, one needs to pass logging configuration
|
||||
parameters in an alternative way. The {product} will use an environment variable for this purpose.
|
||||
parameters in an alternative way. The {odbc} will use an environment variable for this purpose.
|
||||
|
||||
Configuring an environment variable is OS specific and not detailed in this guide. Whether the variable should be configured system-wide
|
||||
or user-specific depends on the way the ODBC-enabled application is being run and if logging should affect the current user only or not.
|
||||
|
||||
@ -3,14 +3,12 @@
|
||||
[[sql-odbc-installation]]
|
||||
=== Driver installation
|
||||
|
||||
experimental[]
|
||||
|
||||
The {product} can be installed on Microsoft Windows using an MSI package. The installation process is simple and is composed of standard MSI wizard steps.
|
||||
The {odbc} can be installed on Microsoft Windows using an MSI package. The installation process is simple and is composed of standard MSI wizard steps.
|
||||
|
||||
[[prerequisites]]
|
||||
==== Installation Prerequisites
|
||||
|
||||
Before you install the {product} you need to meet the following prerequisites;
|
||||
Before you install the {odbc} you need to meet the following prerequisites;
|
||||
|
||||
* Windows 10 64 bit _or_ Windows Server 2016 64 bit operating system
|
||||
* .NET Framework 4.0 full - https://www.microsoft.com/en-au/download/details.aspx?id=17718
|
||||
@ -26,7 +24,7 @@ NOTE: It is not possible to inline upgrade using the MSI. In order to upgrade, y
|
||||
[[download]]
|
||||
==== Download the `.msi` package(s)
|
||||
|
||||
Download the `.msi` package for {product} {version} from:
|
||||
Download the `.msi` package for {odbc} {version} from:
|
||||
https://www.elastic.co/downloads/odbc-client
|
||||
|
||||
There are two versions of the installer available:
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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,8 +3,6 @@
|
||||
[[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,8 +3,6 @@
|
||||
[[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).
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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,8 +3,6 @@
|
||||
[[sql-functions-datetime]]
|
||||
=== Date/Time and Interval Functions and Operators
|
||||
|
||||
beta[]
|
||||
|
||||
{es-sql} offers a wide range of facilities for performing date/time manipulations.
|
||||
|
||||
[[sql-functions-datetime-interval]]
|
||||
@ -91,7 +89,7 @@ include-tagged::{sql-specs}/docs.csv-spec[dtIntervalMul]
|
||||
|
||||
==== Functions
|
||||
|
||||
beta[]
|
||||
Functions that target date/time.
|
||||
|
||||
[[sql-functions-current-date]]
|
||||
==== `CURRENT_DATE/CURDATE`
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-functions-grouping]]
|
||||
=== Grouping Functions
|
||||
|
||||
beta[]
|
||||
|
||||
Functions for creating special __grouping__s (also known as _bucketing_); as such these need to be used
|
||||
as part of the <<sql-syntax-group-by, grouping>>.
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-functions]]
|
||||
== Functions and Operators
|
||||
|
||||
beta[]
|
||||
|
||||
{es-sql} provides a comprehensive set of built-in operators and functions:
|
||||
|
||||
* <<sql-operators, Operators>>
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-functions-math]]
|
||||
=== Math Functions
|
||||
|
||||
beta[]
|
||||
|
||||
All math and trigonometric functions require their input (where applicable)
|
||||
to be numeric.
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-operators]]
|
||||
=== Comparison Operators
|
||||
|
||||
beta[]
|
||||
|
||||
Boolean operator for comparing against one or multiple expressions.
|
||||
|
||||
* Equality (`=`)
|
||||
@ -64,8 +62,6 @@ include-tagged::{sql-specs}/filter.sql-spec[whereWithInAndMultipleValues]
|
||||
[[sql-operators-logical]]
|
||||
=== Logical Operators
|
||||
|
||||
beta[]
|
||||
|
||||
Boolean operator for evaluating one or two expressions.
|
||||
|
||||
* `AND`
|
||||
@ -92,8 +88,6 @@ include-tagged::{sql-specs}/filter.sql-spec[whereFieldEqualityNot]
|
||||
[[sql-operators-math]]
|
||||
=== Math Operators
|
||||
|
||||
beta[]
|
||||
|
||||
Perform mathematical operations affecting one or two values.
|
||||
The result is a value of numeric type.
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-functions-string]]
|
||||
=== String Functions
|
||||
|
||||
beta[]
|
||||
|
||||
Functions for performing string manipulation.
|
||||
|
||||
[[sql-functions-string-ascii]]
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-functions-system]]
|
||||
=== System Functions
|
||||
|
||||
beta[]
|
||||
|
||||
These functions return metadata type of information about the system being queried.
|
||||
|
||||
[[sql-functions-system-database]]
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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,8 +3,6 @@
|
||||
[[sql-getting-started]]
|
||||
== Getting Started with SQL
|
||||
|
||||
beta[]
|
||||
|
||||
To start using {es-sql}, create
|
||||
an index with some data to experiment with:
|
||||
|
||||
|
||||
@ -12,8 +12,6 @@
|
||||
[partintro]
|
||||
--
|
||||
|
||||
beta[]
|
||||
|
||||
X-Pack includes a SQL feature to execute SQL against Elasticsearch
|
||||
indices and return results in tabular format.
|
||||
|
||||
|
||||
@ -3,9 +3,6 @@
|
||||
[[sql-data-types]]
|
||||
== Data Types
|
||||
|
||||
beta[]
|
||||
|
||||
|
||||
[cols="^,^m,^,^"]
|
||||
|
||||
|===
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-index-patterns]]
|
||||
== Index patterns
|
||||
|
||||
beta[]
|
||||
|
||||
{es-sql} supports two types of patterns for matching multiple indices or tables:
|
||||
|
||||
* {es} multi-index
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-spec]]
|
||||
== SQL Language
|
||||
|
||||
beta[]
|
||||
|
||||
This chapter describes the SQL semantics supported in X-Pack namely:
|
||||
|
||||
<<sql-data-types>>:: Data types
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-syntax-describe-table]]
|
||||
=== DESCRIBE TABLE
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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,8 +3,6 @@
|
||||
[[sql-syntax-select]]
|
||||
=== SELECT
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-syntax-show-columns]]
|
||||
=== SHOW COLUMNS
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-syntax-show-functions]]
|
||||
=== SHOW FUNCTIONS
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-syntax-show-tables]]
|
||||
=== SHOW TABLES
|
||||
|
||||
beta[]
|
||||
|
||||
.Synopsis
|
||||
[source, sql]
|
||||
----
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-limitations]]
|
||||
== SQL Limitations
|
||||
|
||||
beta[]
|
||||
|
||||
[float]
|
||||
=== Nested fields in `SYS COLUMNS` and `DESCRIBE TABLE`
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[sql-overview]]
|
||||
== Overview
|
||||
|
||||
beta[]
|
||||
|
||||
{es-sql} aims to provide a powerful yet lightweight SQL interface to {es}.
|
||||
|
||||
[[sql-introduction]]
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
[[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…
x
Reference in New Issue
Block a user