Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Adds the structure of the ES|QL docs #789

Merged
merged 14 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
34 changes: 34 additions & 0 deletions docs/usage/esql.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[[esql]]
=== ES|QL in the Java client

This page enables you to understand and use {ref}/esql.html[ES|QL] utilizing the
szabosteve marked this conversation as resolved.
Show resolved Hide resolved
Java client.
szabosteve marked this conversation as resolved.
Show resolved Hide resolved
szabosteve marked this conversation as resolved.
Show resolved Hide resolved


szabosteve marked this conversation as resolved.
Show resolved Hide resolved
[discrete]
[[esql-how-to]]
==== How to use the ES|QL API

[TO DO]
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

// This section describes the use of the "raw" ES|QL API.
szabosteve marked this conversation as resolved.
Show resolved Hide resolved


[discrete]
[[esql-consume-results]]
==== Consuming ES|QL results
szabosteve marked this conversation as resolved.
Show resolved Hide resolved
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

[TO DO]
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

// This section demonstrates the various ways to consume ES|QL results (Object,
// Cursor, DataFrame, etc.).


[discrete]
[[esql-custom-mapping]]
==== Defining your own mapping
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

[TO DO]
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

// 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
Loading