Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/reference/sql/appendix/syntax-reserved.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 0 additions & 4 deletions docs/reference/sql/concepts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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:
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/cli.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/client-apps/dbeaver.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/client-apps/dbvis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/client-apps/excel.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/client-apps/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
4 changes: 1 addition & 3 deletions docs/reference/sql/endpoints/client-apps/microstrat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
+
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/client-apps/powerbi.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/client-apps/ps1.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 1 addition & 3 deletions docs/reference/sql/endpoints/client-apps/qlik.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
+
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/client-apps/squirrel.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 [...].
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/client-apps/tableau.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/client-apps/workbench.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 0 additions & 4 deletions docs/reference/sql/endpoints/jdbc.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down Expand Up @@ -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`
Expand Down
9 changes: 2 additions & 7 deletions docs/reference/sql/endpoints/odbc.asciidoc
Original file line number Diff line number Diff line change
@@ -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"]
Expand All @@ -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}.

Expand Down
12 changes: 5 additions & 7 deletions docs/reference/sql/endpoints/odbc/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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]]
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
8 changes: 3 additions & 5 deletions docs/reference/sql/endpoints/odbc/installation.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/rest.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/endpoints/translate.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/functions/aggs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/functions/conditional.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down
4 changes: 1 addition & 3 deletions docs/reference/sql/functions/date-time.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down Expand Up @@ -91,7 +89,7 @@ include-tagged::{sql-specs}/docs.csv-spec[dtIntervalMul]

==== Functions

beta[]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the problem. You have two headings of the same level with no content between them. Something needs to go in this space here. When I put a comment here: //comment, the docs built for me.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cheers!

Functions that target date/time.

[[sql-functions-current-date]]
==== `CURRENT_DATE/CURDATE`
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/functions/grouping.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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>>.

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/functions/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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>>
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/functions/math.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
[[sql-functions-math]]
=== Math Functions

beta[]

All math and trigonometric functions require their input (where applicable)
to be numeric.

Expand Down
6 changes: 0 additions & 6 deletions docs/reference/sql/functions/operators.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
[[sql-operators]]
=== Comparison Operators

beta[]

Boolean operator for comparing against one or multiple expressions.

* Equality (`=`)
Expand Down Expand Up @@ -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`
Expand All @@ -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.

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/functions/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/sql/functions/string.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
[[sql-functions-string]]
=== String Functions

beta[]

Functions for performing string manipulation.

[[sql-functions-string-ascii]]
Expand Down
Loading