bump 9.0.0 alpha.3 (#2591)
This commit is contained in:
@ -1,10 +1,10 @@
|
|||||||
[[bulk_examples]]
|
[[bulk_examples]]
|
||||||
=== Bulk
|
=== Bulk
|
||||||
|
|
||||||
With the {jsclient}/api-reference.html#_bulk[`bulk` API], you can perform multiple index/delete operations in a
|
With the {jsclient}/api-reference.html#_bulk[`bulk` API], you can perform multiple index/delete operations in a
|
||||||
single API call. The `bulk` API significantly increases indexing speed.
|
single API call. The `bulk` API significantly increases indexing speed.
|
||||||
|
|
||||||
NOTE: You can also use the {jsclient}/client-helpers.html[bulk helper].
|
NOTE: You can also use the <<bulk-helper,bulk helper>>.
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
----
|
----
|
||||||
|
|||||||
@ -6,7 +6,7 @@ Check that the document `/game-of-thrones/1` exists.
|
|||||||
NOTE: Since this API uses the `HEAD` method, the body value will be boolean.
|
NOTE: Since this API uses the `HEAD` method, the body value will be boolean.
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
---------
|
----
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const { Client } = require('@elastic/elasticsearch')
|
const { Client } = require('@elastic/elasticsearch')
|
||||||
@ -34,4 +34,4 @@ async function run () {
|
|||||||
}
|
}
|
||||||
|
|
||||||
run().catch(console.log)
|
run().catch(console.log)
|
||||||
---------
|
----
|
||||||
|
|||||||
@ -1,12 +1,12 @@
|
|||||||
[[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
|
||||||
`game-of-thrones`, under a type called `_doc`, with id valued `'1'`.
|
`game-of-thrones`, under a type called `_doc`, with id valued `'1'`.
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
---------
|
----
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const { Client } = require('@elastic/elasticsearch')
|
const { Client } = require('@elastic/elasticsearch')
|
||||||
@ -34,4 +34,4 @@ async function run () {
|
|||||||
}
|
}
|
||||||
|
|
||||||
run().catch(console.log)
|
run().catch(console.log)
|
||||||
---------
|
----
|
||||||
|
|||||||
@ -62,4 +62,4 @@ async function run () {
|
|||||||
}
|
}
|
||||||
|
|
||||||
run().catch(console.log)
|
run().catch(console.log)
|
||||||
----
|
----
|
||||||
|
|||||||
@ -1,25 +1,25 @@
|
|||||||
[[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
|
||||||
search request, in much the same way as you would use a cursor on a traditional
|
search request, in much the same way as you would use a cursor on a traditional
|
||||||
database.
|
database.
|
||||||
|
|
||||||
Scrolling is not intended for real time user requests, but rather for processing
|
Scrolling is not intended for real time user requests, but rather for processing
|
||||||
large amounts of data, for example in order to reindex the contents of one index
|
large amounts of data, for example in order to reindex the contents of one index
|
||||||
into a new index with a different configuration.
|
into a new index with a different configuration.
|
||||||
|
|
||||||
NOTE: The results that are returned from a scroll request reflect the state of
|
NOTE: The results that are returned from a scroll request reflect the state of
|
||||||
the index at the time that the initial search request was made, like a snapshot
|
the index at the time that the initial search request was made, like a snapshot
|
||||||
in time. Subsequent changes to documents (index, update or delete) will only
|
in time. Subsequent changes to documents (index, update or delete) will only
|
||||||
affect later search requests.
|
affect later search requests.
|
||||||
|
|
||||||
In order to use scrolling, the initial search request should specify the scroll
|
In order to use scrolling, the initial search request should specify the scroll
|
||||||
parameter in the query string, which tells {es} how long it should keep the
|
parameter in the query string, which tells {es} how long it should keep the
|
||||||
“search context” alive.
|
“search context” alive.
|
||||||
|
|
||||||
NOTE: Did you know that we provide an helper for sending scroll requests? You can find it {jsclient}/client-helpers.html[here].
|
NOTE: Did you know that we provide an helper for sending scroll requests? You can find it <<scroll-search-helper,here>>.
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
----
|
----
|
||||||
@ -113,7 +113,7 @@ async function run () {
|
|||||||
run().catch(console.log)
|
run().catch(console.log)
|
||||||
----
|
----
|
||||||
|
|
||||||
Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using
|
Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using
|
||||||
async iteration!
|
async iteration!
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
|
|||||||
@ -1,12 +1,12 @@
|
|||||||
[[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
|
||||||
a character has said the given quote, and then we will update the `times` field.
|
a character has said the given quote, and then we will update the `times` field.
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
---------
|
----
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const { Client } = require('@elastic/elasticsearch')
|
const { Client } = require('@elastic/elasticsearch')
|
||||||
@ -48,12 +48,12 @@ async function run () {
|
|||||||
|
|
||||||
run().catch(console.log)
|
run().catch(console.log)
|
||||||
|
|
||||||
---------
|
----
|
||||||
|
|
||||||
With the update API, you can also run a partial update of a document.
|
With the update API, you can also run a partial update of a document.
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
---------
|
----
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const { Client } = require('@elastic/elasticsearch')
|
const { Client } = require('@elastic/elasticsearch')
|
||||||
@ -92,4 +92,4 @@ async function run () {
|
|||||||
run().catch(console.log)
|
run().catch(console.log)
|
||||||
|
|
||||||
|
|
||||||
---------
|
----
|
||||||
|
|||||||
@ -1,12 +1,12 @@
|
|||||||
[[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
|
||||||
property or some other online mapping change.
|
property or some other online mapping change.
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
---------
|
----
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const { Client } = require('@elastic/elasticsearch')
|
const { Client } = require('@elastic/elasticsearch')
|
||||||
@ -57,4 +57,4 @@ async function run () {
|
|||||||
|
|
||||||
run().catch(console.log)
|
run().catch(console.log)
|
||||||
|
|
||||||
---------
|
----
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@elastic/elasticsearch",
|
"name": "@elastic/elasticsearch",
|
||||||
"version": "9.0.0-alpha.2",
|
"version": "9.0.0-alpha.3",
|
||||||
"versionCanary": "9.0.0-canary.0",
|
"versionCanary": "9.0.0-canary.0",
|
||||||
"description": "The official Elasticsearch client for Node.js",
|
"description": "The official Elasticsearch client for Node.js",
|
||||||
"main": "./index.js",
|
"main": "./index.js",
|
||||||
|
|||||||
Reference in New Issue
Block a user