[DOCS] Rearranges Examples section in Node.JS book (#1425)
This commit is contained in:
committed by
GitHub
parent
7a3cfe7e23
commit
9fa1e12bd3
@ -1,5 +1,5 @@
|
|||||||
[[as_stream_examples]]
|
[[as_stream_examples]]
|
||||||
== asStream
|
=== asStream
|
||||||
|
|
||||||
Instead of getting the parsed body back, you will get the raw Node.js stream of
|
Instead of getting the parsed body back, you will get the raw Node.js stream of
|
||||||
data.
|
data.
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[bulk_examples]]
|
[[bulk_examples]]
|
||||||
== Bulk
|
=== Bulk
|
||||||
|
|
||||||
The `bulk` API makes it possible to perform many index/delete operations in a
|
The `bulk` API makes it possible to perform many index/delete operations in a
|
||||||
single API call. This can greatly increase the indexing speed.
|
single API call. This can greatly increase the indexing speed.
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[exists_examples]]
|
[[exists_examples]]
|
||||||
== Exists
|
=== Exists
|
||||||
|
|
||||||
Check that the document `/game-of-thrones/1` exists.
|
Check that the document `/game-of-thrones/1` exists.
|
||||||
|
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[get_examples]]
|
[[get_examples]]
|
||||||
== Get
|
=== Get
|
||||||
|
|
||||||
The get API allows to get a typed JSON document from the index based on its id.
|
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
|
The following example gets a JSON document from an index called
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[ignore_examples]]
|
[[ignore_examples]]
|
||||||
== Ignore
|
=== Ignore
|
||||||
|
|
||||||
HTTP status codes which should not be considered errors for this request.
|
HTTP status codes which should not be considered errors for this request.
|
||||||
|
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[examples]]
|
[[examples]]
|
||||||
= Examples
|
== Examples
|
||||||
|
|
||||||
Following you can find some examples on how to use the client.
|
Following you can find some examples on how to use the client.
|
||||||
|
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[msearch_examples]]
|
[[msearch_examples]]
|
||||||
== MSearch
|
=== MSearch
|
||||||
|
|
||||||
The multi search API allows to execute several search requests within the same
|
The multi search API allows to execute several search requests within the same
|
||||||
API.
|
API.
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[reindex_examples]]
|
[[reindex_examples]]
|
||||||
== Reindex
|
=== Reindex
|
||||||
|
|
||||||
The `reindex` API extracts the document source from the source index and indexes
|
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
|
the documents into the destination index. You can copy all documents to the
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[scroll_examples]]
|
[[scroll_examples]]
|
||||||
== Scroll
|
=== Scroll
|
||||||
|
|
||||||
While a search request returns a single “page” of results, the scroll API can be
|
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
|
used to retrieve large numbers of results (or even all results) from a single
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[search_examples]]
|
[[search_examples]]
|
||||||
== Search
|
=== Search
|
||||||
|
|
||||||
The `search` API allows you to execute a search query and get back search hits
|
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
|
that match the query. The query can either be provided using a simple
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[sql_query_examples]]
|
[[sql_query_examples]]
|
||||||
== SQL
|
=== SQL
|
||||||
|
|
||||||
{es} SQL is an X-Pack component that allows SQL-like queries to be executed in
|
{es} SQL is an X-Pack component that allows SQL-like queries to be executed in
|
||||||
real-time against {es}. Whether using the REST interface, command-line or JDBC,
|
real-time against {es}. Whether using the REST interface, command-line or JDBC,
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[suggest_examples]]
|
[[suggest_examples]]
|
||||||
== Suggest
|
=== Suggest
|
||||||
|
|
||||||
The suggest feature suggests similar looking terms based on a provided text by
|
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._
|
using a suggester. _Parts of the suggest feature are still under development._
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[transport_request_examples]]
|
[[transport_request_examples]]
|
||||||
== transport.request
|
=== transport.request
|
||||||
|
|
||||||
It can happen that you need to communicate with {es} by using an API that is not
|
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
|
supported by the client, to mitigate this issue you can directly call
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[typescript_examples]]
|
[[typescript_examples]]
|
||||||
== Typescript
|
=== Typescript
|
||||||
|
|
||||||
The client offers a first-class support for TypeScript, since it ships the type
|
The client offers a first-class support for TypeScript, since it ships the type
|
||||||
definitions for every exposed API.
|
definitions for every exposed API.
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[update_examples]]
|
[[update_examples]]
|
||||||
== Update
|
=== Update
|
||||||
|
|
||||||
The update API allows updates of a specific document using the given script. In
|
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
|
the following example, we will index a document that also tracks how many times
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[[update_by_query_examples]]
|
[[update_by_query_examples]]
|
||||||
== Update By Query
|
=== Update By Query
|
||||||
|
|
||||||
The simplest usage of _update_by_query just performs an update on every document
|
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
|
in the index without changing the source. This is useful to pick up a new
|
||||||
|
|||||||
@ -17,6 +17,6 @@ include::observability.asciidoc[]
|
|||||||
include::transport.asciidoc[]
|
include::transport.asciidoc[]
|
||||||
include::typescript.asciidoc[]
|
include::typescript.asciidoc[]
|
||||||
include::reference.asciidoc[]
|
include::reference.asciidoc[]
|
||||||
|
include::examples/index.asciidoc[]
|
||||||
include::breaking-changes.asciidoc[]
|
include::breaking-changes.asciidoc[]
|
||||||
include::helpers.asciidoc[]
|
include::helpers.asciidoc[]
|
||||||
include::examples/index.asciidoc[]
|
|
||||||
|
|||||||
Reference in New Issue
Block a user