Skip to content

Commit

Permalink
[DOCS] Adds the structure of the ES|QL docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve committed Apr 29, 2024
1 parent fff5381 commit 1ba3eb3
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/usage/esql.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions docs/usage/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

* <<esql>>
* <<indexing>>
* <<indexing-bulk>>
* <<reading>>
Expand All @@ -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[]
Expand Down

0 comments on commit 1ba3eb3

Please sign in to comment.