[DOCS] Rearranges Examples section in Node.JS book (#1425) (#1431)

This commit is contained in:
István Zoltán Szabó
2021-03-29 15:02:59 +02:00
committed by GitHub
parent b53466e41c
commit 3d2720d3c8
17 changed files with 18 additions and 17 deletions

View File

@ -1,5 +1,5 @@
[[as_stream_examples]]
== asStream
=== asStream
Instead of getting the parsed body back, you will get the raw Node.js stream of
data.

View File

@ -1,5 +1,5 @@
[[bulk_examples]]
== Bulk
=== Bulk
The `bulk` API makes it possible to perform many index/delete operations in a
single API call. This can greatly increase the indexing speed.

View File

@ -1,5 +1,5 @@
[[exists_examples]]
== Exists
=== Exists
Check that the document `/game-of-thrones/1` exists.

View File

@ -1,5 +1,5 @@
[[get_examples]]
== Get
=== Get
The get API allows to get a typed JSON document from the index based on its id.
The following example gets a JSON document from an index called

View File

@ -1,5 +1,6 @@
[[ignore_examples]]
== Ignore
=== Ignore
HTTP status codes which should not be considered errors for this request.
[source,js]

View File

@ -1,5 +1,5 @@
[[examples]]
= Examples
== Examples
Following you can find some examples on how to use the client.

View File

@ -1,5 +1,5 @@
[[msearch_examples]]
== MSearch
=== MSearch
The multi search API allows to execute several search requests within the same
API.

View File

@ -1,5 +1,5 @@
[[reindex_examples]]
== Reindex
=== Reindex
The `reindex` API extracts the document source from the source index and indexes the documents into the destination index. You can copy all documents to the destination index, reindex a subset of the documents or update the source before to reindex it.

View File

@ -1,5 +1,5 @@
[[scroll_examples]]
== Scroll
=== Scroll
While a search request returns a single “page” of results, the scroll API can be
used to retrieve large numbers of results (or even all results) from a single

View File

@ -1,5 +1,5 @@
[[search_examples]]
== Search
=== Search
The `search` API allows you to execute a search query and get back search hits
that match the query. The query can either be provided using a simple

View File

@ -1,5 +1,5 @@
[[sql_query_examples]]
== SQL
=== SQL
Elasticsearch SQL is an X-Pack component that allows SQL-like queries to be executed in real-time against Elasticsearch. Whether using the REST interface, command-line or JDBC, any client can use SQL to search and aggregate data natively inside Elasticsearch. One can think of Elasticsearch SQL as a translator, one that understands both SQL and Elasticsearch and makes it easy to read and process data in real-time, at scale by leveraging Elasticsearch capabilities.

View File

@ -1,5 +1,5 @@
[[suggest_examples]]
== Suggest
=== Suggest
The suggest feature suggests similar looking terms based on a provided text by
using a suggester. _Parts of the suggest feature are still under development._

View File

@ -1,5 +1,5 @@
[[transport_request_examples]]
== transport.request
=== transport.request
It can happen that you need to communicate with {es} by using an API that is not
supported by the client, to mitigate this issue you can directly call

View File

@ -1,5 +1,5 @@
[[typescript_examples]]
== Typescript
=== Typescript
The client offers a first-class support for TypeScript, since it ships the type
definitions for every exposed API.

View File

@ -1,5 +1,5 @@
[[update_examples]]
== Update
=== Update
The update API allows updates of a specific document using the given script. +
In the following example, we will index a document that also tracks how many times a character has said the given quote, and then we will update the `times` field.

View File

@ -1,5 +1,5 @@
[[update_by_query_examples]]
== Update By Query
=== Update By Query
The simplest usage of _update_by_query just performs an update on every document in the index without changing the source. This is useful to pick up a new property or some other online mapping change.

View File

@ -18,7 +18,7 @@ include::observability.asciidoc[]
include::transport.asciidoc[]
include::typescript.asciidoc[]
include::reference.asciidoc[]
include::examples/index.asciidoc[]
include::breaking-changes.asciidoc[]
include::helpers.asciidoc[]
include::examples/index.asciidoc[]
include::redirects.asciidoc[]