83a464ac66
* [docs] update readme and examples to use async/await * [apis] regenerate (including updated examples)
2984 lines
105 KiB
Plaintext
2984 lines
105 KiB
Plaintext
[[api-reference-0-90]]
|
|
== 0.90 API
|
|
|
|
|
|
NOTE: At this time, you must opt into the 0.90 API by setting the `apiVersion` config parameter.
|
|
|
|
|
|
[[api-bulk-0-90]]
|
|
=== `bulk`
|
|
|
|
[source,js]
|
|
--------
|
|
client.bulk([params, [callback]])
|
|
--------
|
|
|
|
Perform many index/delete operations in a single API call.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Perform three operations in a single request
|
|
[source,js]
|
|
---------
|
|
client.bulk({
|
|
body: [
|
|
// action description
|
|
{ index: { _index: 'myindex', _type: 'mytype', _id: 1 } },
|
|
// the document to index
|
|
{ title: 'foo' },
|
|
// action description
|
|
{ update: { _index: 'myindex', _type: 'mytype', _id: 2 } },
|
|
// the document to update
|
|
{ doc: { title: 'foo' } },
|
|
// action description
|
|
{ delete: { _index: 'myindex', _type: 'mytype', _id: 3 } },
|
|
// no document needed for this delete
|
|
]
|
|
}, function (err, resp) {
|
|
// ...
|
|
});
|
|
---------
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`consistency`::
|
|
<<api-param-type-string,`String`>> -- Explicit write consistency setting for the operation
|
|
Options:::
|
|
* `"one"`
|
|
* `"quorum"`
|
|
* `"all"`
|
|
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the index after performing the operation
|
|
`[replication=sync]`::
|
|
<<api-param-type-string,`String`>> -- Explicitely set the replication type
|
|
Options:::
|
|
* `"sync"`
|
|
* `"async"`
|
|
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- Default document type for items which don't provide one
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- Default index for items which don't provide one
|
|
`body`::
|
|
<<api-param-type-object-array,`Object[]`>>, <<api-param-type-json-lines,`JSONLines`>> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-clearscroll-0-90]]
|
|
=== `clearScroll`
|
|
|
|
[source,js]
|
|
--------
|
|
client.clearScroll([params, [callback]])
|
|
--------
|
|
|
|
Clear the scroll request created by specifying the scroll parameter to search.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`scrollId`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of scroll IDs to clear
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-count-0-90]]
|
|
=== `count`
|
|
|
|
[source,js]
|
|
--------
|
|
client.count([params, [callback]])
|
|
--------
|
|
|
|
Get the number of documents for the cluster, index, type, or a query.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-count.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Get the number of all documents in the cluster
|
|
[source,js]
|
|
---------
|
|
const { count } = await client.count();
|
|
---------
|
|
|
|
.Get the number of documents in an index
|
|
[source,js]
|
|
---------
|
|
const { count } = await client.count({
|
|
index: 'index_name'
|
|
});
|
|
---------
|
|
|
|
.Get the number of documents matching a query
|
|
[source,js]
|
|
---------
|
|
const { count } = await client.count({
|
|
index: 'index_name',
|
|
body: {
|
|
query: {
|
|
filtered: {
|
|
filter: {
|
|
terms: {
|
|
foo: ['bar']
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`minScore`::
|
|
<<api-param-type-number,`Number`>> -- Include only documents with a specific `_score` value in the result
|
|
`preference`::
|
|
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`source`::
|
|
<<api-param-type-string,`String`>> -- The URL-encoded query definition (instead of using the request body)
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of indices to restrict the results
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of types to restrict the results
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-create-0-90]]
|
|
=== `create`
|
|
|
|
[source,js]
|
|
--------
|
|
client.create([params, [callback]])
|
|
--------
|
|
|
|
Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Create a document
|
|
[source,js]
|
|
---------
|
|
await client.create({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: '1',
|
|
body: {
|
|
title: 'Test 1',
|
|
tags: ['y', 'z'],
|
|
published: true,
|
|
published_at: '2013-01-01',
|
|
counter: 1
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`consistency`::
|
|
<<api-param-type-string,`String`>> -- Explicit write consistency setting for the operation
|
|
Options:::
|
|
* `"one"`
|
|
* `"quorum"`
|
|
* `"all"`
|
|
|
|
`parent`::
|
|
<<api-param-type-string,`String`>> -- ID of the parent document
|
|
`percolate`::
|
|
<<api-param-type-string,`String`>> -- Percolator queries to execute while indexing the document
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the index after performing the operation
|
|
`[replication=sync]`::
|
|
<<api-param-type-string,`String`>> -- Specific replication type
|
|
Options:::
|
|
* `"sync"`
|
|
* `"async"`
|
|
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`timestamp`::
|
|
Timestamp -- Explicit timestamp for the document
|
|
`ttl`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Expiration time for the document
|
|
`version`::
|
|
<<api-param-type-number,`Number`>> -- Explicit version number for concurrency control
|
|
`versionType`::
|
|
<<api-param-type-string,`String`>> -- Specific version type
|
|
Options:::
|
|
* `"internal"`
|
|
* `"external"`
|
|
|
|
`id`::
|
|
<<api-param-type-string,`String`>> -- Document ID
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-delete-0-90]]
|
|
=== `delete`
|
|
|
|
[source,js]
|
|
--------
|
|
client.delete([params, [callback]])
|
|
--------
|
|
|
|
Delete a typed JSON document from a specific index based on its id.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Delete the document `/myindex/mytype/1`
|
|
[source,js]
|
|
---------
|
|
await client.delete({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: '1'
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`consistency`::
|
|
<<api-param-type-string,`String`>> -- Specific write consistency setting for the operation
|
|
Options:::
|
|
* `"one"`
|
|
* `"quorum"`
|
|
* `"all"`
|
|
|
|
`parent`::
|
|
<<api-param-type-string,`String`>> -- ID of parent document
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the index after performing the operation
|
|
`[replication=sync]`::
|
|
<<api-param-type-string,`String`>> -- Specific replication type
|
|
Options:::
|
|
* `"sync"`
|
|
* `"async"`
|
|
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`version`::
|
|
<<api-param-type-number,`Number`>> -- Explicit version number for concurrency control
|
|
`versionType`::
|
|
<<api-param-type-string,`String`>> -- Specific version type
|
|
Options:::
|
|
* `"internal"`
|
|
* `"external"`
|
|
|
|
`id`::
|
|
<<api-param-type-string,`String`>> -- The document ID
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-deletebyquery-0-90]]
|
|
=== `deleteByQuery`
|
|
|
|
[source,js]
|
|
--------
|
|
client.deleteByQuery([params, [callback]])
|
|
--------
|
|
|
|
Delete documents from one or more indices and one or more types based on a query.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Deleting documents with a simple query
|
|
[source,js]
|
|
---------
|
|
await client.deleteByQuery({
|
|
index: 'myindex',
|
|
q: 'test'
|
|
});
|
|
---------
|
|
|
|
.Deleting documents using the Query DSL
|
|
[source,js]
|
|
---------
|
|
await client.deleteByQuery({
|
|
index: 'posts',
|
|
body: {
|
|
query: {
|
|
term: { published: false }
|
|
}
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`analyzer`::
|
|
<<api-param-type-string,`String`>> -- The analyzer to use for the query string
|
|
`consistency`::
|
|
<<api-param-type-string,`String`>> -- Specific write consistency setting for the operation
|
|
Options:::
|
|
* `"one"`
|
|
* `"quorum"`
|
|
* `"all"`
|
|
|
|
`[defaultOperator=OR]`::
|
|
<<api-param-type-string,`String`>> -- The default operator for query string query (AND or OR)
|
|
Options:::
|
|
* `"AND"`
|
|
* `"OR"`
|
|
|
|
`df`::
|
|
<<api-param-type-string,`String`>> -- The field to use as default where no field prefix is given in the query string
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`[replication=sync]`::
|
|
<<api-param-type-string,`String`>> -- Specific replication type
|
|
Options:::
|
|
* `"sync"`
|
|
* `"async"`
|
|
|
|
`q`::
|
|
<<api-param-type-string,`String`>> -- Query in the Lucene query string syntax
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`source`::
|
|
<<api-param-type-string,`String`>> -- The URL-encoded query definition (instead of using the request body)
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of types to restrict the operation
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-exists-0-90]]
|
|
=== `exists`
|
|
|
|
[source,js]
|
|
--------
|
|
client.exists([params, [callback]])
|
|
--------
|
|
|
|
Returns a boolean indicating whether or not a given document exists.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Check that the document `/myindex/mytype/1` exist
|
|
[source,js]
|
|
---------
|
|
const exists = await client.exists({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: 1
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`parent`::
|
|
<<api-param-type-string,`String`>> -- The ID of the parent document
|
|
`preference`::
|
|
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
|
`realtime`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether to perform the operation in realtime or search mode
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the shard containing the document before performing the operation
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`id`::
|
|
<<api-param-type-string,`String`>> -- The document ID
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-explain-0-90]]
|
|
=== `explain`
|
|
|
|
[source,js]
|
|
--------
|
|
client.explain([params, [callback]])
|
|
--------
|
|
|
|
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-explain.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.See how a document is scored against a simple query
|
|
[source,js]
|
|
---------
|
|
const response = await client.explain({
|
|
// the document to test
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: '1',
|
|
|
|
// the query to score it against
|
|
q: 'field:value'
|
|
});
|
|
---------
|
|
|
|
.See how a document is scored against a query written in the Query DSL
|
|
[source,js]
|
|
---------
|
|
const response = await client.explain({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: '1',
|
|
body: {
|
|
query: {
|
|
match: { title: 'test' }
|
|
}
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`analyzeWildcard`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
|
|
`analyzer`::
|
|
<<api-param-type-string,`String`>> -- The analyzer for the query string query
|
|
`[defaultOperator=OR]`::
|
|
<<api-param-type-string,`String`>> -- The default operator for query string query (AND or OR)
|
|
Options:::
|
|
* `"AND"`
|
|
* `"OR"`
|
|
|
|
`df`::
|
|
<<api-param-type-string,`String`>> -- The default field for query string query (default: _all)
|
|
`fields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields to return in the response
|
|
`lenient`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
|
`lowercaseExpandedTerms`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether query terms should be lowercased
|
|
`parent`::
|
|
<<api-param-type-string,`String`>> -- The ID of the parent document
|
|
`preference`::
|
|
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
|
`q`::
|
|
<<api-param-type-string,`String`>> -- Query in the Lucene query string syntax
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`source`::
|
|
<<api-param-type-string,`String`>> -- The URL-encoded query definition (instead of using the request body)
|
|
`_source`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- True or false to return the _source field or not, or a list of fields to return
|
|
`_sourceExclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to exclude from the returned _source field
|
|
`_sourceInclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to extract and return from the _source field
|
|
`id`::
|
|
<<api-param-type-string,`String`>> -- The document ID
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-get-0-90]]
|
|
=== `get`
|
|
|
|
[source,js]
|
|
--------
|
|
client.get([params, [callback]])
|
|
--------
|
|
|
|
Get a typed JSON document from the index based on its id.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Get `/myindex/mytype/1`
|
|
[source,js]
|
|
---------
|
|
const response = await client.get({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: 1
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`fields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields to return in the response
|
|
`parent`::
|
|
<<api-param-type-string,`String`>> -- The ID of the parent document
|
|
`preference`::
|
|
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
|
`realtime`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether to perform the operation in realtime or search mode
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the shard containing the document before performing the operation
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`_source`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- True or false to return the _source field or not, or a list of fields to return
|
|
`_sourceExclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to exclude from the returned _source field
|
|
`_sourceInclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to extract and return from the _source field
|
|
`id`::
|
|
<<api-param-type-string,`String`>> -- The document ID
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-getsource-0-90]]
|
|
=== `getSource`
|
|
|
|
[source,js]
|
|
--------
|
|
client.getSource([params, [callback]])
|
|
--------
|
|
|
|
Get the source of a document by its index, type and id.
|
|
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`parent`::
|
|
<<api-param-type-string,`String`>> -- The ID of the parent document
|
|
`preference`::
|
|
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
|
`realtime`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether to perform the operation in realtime or search mode
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the shard containing the document before performing the operation
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`_source`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- True or false to return the _source field or not, or a list of fields to return
|
|
`_sourceExclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to exclude from the returned _source field
|
|
`_sourceInclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to extract and return from the _source field
|
|
`version`::
|
|
<<api-param-type-number,`Number`>> -- Explicit version number for concurrency control
|
|
`versionType`::
|
|
<<api-param-type-string,`String`>> -- Specific version type
|
|
Options:::
|
|
* `"internal"`
|
|
* `"external"`
|
|
|
|
`id`::
|
|
<<api-param-type-string,`String`>> -- The document ID
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document; use `_all` to fetch the first document matching the ID across all types
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-index-0-90]]
|
|
=== `index`
|
|
|
|
[source,js]
|
|
--------
|
|
client.index([params, [callback]])
|
|
--------
|
|
|
|
Stores a typed JSON document in an index, making it searchable. When the `id` param is not set, a unique id will be auto-generated. When you specify an `id` either a new document will be created, or an existing document will be updated. To enforce "put-if-absent" behavior set the `opType` to `"create"` or use the `create()` method.
|
|
|
|
Optimistic concurrency control is performed, when the `version` argument is specified. By default, no version checks are performed.
|
|
|
|
By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <<api-indices-refresh>>.
|
|
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Create or update a document
|
|
[source,js]
|
|
---------
|
|
const response = await client.index({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: '1',
|
|
body: {
|
|
title: 'Test 1',
|
|
tags: ['y', 'z'],
|
|
published: true,
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`consistency`::
|
|
<<api-param-type-string,`String`>> -- Explicit write consistency setting for the operation
|
|
Options:::
|
|
* `"one"`
|
|
* `"quorum"`
|
|
* `"all"`
|
|
|
|
`[opType=index]`::
|
|
<<api-param-type-string,`String`>> -- Explicit operation type
|
|
Options:::
|
|
* `"index"`
|
|
* `"create"`
|
|
|
|
`parent`::
|
|
<<api-param-type-string,`String`>> -- ID of the parent document
|
|
`percolate`::
|
|
<<api-param-type-string,`String`>> -- Percolator queries to execute while indexing the document
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the index after performing the operation
|
|
`[replication=sync]`::
|
|
<<api-param-type-string,`String`>> -- Specific replication type
|
|
Options:::
|
|
* `"sync"`
|
|
* `"async"`
|
|
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`timestamp`::
|
|
Timestamp -- Explicit timestamp for the document
|
|
`ttl`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Expiration time for the document
|
|
`version`::
|
|
<<api-param-type-number,`Number`>> -- Explicit version number for concurrency control
|
|
`versionType`::
|
|
<<api-param-type-string,`String`>> -- Specific version type
|
|
Options:::
|
|
* `"internal"`
|
|
* `"external"`
|
|
|
|
`id`::
|
|
<<api-param-type-string,`String`>> -- Document ID
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-info-0-90]]
|
|
=== `info`
|
|
|
|
[source,js]
|
|
--------
|
|
client.info([params, [callback]])
|
|
--------
|
|
|
|
Get basic info from the current cluster.
|
|
|
|
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
|
|
[[api-mget-0-90]]
|
|
=== `mget`
|
|
|
|
[source,js]
|
|
--------
|
|
client.mget([params, [callback]])
|
|
--------
|
|
|
|
Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.An array of doc locations. Useful for getting documents from different indices.
|
|
[source,js]
|
|
---------
|
|
const response = await client.mget({
|
|
body: {
|
|
docs: [
|
|
{ _index: 'indexA', _type: 'typeA', _id: '1' },
|
|
{ _index: 'indexB', _type: 'typeB', _id: '1' },
|
|
{ _index: 'indexC', _type: 'typeC', _id: '1' }
|
|
]
|
|
}
|
|
});
|
|
---------
|
|
|
|
.An array of ids. You must also specify the `index` and `type` that apply to all of the ids.
|
|
[source,js]
|
|
---------
|
|
const response = await client.mget({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
body: {
|
|
ids: [1, 2, 3]
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`fields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields to return in the response
|
|
`preference`::
|
|
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
|
`realtime`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether to perform the operation in realtime or search mode
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the shard containing the document before performing the operation
|
|
`_source`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- True or false to return the _source field or not, or a list of fields to return
|
|
`_sourceExclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to exclude from the returned _source field
|
|
`_sourceInclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to extract and return from the _source field
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-mlt-0-90]]
|
|
=== `mlt`
|
|
|
|
[source,js]
|
|
--------
|
|
client.mlt([params, [callback]])
|
|
--------
|
|
|
|
(more like this) Gets more documents that are “like” the document specified using `index`, `type`, and `id`.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-more-like-this.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Search for similar documents using the `title` property of document `myindex/mytype/1`
|
|
[source,js]
|
|
---------
|
|
const response = await client.mlt({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: 1,
|
|
mlt_fields: 'title'
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`boostTerms`::
|
|
<<api-param-type-number,`Number`>> -- The boost factor
|
|
`maxDocFreq`::
|
|
<<api-param-type-number,`Number`>> -- The word occurrence frequency as count: words with higher occurrence in the corpus will be ignored
|
|
`maxQueryTerms`::
|
|
<<api-param-type-number,`Number`>> -- The maximum query terms to be included in the generated query
|
|
`maxWordLen`::
|
|
<<api-param-type-number,`Number`>> -- The minimum length of the word: longer words will be ignored
|
|
`minDocFreq`::
|
|
<<api-param-type-number,`Number`>> -- The word occurrence frequency as count: words with lower occurrence in the corpus will be ignored
|
|
`minTermFreq`::
|
|
<<api-param-type-number,`Number`>> -- The term frequency as percent: terms with lower occurence in the source document will be ignored
|
|
`minWordLen`::
|
|
<<api-param-type-number,`Number`>> -- The minimum length of the word: shorter words will be ignored
|
|
`mltFields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Specific fields to perform the query against
|
|
`percentTermsToMatch`::
|
|
<<api-param-type-number,`Number`>> -- How many terms have to match in order to consider the document a match (default: 0.3)
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`searchFrom`::
|
|
<<api-param-type-number,`Number`>> -- The offset from which to return results
|
|
`searchIndices`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of indices to perform the query against (default: the index containing the document)
|
|
`searchQueryHint`::
|
|
<<api-param-type-string,`String`>> -- The search query hint
|
|
`searchScroll`::
|
|
<<api-param-type-string,`String`>> -- A scroll search request definition
|
|
`searchSize`::
|
|
<<api-param-type-number,`Number`>> -- The number of documents to return (default: 10)
|
|
`searchSource`::
|
|
<<api-param-type-string,`String`>> -- A specific search request definition (instead of using the request body)
|
|
`searchType`::
|
|
<<api-param-type-string,`String`>> -- Specific search type (eg. `dfs_then_fetch`, `count`, etc)
|
|
`searchTypes`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of types to perform the query against (default: the same type as the document)
|
|
`stopWords`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of stop words to be ignored
|
|
`id`::
|
|
<<api-param-type-string,`String`>> -- The document ID
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-msearch-0-90]]
|
|
=== `msearch`
|
|
|
|
[source,js]
|
|
--------
|
|
client.msearch([params, [callback]])
|
|
--------
|
|
|
|
Execute several search requests within the same request.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Perform multiple different searches, the body is made up of meta/data pairs
|
|
[source,js]
|
|
---------
|
|
const response = await client.msearch({
|
|
body: [
|
|
// match all query, on all indices and types
|
|
{},
|
|
{ query: { match_all: {} } },
|
|
|
|
// query_string query, on index/mytype
|
|
{ index: 'myindex', type: 'mytype' },
|
|
{ query: { query_string: { query: '"Test 1"' } } }
|
|
]
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`searchType`::
|
|
<<api-param-type-string,`String`>> -- Search operation type
|
|
Options:::
|
|
* `"query_then_fetch"`
|
|
* `"query_and_fetch"`
|
|
* `"dfs_query_then_fetch"`
|
|
* `"dfs_query_and_fetch"`
|
|
* `"count"`
|
|
* `"scan"`
|
|
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to use as default
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to use as default
|
|
`body`::
|
|
<<api-param-type-object-array,`Object[]`>>, <<api-param-type-json-lines,`JSONLines`>> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-percolate-0-90]]
|
|
=== `percolate`
|
|
|
|
[source,js]
|
|
--------
|
|
client.percolate([params, [callback]])
|
|
--------
|
|
|
|
Match a document against registered percolator queries.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-percolate.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.First, Register queries named “alert-1” and “alert-2” for the “myindex” index
|
|
[source,js]
|
|
---------
|
|
await Promise.all([
|
|
client.index({
|
|
index: 'myindex',
|
|
type: '.percolator',
|
|
id: 'alert-1',
|
|
body: {
|
|
// This query will be run against documents sent to percolate
|
|
query: {
|
|
query_string: {
|
|
query: 'foo'
|
|
}
|
|
}
|
|
}
|
|
}),
|
|
|
|
client.index({
|
|
index: 'myindex',
|
|
type: '.percolator',
|
|
id: 'alert-2',
|
|
body: {
|
|
// This query will also be run against documents sent to percolate
|
|
query: {
|
|
query_string: {
|
|
query: 'bar'
|
|
}
|
|
}
|
|
}
|
|
})
|
|
]);
|
|
---------
|
|
|
|
.Then you can send documents to learn which query `_percolator` queries they match
|
|
[source,js]
|
|
---------
|
|
const response1 = await client.percolate({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
body: {
|
|
doc: {
|
|
title: "Foo"
|
|
}
|
|
}
|
|
});
|
|
|
|
// response1 should look something like
|
|
// {
|
|
// total: 1,
|
|
// matches: [ { _index: 'myindex', _id: 'alert-1' } ]
|
|
// }
|
|
|
|
const response2 = await client.percolate({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
body: {
|
|
doc: {
|
|
title: "Foo Bar"
|
|
}
|
|
}
|
|
});
|
|
|
|
// response2 should look something like
|
|
// {
|
|
// total: 2,
|
|
// matches: [
|
|
// { _index: 'myindex', _id: 'alert-1' },
|
|
// { _index: 'myindex', _id: 'alert-2' }
|
|
// ]
|
|
// }
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`preferLocal`::
|
|
<<api-param-type-boolean,`Boolean`>> -- With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index with a registered percolator query
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The document type
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-ping-0-90]]
|
|
=== `ping`
|
|
|
|
[source,js]
|
|
--------
|
|
client.ping([params, [callback]])
|
|
--------
|
|
|
|
// no description
|
|
|
|
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
|
|
[[api-scroll-0-90]]
|
|
=== `scroll`
|
|
|
|
[source,js]
|
|
--------
|
|
client.scroll([params, [callback]])
|
|
--------
|
|
|
|
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Collect every title in the index that contains the word "test"
|
|
[source,js]
|
|
---------
|
|
var allTitles = [];
|
|
|
|
// first we do a search, and specify a scroll timeout
|
|
client.search({
|
|
index: 'myindex',
|
|
// Set to 30 seconds because we are calling right back
|
|
scroll: '30s',
|
|
search_type: 'scan',
|
|
fields: ['title'],
|
|
q: 'title:test'
|
|
}, function getMoreUntilDone(error, response) {
|
|
// collect the title from each response
|
|
response.hits.hits.forEach(function (hit) {
|
|
allTitles.push(hit.fields.title);
|
|
});
|
|
|
|
if (response.hits.total !== allTitles.length) {
|
|
// now we can call scroll over and over
|
|
client.scroll({
|
|
scrollId: response._scroll_id,
|
|
scroll: '30s'
|
|
}, getMoreUntilDone);
|
|
} else {
|
|
console.log('every "test" title', allTitles);
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`scroll`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify how long a consistent view of the index should be maintained for scrolled search
|
|
`scrollId`::
|
|
<<api-param-type-string,`String`>> -- The scroll ID
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-search-0-90]]
|
|
=== `search`
|
|
|
|
[source,js]
|
|
--------
|
|
client.search([params, [callback]])
|
|
--------
|
|
|
|
Return documents matching a query, aggregations/facets, highlighted snippets, suggestions, and more. Write your queries as either http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-uri-request.html[simple query strings] in the `q` parameter, or by specifying a http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-body.html[full request definition] using the http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html[Elasticsearch Query DSL] in the `body` parameter.
|
|
|
|
TIP: https://github.com/danpaz/bodybuilder[bodybuilder], https://github.com/holidayextras/esq[esq], and https://github.com/fullscale/elastic.js[elastic.js] can be used to make building query bodies easier.
|
|
|
|
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Search with a simple query string query
|
|
[source,js]
|
|
---------
|
|
const response = await client.search({
|
|
index: 'myindex',
|
|
q: 'title:test'
|
|
});
|
|
---------
|
|
|
|
.Passing a full request definition in the Elasticsearch's Query DSL as a `Hash`
|
|
[source,js]
|
|
---------
|
|
const response = await client.search({
|
|
index: 'myindex',
|
|
body: {
|
|
query: {
|
|
match: {
|
|
title: 'test'
|
|
}
|
|
},
|
|
facets: {
|
|
tags: {
|
|
terms: {
|
|
field: 'tags'
|
|
}
|
|
}
|
|
}
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`analyzer`::
|
|
<<api-param-type-string,`String`>> -- The analyzer to use for the query string
|
|
`analyzeWildcard`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether wildcard and prefix queries should be analyzed (default: false)
|
|
`[defaultOperator=OR]`::
|
|
<<api-param-type-string,`String`>> -- The default operator for query string query (AND or OR)
|
|
Options:::
|
|
* `"AND"`
|
|
* `"OR"`
|
|
|
|
`df`::
|
|
<<api-param-type-string,`String`>> -- The field to use as default where no field prefix is given in the query string
|
|
`explain`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether to return detailed information about score computation as part of a hit
|
|
`fields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields to return as part of a hit
|
|
`from`::
|
|
<<api-param-type-number,`Number`>> -- Starting offset (default: 0)
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`indicesBoost`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of index boosts
|
|
`lenient`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
|
`lowercaseExpandedTerms`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether query terms should be lowercased
|
|
`preference`::
|
|
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
|
`q`::
|
|
<<api-param-type-string,`String`>> -- Query in the Lucene query string syntax
|
|
`routing`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of specific routing values
|
|
`scroll`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify how long a consistent view of the index should be maintained for scrolled search
|
|
`searchType`::
|
|
<<api-param-type-string,`String`>> -- Search operation type
|
|
Options:::
|
|
* `"query_then_fetch"`
|
|
* `"query_and_fetch"`
|
|
* `"dfs_query_then_fetch"`
|
|
* `"dfs_query_and_fetch"`
|
|
* `"count"`
|
|
* `"scan"`
|
|
|
|
`size`::
|
|
<<api-param-type-number,`Number`>> -- Number of hits to return (default: 10)
|
|
`sort`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of <field>:<direction> pairs
|
|
`source`::
|
|
<<api-param-type-string,`String`>> -- The URL-encoded request definition using the Query DSL (instead of using request body)
|
|
`_source`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- True or false to return the _source field or not, or a list of fields to return
|
|
`_sourceExclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to exclude from the returned _source field
|
|
`_sourceInclude`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to extract and return from the _source field
|
|
`stats`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Specific 'tag' of the request for logging and statistical purposes
|
|
`suggestField`::
|
|
<<api-param-type-string,`String`>> -- Specify which field to use for suggestions
|
|
`[suggestMode=missing]`::
|
|
<<api-param-type-string,`String`>> -- Specify suggest mode
|
|
Options:::
|
|
* `"missing"`
|
|
* `"popular"`
|
|
* `"always"`
|
|
|
|
`suggestSize`::
|
|
<<api-param-type-number,`Number`>> -- How many suggestions to return in response
|
|
`suggestText`::
|
|
<<api-param-type-string,`String`>> -- The source text for which the suggestions should be returned
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`version`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether to return document version as part of a hit
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-suggest-0-90]]
|
|
=== `suggest`
|
|
|
|
[source,js]
|
|
--------
|
|
client.suggest([params, [callback]])
|
|
--------
|
|
|
|
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Return query terms suggestions (“auto-correction”)
|
|
[source,js]
|
|
---------
|
|
const response = await client.suggest({
|
|
index: 'myindex',
|
|
body: {
|
|
mysuggester: {
|
|
text: 'tset',
|
|
term: {
|
|
field: 'title'
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
// response will be formatted like so:
|
|
//
|
|
// {
|
|
// ...
|
|
// mysuggester: [
|
|
// {
|
|
// text: "tset",
|
|
// ...
|
|
// options: [
|
|
// {
|
|
// text: "test",
|
|
// score: 0.75,
|
|
// freq: 5
|
|
// }
|
|
// ]
|
|
// }
|
|
// ]
|
|
// }
|
|
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`preference`::
|
|
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`source`::
|
|
<<api-param-type-string,`String`>> -- The URL-encoded request definition (instead of using request body)
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-update-0-90]]
|
|
=== `update`
|
|
|
|
[source,js]
|
|
--------
|
|
client.update([params, [callback]])
|
|
--------
|
|
|
|
Update parts of a document. The required body parameter can contain one of two things:
|
|
|
|
* a partial document, which will be merged with the existing one.
|
|
* a `script` which will update the document content
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-update.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Update document title using partial document
|
|
[source,js]
|
|
---------
|
|
const response = await client.update({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: '1',
|
|
body: {
|
|
// put the partial document under the `doc` key
|
|
doc: {
|
|
title: 'Updated'
|
|
}
|
|
}
|
|
})
|
|
---------
|
|
|
|
.Add a tag to document `tags` property using a `script`
|
|
[source,js]
|
|
---------
|
|
const response = await client.update({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: '1',
|
|
body: {
|
|
script: 'ctx._source.tags += tag',
|
|
params: { tag: 'some new tag' }
|
|
}
|
|
});
|
|
---------
|
|
|
|
.Increment a document counter by 1 or initialize it, when the document does not exist
|
|
[source,js]
|
|
---------
|
|
const response = await client.update({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: '777',
|
|
body: {
|
|
script: 'ctx._source.counter += 1',
|
|
upsert: {
|
|
counter: 1
|
|
}
|
|
}
|
|
})
|
|
---------
|
|
|
|
.Delete a document if it's tagged “to-delete”
|
|
[source,js]
|
|
---------
|
|
const response = await client.update({
|
|
index: 'myindex',
|
|
type: 'mytype',
|
|
id: '1',
|
|
body: {
|
|
script: 'ctx._source.tags.contains(tag) ? ctx.op = "delete" : ctx.op = "none"',
|
|
params: {
|
|
tag: 'to-delete'
|
|
}
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`consistency`::
|
|
<<api-param-type-string,`String`>> -- Explicit write consistency setting for the operation
|
|
Options:::
|
|
* `"one"`
|
|
* `"quorum"`
|
|
* `"all"`
|
|
|
|
`fields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields to return in the response
|
|
`lang`::
|
|
<<api-param-type-string,`String`>> -- The script language (default: mvel)
|
|
`parent`::
|
|
<<api-param-type-string,`String`>> -- ID of the parent document
|
|
`percolate`::
|
|
<<api-param-type-string,`String`>> -- Perform percolation during the operation; use specific registered query name, attribute, or wildcard
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the index after performing the operation
|
|
`[replication=sync]`::
|
|
<<api-param-type-string,`String`>> -- Specific replication type
|
|
Options:::
|
|
* `"sync"`
|
|
* `"async"`
|
|
|
|
`retryOnConflict`::
|
|
<<api-param-type-number,`Number`>> -- Specify how many times should the operation be retried when a conflict occurs (default: 0)
|
|
`routing`::
|
|
<<api-param-type-string,`String`>> -- Specific routing value
|
|
`script`::
|
|
<<api-param-type-string,`String`>> -- The URL-encoded script definition (instead of using request body)
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`timestamp`::
|
|
Timestamp -- Explicit timestamp for the document
|
|
`ttl`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Expiration time for the document
|
|
`version`::
|
|
<<api-param-type-number,`Number`>> -- Explicit version number for concurrency control
|
|
`versionType`::
|
|
<<api-param-type-string,`String`>> -- Specific version type
|
|
Options:::
|
|
* `"internal"`
|
|
* `"external"`
|
|
|
|
`id`::
|
|
<<api-param-type-string,`String`>> -- Document ID
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type of the document
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-cluster-getsettings-0-90]]
|
|
=== `cluster.getSettings`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.getSettings([params, [callback]])
|
|
--------
|
|
|
|
Get cluster settings (previously set with `putSettings()`)
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
|
|
[[api-cluster-health-0-90]]
|
|
=== `cluster.health`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.health([params, [callback]])
|
|
--------
|
|
|
|
Get a very simple status on the health of the cluster.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-health.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[level=cluster]`::
|
|
<<api-param-type-string,`String`>> -- Specify the level of detail for returned information
|
|
Options:::
|
|
* `"cluster"`
|
|
* `"indices"`
|
|
* `"shards"`
|
|
|
|
`local`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return local information, do not retrieve the state from master node (default: false)
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout for connection to master node
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`waitForActiveShards`::
|
|
<<api-param-type-number,`Number`>> -- Wait until the specified number of shards is active
|
|
`waitForNodes`::
|
|
<<api-param-type-string,`String`>> -- Wait until the specified number of nodes is available
|
|
`waitForRelocatingShards`::
|
|
<<api-param-type-number,`Number`>> -- Wait until the specified number of relocating shards is finished
|
|
`waitForStatus`::
|
|
<<api-param-type-string,`String`>> -- Wait until cluster is in a specific state
|
|
Options:::
|
|
* `"green"`
|
|
* `"yellow"`
|
|
* `"red"`
|
|
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- Limit the information returned to a specific index
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-cluster-nodehotthreads-0-90]]
|
|
=== `cluster.nodeHotThreads`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.nodeHotThreads([params, [callback]])
|
|
--------
|
|
|
|
Returns information about the hottest threads in the cluster or on a specific node as a String. The information is returned as text, and allows you to understand what are currently the most taxing operations happening in the cluster, for debugging or monitoring purposes.
|
|
|
|
WARNING: This endpoint returns plain text
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Return 10 hottest threads
|
|
[source,js]
|
|
---------
|
|
client.cluster.nodeHotThreads({
|
|
threads: 10
|
|
nodeId: 'mymisbehavingnode',
|
|
maxRetries: 10
|
|
}, function (error, response) {
|
|
console.log(response);
|
|
})
|
|
---------
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`interval`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- The interval for the second sampling of threads
|
|
`snapshots`::
|
|
<<api-param-type-number,`Number`>> -- Number of samples of thread stacktrace (default: 10)
|
|
`threads`::
|
|
<<api-param-type-number,`Number`>> -- Specify the number of threads to provide information for (default: 3)
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The type to sample (default: cpu)
|
|
Options:::
|
|
* `"cpu"`
|
|
* `"wait"`
|
|
* `"block"`
|
|
|
|
`nodeId`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-cluster-nodeinfo-0-90]]
|
|
=== `cluster.nodeInfo`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.nodeInfo([params, [callback]])
|
|
--------
|
|
|
|
Retrieve one or more (or all) of the cluster nodes' information.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Return information about JVM
|
|
[source,js]
|
|
---------
|
|
const response = await client.cluster.nodeInfo({
|
|
jvm: true
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`all`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return all available information
|
|
`clear`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Reset the default settings
|
|
`http`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about HTTP
|
|
`jvm`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the JVM
|
|
`network`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about network
|
|
`os`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the operating system
|
|
`plugin`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about plugins
|
|
`process`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the Elasticsearch process
|
|
`settings`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about node settings
|
|
`threadPool`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the thread pool
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`transport`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about transport
|
|
`nodeId`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-cluster-nodeshutdown-0-90]]
|
|
=== `cluster.nodeShutdown`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.nodeShutdown([params, [callback]])
|
|
--------
|
|
|
|
Shutdown one or more (or all) nodes in the cluster.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-shutdown.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`delay`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Set the delay for the operation (default: 1s)
|
|
`exit`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Exit the JVM as well (default: true)
|
|
`nodeId`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-cluster-nodestats-0-90]]
|
|
=== `cluster.nodeStats`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.nodeStats([params, [callback]])
|
|
--------
|
|
|
|
Retrieve one or more (or all) of the cluster nodes statistics.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`all`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return all available information
|
|
`clear`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Reset the default level of detail
|
|
`fields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields to return detailed information for, when returning the `indices` metric family (supports wildcards)
|
|
`fs`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the filesystem
|
|
`http`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about HTTP
|
|
`indices`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about indices
|
|
`jvm`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the JVM
|
|
`network`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about network
|
|
`os`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the operating system
|
|
`process`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the Elasticsearch process
|
|
`threadPool`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the thread pool
|
|
`transport`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about transport
|
|
`metricFamily`::
|
|
<<api-param-type-string,`String`>> -- Limit the information returned to a certain metric family
|
|
Options:::
|
|
* `"all"`
|
|
* `"fs"`
|
|
* `"http"`
|
|
* `"indices"`
|
|
* `"jvm"`
|
|
* `"network"`
|
|
* `"os"`
|
|
* `"process"`
|
|
* `"thread_pool"`
|
|
* `"transport"`
|
|
|
|
`metric`::
|
|
<<api-param-type-string,`String`>> -- Limit the information returned for `indices` family to a specific metric
|
|
Options:::
|
|
* `"completion"`
|
|
* `"docs"`
|
|
* `"fielddata"`
|
|
* `"filter_cache"`
|
|
* `"flush"`
|
|
* `"get"`
|
|
* `"id_cache"`
|
|
* `"indexing"`
|
|
* `"merges"`
|
|
* `"refresh"`
|
|
* `"search"`
|
|
* `"store"`
|
|
* `"warmer"`
|
|
|
|
`nodeId`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-cluster-pendingtasks-0-90]]
|
|
=== `cluster.pendingTasks`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.pendingTasks([params, [callback]])
|
|
--------
|
|
|
|
// no description
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`local`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return local information, do not retrieve the state from master node (default: false)
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-cluster-putsettings-0-90]]
|
|
=== `cluster.putSettings`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.putSettings([params, [callback]])
|
|
--------
|
|
|
|
Update cluster wide specific settings.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
|
|
[[api-cluster-reroute-0-90]]
|
|
=== `cluster.reroute`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.reroute([params, [callback]])
|
|
--------
|
|
|
|
Explicitly execute a cluster reroute allocation command including specific commands.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`dryRun`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Simulate the operation only and return the resulting state
|
|
`filterMetadata`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Don't return cluster state metadata (default: false)
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-cluster-state-0-90]]
|
|
=== `cluster.state`
|
|
|
|
[source,js]
|
|
--------
|
|
client.cluster.state([params, [callback]])
|
|
--------
|
|
|
|
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-state.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`filterBlocks`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Do not return information about blocks
|
|
`filterIndexTemplates`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Do not return information about index templates
|
|
`filterIndices`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Limit returned metadata information to specific indices
|
|
`filterMetadata`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Do not return information about indices metadata
|
|
`filterNodes`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Do not return information about nodes
|
|
`filterRoutingTable`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Do not return information about shard allocation (`routing_table` and `routing_nodes`)
|
|
`local`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return local information, do not retrieve the state from master node (default: false)
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-analyze-0-90]]
|
|
=== `indices.analyze`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.analyze([params, [callback]])
|
|
--------
|
|
|
|
Perform the analysis process on a text and return the tokens breakdown of the text.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`analyzer`::
|
|
<<api-param-type-string,`String`>> -- The name of the analyzer to use
|
|
`field`::
|
|
<<api-param-type-string,`String`>> -- Use the analyzer configured for this field (instead of passing the analyzer name)
|
|
`filters`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of filters to use for the analysis
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index to scope the operation
|
|
`preferLocal`::
|
|
<<api-param-type-boolean,`Boolean`>> -- With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
|
|
`text`::
|
|
<<api-param-type-string,`String`>> -- The text on which the analysis should be performed (when request body is not used)
|
|
`tokenizer`::
|
|
<<api-param-type-string,`String`>> -- The name of the tokenizer to use for the analysis
|
|
`[format=detailed]`::
|
|
<<api-param-type-string,`String`>> -- Format of the output
|
|
Options:::
|
|
* `"detailed"`
|
|
* `"text"`
|
|
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-clearcache-0-90]]
|
|
=== `indices.clearCache`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.clearCache([params, [callback]])
|
|
--------
|
|
|
|
Clear either all caches or specific cached associated with one ore more indices.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`fieldData`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Clear field data
|
|
`fielddata`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Clear field data
|
|
`fields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields to clear when using the `field_data` parameter (default: all)
|
|
`filter`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Clear filter caches
|
|
`filterCache`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Clear filter caches
|
|
`filterKeys`::
|
|
<<api-param-type-boolean,`Boolean`>> -- A comma-separated list of keys to clear when using the `filter_cache` parameter (default: all)
|
|
`id`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Clear ID caches for parent/child
|
|
`idCache`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Clear ID caches for parent/child
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index name to limit the operation
|
|
`recycler`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Clear the recycler cache
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-close-0-90]]
|
|
=== `indices.close`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.close([params, [callback]])
|
|
--------
|
|
|
|
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
|
|
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-create-0-90]]
|
|
=== `indices.create`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.create([params, [callback]])
|
|
--------
|
|
|
|
Create an index in Elasticsearch.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-delete-0-90]]
|
|
=== `indices.delete`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.delete([params, [callback]])
|
|
--------
|
|
|
|
Delete an index in Elasticsearch
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of indices to delete; use `_all` or empty string to delete all indices
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-deletealias-0-90]]
|
|
=== `indices.deleteAlias`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.deleteAlias([params, [callback]])
|
|
--------
|
|
|
|
Delete a specific alias.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit timestamp for the document
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index with an alias
|
|
`name`::
|
|
<<api-param-type-string,`String`>> -- The name of the alias to be deleted
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-deletemapping-0-90]]
|
|
=== `indices.deleteMapping`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.deleteMapping([params, [callback]])
|
|
--------
|
|
|
|
Delete a mapping (type definition) along with its data.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-mapping.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` for all indices
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The name of the document type to delete
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-deletetemplate-0-90]]
|
|
=== `indices.deleteTemplate`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.deleteTemplate([params, [callback]])
|
|
--------
|
|
|
|
Delete an index template by its name.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`name`::
|
|
<<api-param-type-string,`String`>> -- The name of the template
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-deletewarmer-0-90]]
|
|
=== `indices.deleteWarmer`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.deleteWarmer([params, [callback]])
|
|
--------
|
|
|
|
Delete an index warmer.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to register warmer for; use `_all` or empty string to perform the operation on all indices
|
|
`name`::
|
|
<<api-param-type-string,`String`>> -- The name of the warmer (supports wildcards); leave empty to delete all warmers
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to register warmer for; use `_all` or empty string to perform the operation on all types
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-exists-0-90]]
|
|
=== `indices.exists`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.exists([params, [callback]])
|
|
--------
|
|
|
|
Return a boolean indicating whether given index exists.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of indices to check
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-settings.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-existsalias-0-90]]
|
|
=== `indices.existsAlias`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.existsAlias([params, [callback]])
|
|
--------
|
|
|
|
Return a boolean indicating whether given alias exists.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to filter aliases
|
|
`name`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of alias names to return
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-existstype-0-90]]
|
|
=== `indices.existsType`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.existsType([params, [callback]])
|
|
--------
|
|
|
|
Check if a type/types exists in an index/indices.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` to check the types across all indices
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to check
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-flush-0-90]]
|
|
=== `indices.flush`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.flush([params, [callback]])
|
|
--------
|
|
|
|
Explicitly flush one or more indices.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-flush.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`force`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
|
|
`full`::
|
|
<<api-param-type-boolean,`Boolean`>> -- If set to true a new index writer is created and settings that have been changed related to the index writer will be refreshed. Note: if a full flush is required for a setting to take effect this will be part of the settings update process and it not required to be executed by the user. (This setting can be considered as internal)
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Refresh the index after performing the operation
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string for all indices
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-getalias-0-90]]
|
|
=== `indices.getAlias`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.getAlias([params, [callback]])
|
|
--------
|
|
|
|
Retrieve a specified alias.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to filter aliases
|
|
`name`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of alias names to return
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-getaliases-0-90]]
|
|
=== `indices.getAliases`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.getAliases([params, [callback]])
|
|
--------
|
|
|
|
Retrieve specified aliases
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to filter aliases
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-getfieldmapping-0-90]]
|
|
=== `indices.getFieldMapping`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.getFieldMapping([params, [callback]])
|
|
--------
|
|
|
|
Retrieve mapping definition of a specific field.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`includeDefaults`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Whether the default mapping values should be returned as well
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types
|
|
`field`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-getmapping-0-90]]
|
|
=== `indices.getMapping`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.getMapping([params, [callback]])
|
|
--------
|
|
|
|
Retrieve mapping definition of index or index/type.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-getsettings-0-90]]
|
|
=== `indices.getSettings`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.getSettings([params, [callback]])
|
|
--------
|
|
|
|
Retrieve settings for one or more (or all) indices.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-gettemplate-0-90]]
|
|
=== `indices.getTemplate`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.getTemplate([params, [callback]])
|
|
--------
|
|
|
|
Retrieve an index template by its name.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`name`::
|
|
<<api-param-type-string,`String`>> -- The name of the template
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-getwarmer-0-90]]
|
|
=== `indices.getWarmer`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.getWarmer([params, [callback]])
|
|
--------
|
|
|
|
Retreieve an index warmer.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to restrict the operation; use `_all` to perform the operation on all indices
|
|
`name`::
|
|
<<api-param-type-string,`String`>> -- The name of the warmer (supports wildcards); leave empty to get all warmers
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-open-0-90]]
|
|
=== `indices.open`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.open([params, [callback]])
|
|
--------
|
|
|
|
Open a closed index, making it available for search.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-optimize-0-90]]
|
|
=== `indices.optimize`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.optimize([params, [callback]])
|
|
--------
|
|
|
|
Explicitly optimize one or more indices.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-optimize.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`flush`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether the index should be flushed after performing the operation (default: true)
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`maxNumSegments`::
|
|
<<api-param-type-number,`Number`>> -- The number of segments the index should be merged into (default: dynamic)
|
|
`onlyExpungeDeletes`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether the operation should only expunge deleted documents
|
|
`operationThreading`::
|
|
anything -- TODO: ?
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether the index should be refreshed after performing the operation (default: true)
|
|
`waitForMerge`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether the request should block until the merge process is finished (default: true)
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-putalias-0-90]]
|
|
=== `indices.putAlias`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.putAlias([params, [callback]])
|
|
--------
|
|
|
|
Create an alias for a specific index/indices.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit timestamp for the document
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>> -- The name of the index with an alias
|
|
`name`::
|
|
<<api-param-type-string,`String`>> -- The name of the alias to be created or updated
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-putmapping-0-90]]
|
|
=== `indices.putMapping`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.putMapping([params, [callback]])
|
|
--------
|
|
|
|
Register specific mapping definition for a specific type.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`ignoreConflicts`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Specify whether to ignore conflicts while updating the mapping (default: false)
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` to perform the operation on all indices
|
|
`type`::
|
|
<<api-param-type-string,`String`>> -- The name of the document type
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-putsettings-0-90]]
|
|
=== `indices.putSettings`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.putSettings([params, [callback]])
|
|
--------
|
|
|
|
Change specific index level settings in real time.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-puttemplate-0-90]]
|
|
=== `indices.putTemplate`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.putTemplate([params, [callback]])
|
|
--------
|
|
|
|
Create an index template that will automatically be applied to new indices created.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`order`::
|
|
<<api-param-type-number,`Number`>> -- The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`name`::
|
|
<<api-param-type-string,`String`>> -- The name of the template
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-putwarmer-0-90]]
|
|
=== `indices.putWarmer`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.putWarmer([params, [callback]])
|
|
--------
|
|
|
|
Create an index warmer to run registered search requests to warm up the index before it is available for search.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to register the warmer for; use `_all` or empty string to perform the operation on all indices
|
|
`name`::
|
|
<<api-param-type-string,`String`>> -- The name of the warmer
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-refresh-0-90]]
|
|
=== `indices.refresh`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.refresh([params, [callback]])
|
|
--------
|
|
|
|
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`operationThreading`::
|
|
anything -- TODO: ?
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-segments-0-90]]
|
|
=== `indices.segments`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.segments([params, [callback]])
|
|
--------
|
|
|
|
Retrieve low level segments information that a Lucene index (shard level) is built with.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-segments.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`operationThreading`::
|
|
anything -- TODO: ?
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-snapshotindex-0-90]]
|
|
=== `indices.snapshotIndex`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.snapshotIndex([params, [callback]])
|
|
--------
|
|
|
|
Initiate a snapshot through the gateway of one or more indices.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string for all indices
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-stats-0-90]]
|
|
=== `indices.stats`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.stats([params, [callback]])
|
|
--------
|
|
|
|
Retrieve statistics on different operations happening on an index.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-stats.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`all`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return all available information
|
|
`clear`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Reset the default level of detail
|
|
`completion`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about completion suggester stats
|
|
`completionFields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields for `completion` metric (supports wildcards)
|
|
`docs`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about indexed and deleted documents
|
|
`fielddata`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about field data
|
|
`fielddataFields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields for `fielddata` metric (supports wildcards)
|
|
`fields`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields to return detailed information for, when returning the `search` statistics
|
|
`filterCache`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about filter cache
|
|
`flush`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about flush operations
|
|
`get`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about get operations
|
|
`groups`::
|
|
<<api-param-type-boolean,`Boolean`>> -- A comma-separated list of search groups for `search` statistics
|
|
`idCache`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about ID cache
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`indexing`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about indexing operations
|
|
`merge`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about merge operations
|
|
`refresh`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about refresh operations
|
|
`search`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about search operations; use the `groups` parameter to include information for specific search groups
|
|
`store`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about the size of the index
|
|
`warmer`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about warmers
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
|
`indexingTypes`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to include in the `indexing` statistics
|
|
`metricFamily`::
|
|
<<api-param-type-string,`String`>> -- Limit the information returned to a specific metric
|
|
Options:::
|
|
* `"completion"`
|
|
* `"docs"`
|
|
* `"fielddata"`
|
|
* `"filter_cache"`
|
|
* `"flush"`
|
|
* `"get"`
|
|
* `"groups"`
|
|
* `"id_cache"`
|
|
* `"ignore_indices"`
|
|
* `"indexing"`
|
|
* `"merge"`
|
|
* `"refresh"`
|
|
* `"search"`
|
|
* `"store"`
|
|
* `"warmer"`
|
|
|
|
`searchGroups`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of search groups to include in the `search` statistics
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-status-0-90]]
|
|
=== `indices.status`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.status([params, [callback]])
|
|
--------
|
|
|
|
Get a comprehensive status information of one or more indices.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-status.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`operationThreading`::
|
|
anything -- TODO: ?
|
|
`recovery`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return information about shard recovery
|
|
`snapshot`::
|
|
<<api-param-type-boolean,`Boolean`>> -- TODO: ?
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-updatealiases-0-90]]
|
|
=== `indices.updateAliases`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.updateAliases([params, [callback]])
|
|
--------
|
|
|
|
Update specified aliases.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
.Perform an atomic alias swap, for a rotating index
|
|
[source,js]
|
|
---------
|
|
const response = await client.indices.updateAliases({
|
|
body: {
|
|
actions: [
|
|
{ remove: { index: 'logstash-2014.04', alias: 'logstash-current' } },
|
|
{ add: { index: 'logstash-2014.05', alias: 'logstash-current' } }
|
|
]
|
|
}
|
|
});
|
|
---------
|
|
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`timeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Request timeout
|
|
`masterTimeout`::
|
|
<<api-param-type-duration-string,`DurationString`>> -- Specify timeout for connection to master
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to filter aliases
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|
|
|
|
[[api-indices-validatequery-0-90]]
|
|
=== `indices.validateQuery`
|
|
|
|
[source,js]
|
|
--------
|
|
client.indices.validateQuery([params, [callback]])
|
|
--------
|
|
|
|
Validate a potentially expensive query without executing it.
|
|
|
|
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-validate.html[the elasticsearch docs] for more information pertaining to this method.
|
|
|
|
// no examples
|
|
|
|
|
|
*Params*
|
|
|
|
[horizontal]
|
|
`explain`::
|
|
<<api-param-type-boolean,`Boolean`>> -- Return detailed information about the error
|
|
`[ignoreIndices=none]`::
|
|
<<api-param-type-string,`String`>> -- When performed on multiple indices, allows to ignore `missing` ones
|
|
Options:::
|
|
* `"none"`
|
|
* `"missing"`
|
|
|
|
`operationThreading`::
|
|
anything -- TODO: ?
|
|
`source`::
|
|
<<api-param-type-string,`String`>> -- The URL-encoded query definition (instead of using the request body)
|
|
`q`::
|
|
<<api-param-type-string,`String`>> -- Query in the Lucene query string syntax
|
|
`index`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
|
`type`::
|
|
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
|
`body`::
|
|
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
|
|
|
link:#[back to top]
|