From 1ba3eb31080ca1125a2c5d24a4ddccf7f9c86262 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 29 Apr 2024 14:37:31 +0200 Subject: [PATCH] [DOCS] Adds the structure of the ES|QL docs. --- docs/usage/esql.asciidoc | 35 +++++++++++++++++++++++++++++++++++ docs/usage/index.asciidoc | 2 ++ 2 files changed, 37 insertions(+) create mode 100644 docs/usage/esql.asciidoc diff --git a/docs/usage/esql.asciidoc b/docs/usage/esql.asciidoc new file mode 100644 index 000000000..98ec699c6 --- /dev/null +++ b/docs/usage/esql.asciidoc @@ -0,0 +1,35 @@ +[discrete] +[[esql]] +=== ES|QL in the Java client + +This page enables you to understand and use {ref}/esql.html[ES|QL] utilizing the +Java client. + + +[discrete] +[[esql-how-to]] +==== How to use the ES|QL API + +[TO DO] + +// This section describes the use of the "raw" ES|QL API. + + +[discrete] +[[esql-consume-results]] +==== Consuming ES|QL results + +[TO DO] + +// This section demonstrates the various ways to consume ES|QL results (Object, +// Cursor, DataFrame, etc.). + + +[discrete] +[[esql-custom-mapping]] +==== Defining your own mapping + +[TO DO] + +// This section describes how to come up with your own way of consuming ES|QL +// results. \ No newline at end of file diff --git a/docs/usage/index.asciidoc b/docs/usage/index.asciidoc index c71aa34f3..854ef8ab4 100644 --- a/docs/usage/index.asciidoc +++ b/docs/usage/index.asciidoc @@ -7,6 +7,7 @@ For a full reference, see the {es-docs}/[Elasticsearch documentation] and in par If you're new to Elasticsearch, make sure also to read {es-docs}/getting-started.html[Elasticsearch's quick start] that provides a good introduction. +* <> * <> * <> * <> @@ -19,6 +20,7 @@ If you're new to Elasticsearch, make sure also to read {es-docs}/getting-started NOTE: This is still a work in progress, more sections will be added in the near future. +include::esql.asciidoc[] include::indexing.asciidoc[] include::indexing-bulk.asciidoc[] include::reading.asciidoc[]