updated docs to include 0.90 API
This commit is contained in:
Spencer Alger
2
.gitmodules
vendored
2
.gitmodules
vendored
@ -1,3 +1,3 @@
|
||||
[submodule "src/elasticsearch"]
|
||||
path = src/elasticsearch
|
||||
url = https://github.com/elasticsearch/elasticsearch.git
|
||||
url = https://github.com/spenceralger/elasticsearch.git
|
||||
|
||||
@ -12,7 +12,7 @@ client.bulk([params, [callback]])
|
||||
|
||||
Perform many index/delete operations in a single API call.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/bulk/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Perform three operations in a single request
|
||||
[source,js]
|
||||
@ -63,7 +63,7 @@ client.clearScroll([params, [callback]])
|
||||
|
||||
Clear the scroll request created by specifying the scroll parameter to search.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/search/scroll/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -84,16 +84,11 @@ client.cluster.getSettings([params, [callback]])
|
||||
|
||||
Get cluster settings (previously set with `putSettings()`)
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
|
||||
[[api-cluster-health]]
|
||||
=== `cluster.health`
|
||||
@ -105,7 +100,7 @@ client.cluster.health([params, [callback]])
|
||||
|
||||
Get a very simple status on the health of the cluster.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-health.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-health/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -144,7 +139,7 @@ Returns information about the hottest threads in the cluster or on a specific no
|
||||
|
||||
WARNING: This endpoint returns plain text
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Return 10 hottest threads
|
||||
[source,js]
|
||||
@ -183,7 +178,7 @@ client.cluster.nodeInfo([params, [callback]])
|
||||
|
||||
Retrieve one or more (or all) of the cluster nodes' information.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Return information about JVM
|
||||
[source,js]
|
||||
@ -200,12 +195,32 @@ client.cluster.nodeInfo({ jvm: true })
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`all`::
|
||||
`Boolean` -- Return all available information
|
||||
`clear`::
|
||||
`Boolean` -- Reset the default settings
|
||||
`http`::
|
||||
`Boolean` -- Return information about HTTP
|
||||
`jvm`::
|
||||
`Boolean` -- Return information about the JVM
|
||||
`network`::
|
||||
`Boolean` -- Return information about network
|
||||
`os`::
|
||||
`Boolean` -- Return information about the operating system
|
||||
`plugin`::
|
||||
`Boolean` -- Return information about plugins
|
||||
`process`::
|
||||
`Boolean` -- Return information about the Elasticsearch process
|
||||
`settings`::
|
||||
`Boolean` -- Return information about node settings
|
||||
`threadPool`::
|
||||
`Boolean` -- Return information about the thread pool
|
||||
`timeout`::
|
||||
`Date, Number` -- Explicit operation timeout
|
||||
`transport`::
|
||||
`Boolean` -- Return information about transport
|
||||
`nodeId`::
|
||||
`String, String[], 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
|
||||
`metric`::
|
||||
`String, String[], Boolean` -- A comma-separated list of metrics you wish returned. Leave empty to return all.
|
||||
|
||||
[[api-cluster-nodeshutdown]]
|
||||
=== `cluster.nodeShutdown`
|
||||
@ -217,7 +232,7 @@ client.cluster.nodeShutdown([params, [callback]])
|
||||
|
||||
Shutdown one or more (or all) nodes in the cluster.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -242,7 +257,7 @@ client.cluster.nodeStats([params, [callback]])
|
||||
|
||||
Retrieve one or more (or all) of the cluster nodes statistics.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-stats/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -250,22 +265,34 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`completionFields`::
|
||||
`String, String[], Boolean` -- A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
|
||||
`fielddataFields`::
|
||||
`String, String[], Boolean` -- A comma-separated list of fields for `fielddata` index metric (supports wildcards)
|
||||
`all`::
|
||||
`Boolean` -- Return all available information
|
||||
`clear`::
|
||||
`Boolean` -- Reset the default level of detail
|
||||
`fields`::
|
||||
`String, String[], Boolean` -- A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
|
||||
`groups`::
|
||||
`Boolean` -- A comma-separated list of search groups for `search` index metric
|
||||
`[level=node]`::
|
||||
`String` -- Return indices stats aggregated at node, index or shard level
|
||||
`types`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types for the `indexing` index metric
|
||||
`String, String[], Boolean` -- A comma-separated list of fields to return detailed information for, when returning the `indices` metric family (supports wildcards)
|
||||
`fs`::
|
||||
`Boolean` -- Return information about the filesystem
|
||||
`http`::
|
||||
`Boolean` -- Return information about HTTP
|
||||
`indices`::
|
||||
`Boolean` -- Return information about indices
|
||||
`jvm`::
|
||||
`Boolean` -- Return information about the JVM
|
||||
`network`::
|
||||
`Boolean` -- Return information about network
|
||||
`os`::
|
||||
`Boolean` -- Return information about the operating system
|
||||
`process`::
|
||||
`Boolean` -- Return information about the Elasticsearch process
|
||||
`threadPool`::
|
||||
`Boolean` -- Return information about the thread pool
|
||||
`transport`::
|
||||
`Boolean` -- Return information about transport
|
||||
`metricFamily`::
|
||||
`String` -- Limit the information returned to a certain metric family
|
||||
`metric`::
|
||||
`String, String[], Boolean` -- Limit the information returned to the specified metrics
|
||||
`indexMetric`::
|
||||
`String, String[], Boolean` -- Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.
|
||||
`String` -- Limit the information returned for `indices` family to a specific metric
|
||||
`nodeId`::
|
||||
`String, String[], 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
|
||||
|
||||
@ -279,16 +306,11 @@ client.cluster.putSettings([params, [callback]])
|
||||
|
||||
Update cluster wide specific settings.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
|
||||
[[api-cluster-reroute]]
|
||||
=== `cluster.reroute`
|
||||
@ -300,7 +322,7 @@ client.cluster.reroute([params, [callback]])
|
||||
|
||||
Explicitly execute a cluster reroute allocation command including specific commands.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-reroute.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -323,7 +345,7 @@ client.cluster.state([params, [callback]])
|
||||
|
||||
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-state.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-state/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -331,16 +353,22 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`filterBlocks`::
|
||||
`Boolean` -- Do not return information about blocks
|
||||
`filterIndexTemplates`::
|
||||
`Boolean` -- Do not return information about index templates
|
||||
`filterIndices`::
|
||||
`String, String[], Boolean` -- Limit returned metadata information to specific indices
|
||||
`filterMetadata`::
|
||||
`Boolean` -- Do not return information about indices metadata
|
||||
`filterNodes`::
|
||||
`Boolean` -- Do not return information about nodes
|
||||
`filterRoutingTable`::
|
||||
`Boolean` -- Do not return information about shard allocation (`routing_table` and `routing_nodes`)
|
||||
`local`::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`metric`::
|
||||
`String, String[], Boolean` -- Limit the information returned to the specified metrics
|
||||
|
||||
[[api-count]]
|
||||
=== `count`
|
||||
@ -352,7 +380,7 @@ client.count([params, [callback]])
|
||||
|
||||
Get the number of documents for the cluster, index, type, or a query.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/count/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Get the number of all documents in the cluster
|
||||
[source,js]
|
||||
@ -425,7 +453,7 @@ 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.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/index_/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Create a document
|
||||
[source,js]
|
||||
@ -489,7 +517,7 @@ client.delete([params, [callback]])
|
||||
|
||||
Delete a typed JSON document from a specific index based on its id.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/delete/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Delete the document `/myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -540,7 +568,7 @@ client.deleteByQuery([params, [callback]])
|
||||
|
||||
Delete documents from one or more indices and one or more types based on a query.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete-by-query.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/delete-by-query/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Deleting documents with a simple query
|
||||
[source,js]
|
||||
@ -609,7 +637,7 @@ client.exists([params, [callback]])
|
||||
|
||||
Returns a boolean indicating whether or not a given document exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/get/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Check that the document `/myindex/mytype/1` exits
|
||||
[source,js]
|
||||
@ -645,7 +673,7 @@ client.exists({
|
||||
`String` -- The document ID
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`[type=_all]`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
|
||||
[[api-explain]]
|
||||
@ -658,7 +686,7 @@ 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].
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-explain.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/explain/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.See how a document is scored against a simple query
|
||||
[source,js]
|
||||
@ -744,7 +772,7 @@ client.get([params, [callback]])
|
||||
|
||||
Get a typed JSON document from the index based on its id.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/get/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Get `/myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -784,7 +812,7 @@ client.get({
|
||||
`String` -- The document ID
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`[type=_all]`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
|
||||
[[api-getsource]]
|
||||
@ -797,7 +825,7 @@ client.getSource([params, [callback]])
|
||||
|
||||
Get the source of a document by it's index, type and id.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/get/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -823,7 +851,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
`String` -- The document ID
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`[type=_all]`::
|
||||
`String` -- The type of the document; use `_all` to fetch the first document matching the ID across all types
|
||||
|
||||
[[api-index]]
|
||||
@ -841,7 +869,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec
|
||||
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>>.
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/index_/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Create or update a document
|
||||
[source,js]
|
||||
@ -905,7 +933,7 @@ client.indices.analyze([params, [callback]])
|
||||
|
||||
Perform the analysis process on a text and return the tokens breakdown of the text.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -940,7 +968,7 @@ client.indices.clearCache([params, [callback]])
|
||||
|
||||
Clear either all caches or specific cached associated with one ore more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -985,7 +1013,7 @@ client.indices.close([params, [callback]])
|
||||
|
||||
Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1016,7 +1044,7 @@ client.indices.create([params, [callback]])
|
||||
|
||||
Create an index in Elasticsearch.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1041,7 +1069,7 @@ client.indices.delete([params, [callback]])
|
||||
|
||||
Delete an index in Elasticsearch
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1054,7 +1082,7 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or empty string to delete all indices
|
||||
|
||||
[[api-indices-deletealias]]
|
||||
=== `indices.deleteAlias`
|
||||
@ -1066,7 +1094,7 @@ client.indices.deleteAlias([params, [callback]])
|
||||
|
||||
Delete a specific alias.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1079,9 +1107,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`String` -- The name of the index with an alias
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`String` -- The name of the alias to be deleted
|
||||
|
||||
[[api-indices-deletemapping]]
|
||||
=== `indices.deleteMapping`
|
||||
@ -1093,7 +1121,7 @@ client.indices.deleteMapping([params, [callback]])
|
||||
|
||||
Delete a mapping (type definition) along with its data.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-mapping/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1104,9 +1132,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` for all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices.
|
||||
`String` -- The name of the document type to delete
|
||||
|
||||
[[api-indices-deletetemplate]]
|
||||
=== `indices.deleteTemplate`
|
||||
@ -1118,7 +1146,7 @@ client.indices.deleteTemplate([params, [callback]])
|
||||
|
||||
Delete an index template by its name.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1143,7 +1171,7 @@ client.indices.deleteWarmer([params, [callback]])
|
||||
|
||||
Delete an index warmer.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1153,10 +1181,12 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`String, String[], 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`::
|
||||
`String` -- The name of the warmer (supports wildcards); leave empty to delete all warmers
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register warmer for; use `_all` or empty string to perform the operation on all types
|
||||
|
||||
[[api-indices-exists]]
|
||||
=== `indices.exists`
|
||||
@ -1168,7 +1198,7 @@ client.indices.exists([params, [callback]])
|
||||
|
||||
Return a boolean indicating whether given index exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-indices-exists/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1195,7 +1225,7 @@ client.indices.existsAlias([params, [callback]])
|
||||
|
||||
Return a boolean indicating whether given alias exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1224,7 +1254,7 @@ client.indices.existsType([params, [callback]])
|
||||
|
||||
Check if a type/types exists in an index/indices.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-types-exists/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1253,7 +1283,7 @@ client.indices.flush([params, [callback]])
|
||||
|
||||
Explicitly flush one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-flush/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1286,7 +1316,7 @@ client.indices.getAlias([params, [callback]])
|
||||
|
||||
Retrieve a specified alias.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1315,7 +1345,7 @@ client.indices.getAliases([params, [callback]])
|
||||
|
||||
Retrieve specified aliases
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1327,8 +1357,6 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
`Date, Number` -- Explicit operation timeout
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to filter
|
||||
|
||||
[[api-indices-getfieldmapping]]
|
||||
=== `indices.getFieldMapping`
|
||||
@ -1373,7 +1401,7 @@ client.indices.getMapping([params, [callback]])
|
||||
|
||||
Retrieve mapping definition of index or index/type.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1402,7 +1430,7 @@ client.indices.getSettings([params, [callback]])
|
||||
|
||||
Retrieve settings for one or more (or all) indices.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1410,20 +1438,8 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`ignoreUnavailable`::
|
||||
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
`allowNoIndices`::
|
||||
`Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
`[expandWildcards=open,closed]`::
|
||||
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
||||
`prefix`::
|
||||
`String` -- The prefix all settings must have in order to be included
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`name`::
|
||||
`String` -- The name of the settings that should be included
|
||||
|
||||
[[api-indices-gettemplate]]
|
||||
=== `indices.getTemplate`
|
||||
@ -1435,7 +1451,7 @@ client.indices.getTemplate([params, [callback]])
|
||||
|
||||
Retrieve an index template by its name.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1443,8 +1459,6 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
|
||||
@ -1458,7 +1472,7 @@ client.indices.getWarmer([params, [callback]])
|
||||
|
||||
Retreieve an index warmer.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1489,7 +1503,7 @@ client.indices.open([params, [callback]])
|
||||
|
||||
Open a closed index, making it available for search.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1520,7 +1534,7 @@ client.indices.optimize([params, [callback]])
|
||||
|
||||
Explicitly optimize one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-optimize/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1559,7 +1573,7 @@ client.indices.putAlias([params, [callback]])
|
||||
|
||||
Create an alias for a specific index/indices.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1572,7 +1586,7 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices.
|
||||
`String` -- The name of the index with an alias
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
|
||||
@ -1586,7 +1600,7 @@ client.indices.putMapping([params, [callback]])
|
||||
|
||||
Register specific mapping definition for a specific type.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1607,7 +1621,7 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`[expandWildcards=open]`::
|
||||
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
|
||||
@ -1621,7 +1635,7 @@ client.indices.putSettings([params, [callback]])
|
||||
|
||||
Change specific index level settings in real time.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1637,8 +1651,6 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
`[expandWildcards=open]`::
|
||||
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
|
||||
@ -1652,7 +1664,7 @@ client.indices.putTemplate([params, [callback]])
|
||||
|
||||
Create an index template that will automatically be applied to new indices created.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1666,8 +1678,6 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Date, Number` -- Explicit operation timeout
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
|
||||
@ -1681,7 +1691,7 @@ 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.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1698,7 +1708,7 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`[expandWildcards=open]`::
|
||||
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to register the warmer for; use `_all` or omit to perform the operation on all indices
|
||||
`String, String[], 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`::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
@ -1714,7 +1724,7 @@ client.indices.refresh([params, [callback]])
|
||||
|
||||
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-refresh/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1743,7 +1753,7 @@ client.indices.segments([params, [callback]])
|
||||
|
||||
Retrieve low level segments information that a Lucene index (shard level) is built with.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-segments.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-indices-segments/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1772,7 +1782,7 @@ client.indices.snapshotIndex([params, [callback]])
|
||||
|
||||
Initiate a snapshot through the gateway of one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-gateway-snapshot.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-gateway-snapshot/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1799,7 +1809,7 @@ client.indices.stats([params, [callback]])
|
||||
|
||||
Retrieve statistics on different operations happening on an index.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-indices-stats/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1807,22 +1817,58 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`all`::
|
||||
`Boolean` -- Return all available information
|
||||
`clear`::
|
||||
`Boolean` -- Reset the default level of detail
|
||||
`completion`::
|
||||
`Boolean` -- Return information about completion suggester stats
|
||||
`completionFields`::
|
||||
`String, String[], Boolean` -- A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
|
||||
`String, String[], Boolean` -- A comma-separated list of fields for `completion` metric (supports wildcards)
|
||||
`docs`::
|
||||
`Boolean` -- Return information about indexed and deleted documents
|
||||
`fielddata`::
|
||||
`Boolean` -- Return information about field data
|
||||
`fielddataFields`::
|
||||
`String, String[], Boolean` -- A comma-separated list of fields for `fielddata` index metric (supports wildcards)
|
||||
`String, String[], Boolean` -- A comma-separated list of fields for `fielddata` metric (supports wildcards)
|
||||
`fields`::
|
||||
`String, String[], Boolean` -- A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
|
||||
`String, String[], Boolean` -- A comma-separated list of fields to return detailed information for, when returning the `search` statistics
|
||||
`filterCache`::
|
||||
`Boolean` -- Return information about filter cache
|
||||
`flush`::
|
||||
`Boolean` -- Return information about flush operations
|
||||
`get`::
|
||||
`Boolean` -- Return information about get operations
|
||||
`groups`::
|
||||
`Boolean` -- A comma-separated list of search groups for `search` index metric
|
||||
`[level=indices]`::
|
||||
`String` -- Return stats aggregated at cluster, index or shard level
|
||||
`types`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types for the `indexing` index metric
|
||||
`Boolean` -- A comma-separated list of search groups for `search` statistics
|
||||
`idCache`::
|
||||
`Boolean` -- Return information about ID cache
|
||||
`ignoreUnavailable`::
|
||||
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
`allowNoIndices`::
|
||||
`Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
`[expandWildcards=open]`::
|
||||
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
||||
`indexing`::
|
||||
`Boolean` -- Return information about indexing operations
|
||||
`merge`::
|
||||
`Boolean` -- Return information about merge operations
|
||||
`refresh`::
|
||||
`Boolean` -- Return information about refresh operations
|
||||
`search`::
|
||||
`Boolean` -- Return information about search operations; use the `groups` parameter to include information for specific search groups
|
||||
`store`::
|
||||
`Boolean` -- Return information about the size of the index
|
||||
`warmer`::
|
||||
`Boolean` -- Return information about warmers
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`metric`::
|
||||
`String, String[], Boolean` -- Limit the information returned the specific metrics.
|
||||
`indexingTypes`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to include in the `indexing` statistics
|
||||
`metricFamily`::
|
||||
`String` -- Limit the information returned to a specific metric
|
||||
`searchGroups`::
|
||||
`String, String[], Boolean` -- A comma-separated list of search groups to include in the `search` statistics
|
||||
|
||||
[[api-indices-status]]
|
||||
=== `indices.status`
|
||||
@ -1834,7 +1880,7 @@ client.indices.status([params, [callback]])
|
||||
|
||||
Get a comprehensive status information of one or more indices.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-status.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-indices-status/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1867,7 +1913,7 @@ client.indices.updateAliases([params, [callback]])
|
||||
|
||||
Update specified aliases.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1892,7 +1938,7 @@ client.indices.validateQuery([params, [callback]])
|
||||
|
||||
Validate a potentially expensive query without executing it.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-validate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/validate/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1929,7 +1975,7 @@ client.info([params, [callback]])
|
||||
|
||||
Get basic info from the current cluster.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1945,7 +1991,7 @@ 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.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/multi-get/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.An array of doc locations. Useful for getting documents from different indices.
|
||||
[source,js]
|
||||
@ -2010,7 +2056,7 @@ client.mlt([params, [callback]])
|
||||
|
||||
(more like this) Gets more documents that are “like” the document specified using `index`, `type`, and `id`.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-more-like-this.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/more-like-this/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Search for similar documents using the `title` property of document `myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -2035,13 +2081,13 @@ client.mlt({
|
||||
`Number` -- The word occurrence frequency as count: words with higher occurrence in the corpus will be ignored
|
||||
`maxQueryTerms`::
|
||||
`Number` -- The maximum query terms to be included in the generated query
|
||||
`maxWordLength`::
|
||||
`maxWordLen`::
|
||||
`Number` -- The minimum length of the word: longer words will be ignored
|
||||
`minDocFreq`::
|
||||
`Number` -- The word occurrence frequency as count: words with lower occurrence in the corpus will be ignored
|
||||
`minTermFreq`::
|
||||
`Number` -- The term frequency as percent: terms with lower occurence in the source document will be ignored
|
||||
`minWordLength`::
|
||||
`minWordLen`::
|
||||
`Number` -- The minimum length of the word: shorter words will be ignored
|
||||
`mltFields`::
|
||||
`String, String[], Boolean` -- Specific fields to perform the query against
|
||||
@ -2084,7 +2130,7 @@ client.msearch([params, [callback]])
|
||||
|
||||
Execute several search requests within the same request.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-multi-search.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/multi-search/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Perform multiple different searches, the body is made up of meta/data pairs
|
||||
[source,js]
|
||||
@ -2123,7 +2169,7 @@ client.percolate([params, [callback]])
|
||||
|
||||
Match a document against registered percolator queries.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/percolate/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.First, Register queries named “alert-1” and “alert-2” for the “myindex” index
|
||||
[source,js]
|
||||
@ -2216,7 +2262,7 @@ client.scroll([params, [callback]])
|
||||
|
||||
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/search/scroll/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Collect every title in the index that contains the word "test"
|
||||
[source,js]
|
||||
@ -2271,7 +2317,7 @@ TIP: https://github.com/fullscale/elastic.js[elastic.js] can be used to make bui
|
||||
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/search/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Search with a simple query string query
|
||||
[source,js]
|
||||
@ -2374,7 +2420,7 @@ client.search({
|
||||
`Date, Number` -- Explicit operation timeout
|
||||
`version`::
|
||||
`Boolean` -- Specify whether to return document version as part of a hit
|
||||
`index`::
|
||||
`[index=_all]`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
@ -2389,7 +2435,7 @@ client.suggest([params, [callback]])
|
||||
|
||||
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/search/suggest/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Return query terms suggestions (“auto-correction”)
|
||||
[source,js]
|
||||
@ -2458,7 +2504,7 @@ Update parts of a document. The required body parameter can contain one of two t
|
||||
* a partial document, which will be merged with the existing one.
|
||||
* a `script` which will update the document content
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-update.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/update/[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Update document title using partial document
|
||||
[source,js]
|
||||
|
||||
@ -12,7 +12,7 @@ client.bulk([params, [callback]])
|
||||
|
||||
Perform many index/delete operations in a single API call.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/bulk/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Perform three operations in a single request
|
||||
[source,js]
|
||||
@ -63,7 +63,7 @@ client.clearScroll([params, [callback]])
|
||||
|
||||
Clear the scroll request created by specifying the scroll parameter to search.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/search/scroll/[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -84,7 +84,7 @@ client.cluster.getSettings([params, [callback]])
|
||||
|
||||
Get cluster settings (previously set with `putSettings()`)
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -100,7 +100,7 @@ client.cluster.health([params, [callback]])
|
||||
|
||||
Get a very simple status on the health of the cluster.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-health/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-health.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -139,7 +139,7 @@ Returns information about the hottest threads in the cluster or on a specific no
|
||||
|
||||
WARNING: This endpoint returns plain text
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Return 10 hottest threads
|
||||
[source,js]
|
||||
@ -178,7 +178,7 @@ client.cluster.nodeInfo([params, [callback]])
|
||||
|
||||
Retrieve one or more (or all) of the cluster nodes' information.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Return information about JVM
|
||||
[source,js]
|
||||
@ -232,7 +232,7 @@ client.cluster.nodeShutdown([params, [callback]])
|
||||
|
||||
Shutdown one or more (or all) nodes in the cluster.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -257,7 +257,7 @@ client.cluster.nodeStats([params, [callback]])
|
||||
|
||||
Retrieve one or more (or all) of the cluster nodes statistics.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-stats/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -306,7 +306,7 @@ client.cluster.putSettings([params, [callback]])
|
||||
|
||||
Update cluster wide specific settings.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -322,7 +322,7 @@ client.cluster.reroute([params, [callback]])
|
||||
|
||||
Explicitly execute a cluster reroute allocation command including specific commands.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-reroute.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -345,7 +345,7 @@ client.cluster.state([params, [callback]])
|
||||
|
||||
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-cluster-state/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-state.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -380,7 +380,7 @@ client.count([params, [callback]])
|
||||
|
||||
Get the number of documents for the cluster, index, type, or a query.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/count/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Get the number of all documents in the cluster
|
||||
[source,js]
|
||||
@ -449,7 +449,7 @@ 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.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/index_/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Create a document
|
||||
[source,js]
|
||||
@ -513,7 +513,7 @@ client.delete([params, [callback]])
|
||||
|
||||
Delete a typed JSON document from a specific index based on its id.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/delete/[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Delete the document `/myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -564,7 +564,7 @@ client.deleteByQuery([params, [callback]])
|
||||
|
||||
Delete documents from one or more indices and one or more types based on a query.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/delete-by-query/[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete-by-query.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Deleting documents with a simple query
|
||||
[source,js]
|
||||
@ -629,7 +629,7 @@ client.exists([params, [callback]])
|
||||
|
||||
Returns a boolean indicating whether or not a given document exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/get/[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Check that the document `/myindex/mytype/1` exits
|
||||
[source,js]
|
||||
@ -665,7 +665,7 @@ client.exists({
|
||||
`String` -- The document ID
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`[type=_all]`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
|
||||
[[api-explain-0-90]]
|
||||
@ -678,7 +678,7 @@ 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].
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/explain/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-explain.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.See how a document is scored against a simple query
|
||||
[source,js]
|
||||
@ -764,7 +764,7 @@ client.get([params, [callback]])
|
||||
|
||||
Get a typed JSON document from the index based on its id.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/get/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Get `/myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -804,7 +804,7 @@ client.get({
|
||||
`String` -- The document ID
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`[type=_all]`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
|
||||
[[api-getsource-0-90]]
|
||||
@ -817,7 +817,7 @@ client.getSource([params, [callback]])
|
||||
|
||||
Get the source of a document by it's index, type and id.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/get/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -843,7 +843,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
`String` -- The document ID
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`[type=_all]`::
|
||||
`String` -- The type of the document; use `_all` to fetch the first document matching the ID across all types
|
||||
|
||||
[[api-index-0-90]]
|
||||
@ -861,7 +861,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec
|
||||
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>>.
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/index_/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Create or update a document
|
||||
[source,js]
|
||||
@ -925,7 +925,7 @@ client.indices.analyze([params, [callback]])
|
||||
|
||||
Perform the analysis process on a text and return the tokens breakdown of the text.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -960,7 +960,7 @@ client.indices.clearCache([params, [callback]])
|
||||
|
||||
Clear either all caches or specific cached associated with one ore more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1001,7 +1001,7 @@ client.indices.close([params, [callback]])
|
||||
|
||||
Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1026,7 +1026,7 @@ client.indices.create([params, [callback]])
|
||||
|
||||
Create an index in Elasticsearch.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1051,7 +1051,7 @@ client.indices.delete([params, [callback]])
|
||||
|
||||
Delete an index in Elasticsearch
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index/[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1076,7 +1076,7 @@ client.indices.deleteAlias([params, [callback]])
|
||||
|
||||
Delete a specific alias.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1103,7 +1103,7 @@ client.indices.deleteMapping([params, [callback]])
|
||||
|
||||
Delete a mapping (type definition) along with its data.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-mapping/[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1128,7 +1128,7 @@ client.indices.deleteTemplate([params, [callback]])
|
||||
|
||||
Delete an index template by its name.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1153,7 +1153,7 @@ client.indices.deleteWarmer([params, [callback]])
|
||||
|
||||
Delete an index warmer.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1180,7 +1180,7 @@ client.indices.exists([params, [callback]])
|
||||
|
||||
Return a boolean indicating whether given index exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-indices-exists/[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1201,7 +1201,7 @@ client.indices.existsAlias([params, [callback]])
|
||||
|
||||
Return a boolean indicating whether given alias exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1226,7 +1226,7 @@ client.indices.existsType([params, [callback]])
|
||||
|
||||
Check if a type/types exists in an index/indices.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-types-exists/[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1251,7 +1251,7 @@ client.indices.flush([params, [callback]])
|
||||
|
||||
Explicitly flush one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-flush/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1280,7 +1280,7 @@ client.indices.getAlias([params, [callback]])
|
||||
|
||||
Retrieve a specified alias.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1305,7 +1305,7 @@ client.indices.getAliases([params, [callback]])
|
||||
|
||||
Retrieve specified aliases
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1355,7 +1355,7 @@ client.indices.getMapping([params, [callback]])
|
||||
|
||||
Retrieve mapping definition of index or index/type.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1378,7 +1378,7 @@ client.indices.getSettings([params, [callback]])
|
||||
|
||||
Retrieve settings for one or more (or all) indices.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1399,7 +1399,7 @@ client.indices.getTemplate([params, [callback]])
|
||||
|
||||
Retrieve an index template by its name.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1420,7 +1420,7 @@ client.indices.getWarmer([params, [callback]])
|
||||
|
||||
Retreieve an index warmer.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1445,7 +1445,7 @@ client.indices.open([params, [callback]])
|
||||
|
||||
Open a closed index, making it available for search.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1470,7 +1470,7 @@ client.indices.optimize([params, [callback]])
|
||||
|
||||
Explicitly optimize one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-optimize/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1505,7 +1505,7 @@ client.indices.putAlias([params, [callback]])
|
||||
|
||||
Create an alias for a specific index/indices.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1532,7 +1532,7 @@ client.indices.putMapping([params, [callback]])
|
||||
|
||||
Register specific mapping definition for a specific type.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1561,7 +1561,7 @@ client.indices.putSettings([params, [callback]])
|
||||
|
||||
Change specific index level settings in real time.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1584,7 +1584,7 @@ client.indices.putTemplate([params, [callback]])
|
||||
|
||||
Create an index template that will automatically be applied to new indices created.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1611,7 +1611,7 @@ 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.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1638,7 +1638,7 @@ client.indices.refresh([params, [callback]])
|
||||
|
||||
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-refresh/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1663,7 +1663,7 @@ client.indices.segments([params, [callback]])
|
||||
|
||||
Retrieve low level segments information that a Lucene index (shard level) is built with.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-indices-segments/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-segments.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1688,7 +1688,7 @@ client.indices.snapshotIndex([params, [callback]])
|
||||
|
||||
Initiate a snapshot through the gateway of one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-gateway-snapshot/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-gateway-snapshot.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1711,7 +1711,7 @@ client.indices.stats([params, [callback]])
|
||||
|
||||
Retrieve statistics on different operations happening on an index.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-indices-stats/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1778,7 +1778,7 @@ client.indices.status([params, [callback]])
|
||||
|
||||
Get a comprehensive status information of one or more indices.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/admin-indices-status/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-status.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1807,7 +1807,7 @@ client.indices.updateAliases([params, [callback]])
|
||||
|
||||
Update specified aliases.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1832,7 +1832,7 @@ client.indices.validateQuery([params, [callback]])
|
||||
|
||||
Validate a potentially expensive query without executing it.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/validate/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-validate.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1865,7 +1865,7 @@ client.info([params, [callback]])
|
||||
|
||||
Get basic info from the current cluster.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1881,7 +1881,7 @@ 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.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/multi-get/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.An array of doc locations. Useful for getting documents from different indices.
|
||||
[source,js]
|
||||
@ -1946,7 +1946,7 @@ client.mlt([params, [callback]])
|
||||
|
||||
(more like this) Gets more documents that are “like” the document specified using `index`, `type`, and `id`.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/more-like-this/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-more-like-this.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Search for similar documents using the `title` property of document `myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -2020,7 +2020,7 @@ client.msearch([params, [callback]])
|
||||
|
||||
Execute several search requests within the same request.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/multi-search/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-multi-search.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Perform multiple different searches, the body is made up of meta/data pairs
|
||||
[source,js]
|
||||
@ -2059,7 +2059,7 @@ client.percolate([params, [callback]])
|
||||
|
||||
Match a document against registered percolator queries.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/percolate/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.First, Register queries named “alert-1” and “alert-2” for the “myindex” index
|
||||
[source,js]
|
||||
@ -2152,7 +2152,7 @@ client.scroll([params, [callback]])
|
||||
|
||||
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/search/scroll/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Collect every title in the index that contains the word "test"
|
||||
[source,js]
|
||||
@ -2207,7 +2207,7 @@ TIP: https://github.com/fullscale/elastic.js[elastic.js] can be used to make bui
|
||||
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/reference/api/search/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Search with a simple query string query
|
||||
[source,js]
|
||||
@ -2306,7 +2306,7 @@ client.search({
|
||||
`Date, Number` -- Explicit operation timeout
|
||||
`version`::
|
||||
`Boolean` -- Specify whether to return document version as part of a hit
|
||||
`index`::
|
||||
`[index=_all]`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
@ -2321,7 +2321,7 @@ client.suggest([params, [callback]])
|
||||
|
||||
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/search/suggest/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Return query terms suggestions (“auto-correction”)
|
||||
[source,js]
|
||||
@ -2386,7 +2386,7 @@ Update parts of a document. The required body parameter can contain one of two t
|
||||
* a partial document, which will be merged with the existing one.
|
||||
* a `script` which will update the document content
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://elasticsearch.org/guide/reference/api/update/[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-update.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Update document title using partial document
|
||||
[source,js]
|
||||
|
||||
Submodule src/elasticsearch updated: 5eeb702cd8...fa84799f03
980
src/lib/api.js
980
src/lib/api.js
File diff suppressed because it is too large
Load Diff
@ -6,7 +6,7 @@ var api = module.exports = {};
|
||||
api._namespaces = ['cluster', 'indices'];
|
||||
|
||||
/**
|
||||
* Perform a [bulk](http://elasticsearch.org/guide/reference/api/bulk/) request
|
||||
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
@ -73,7 +73,7 @@ api.bulk = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [clearScroll](http://www.elasticsearch.org/guide/reference/api/search/scroll/) request
|
||||
* Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.scrollId - A comma-separated list of scroll IDs to clear
|
||||
@ -96,7 +96,7 @@ api.cluster = function ClusterNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [cluster.getSettings](http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/) request
|
||||
* Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
*/
|
||||
@ -107,7 +107,7 @@ api.cluster.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.health](http://elasticsearch.org/guide/reference/api/admin-cluster-health/) request
|
||||
* Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-health.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.level=cluster] - Specify the level of detail for returned information
|
||||
@ -180,7 +180,7 @@ api.cluster.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.nodeHotThreads](http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/) request
|
||||
* Perform a [cluster.nodeHotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.interval - The interval for the second sampling of threads
|
||||
@ -225,7 +225,7 @@ api.cluster.prototype.nodeHotThreads = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.nodeInfo](http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/) request
|
||||
* Perform a [cluster.nodeInfo](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.all - Return all available information
|
||||
@ -298,7 +298,7 @@ api.cluster.prototype.nodeInfo = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.nodeShutdown](http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/) request
|
||||
* Perform a [cluster.nodeShutdown](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.delay - Set the delay for the operation (default: 1s)
|
||||
@ -331,7 +331,7 @@ api.cluster.prototype.nodeShutdown = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.nodeStats](http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-stats/) request
|
||||
* Perform a [cluster.nodeStats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.all - Return all available information
|
||||
@ -406,7 +406,7 @@ api.cluster.prototype.nodeStats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.putSettings](http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/) request
|
||||
* Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
*/
|
||||
@ -418,7 +418,7 @@ api.cluster.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.reroute](http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/) request
|
||||
* Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-reroute.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state
|
||||
@ -442,7 +442,7 @@ api.cluster.prototype.reroute = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.state](http://elasticsearch.org/guide/reference/api/admin-cluster-state/) request
|
||||
* Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-state.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.filterBlocks - Do not return information about blocks
|
||||
@ -494,7 +494,7 @@ api.cluster.prototype.state = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [count](http://elasticsearch.org/guide/reference/api/count/) request
|
||||
* Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
|
||||
@ -558,7 +558,7 @@ api.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [delete](http://elasticsearch.org/guide/reference/api/delete/) request
|
||||
* Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Specific write consistency setting for the operation
|
||||
@ -634,7 +634,7 @@ api['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteByQuery](http://www.elasticsearch.org/guide/reference/api/delete-by-query/) request
|
||||
* Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete-by-query.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.analyzer - The analyzer to use for the query string
|
||||
@ -730,7 +730,7 @@ api.deleteByQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [exists](http://elasticsearch.org/guide/reference/api/get/) request
|
||||
* Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.parent - The ID of the parent document
|
||||
@ -740,7 +740,7 @@ api.deleteByQuery = ca({
|
||||
* @param {String} params.routing - Specific routing value
|
||||
* @param {String} params.id - The document ID
|
||||
* @param {String} params.index - The name of the index
|
||||
* @param {String} params.type - The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
* @param {String} [params.type=_all] - The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
*/
|
||||
api.exists = ca({
|
||||
params: {
|
||||
@ -762,25 +762,28 @@ api.exists = ca({
|
||||
},
|
||||
url: {
|
||||
fmt: '/<%=index%>/<%=type%>/<%=id%>',
|
||||
opt: {
|
||||
type: {
|
||||
type: 'string',
|
||||
'default': '_all'
|
||||
}
|
||||
},
|
||||
req: {
|
||||
index: {
|
||||
type: 'string'
|
||||
},
|
||||
type: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
sortOrder: -3
|
||||
sortOrder: -2
|
||||
},
|
||||
castExists: true,
|
||||
method: 'HEAD'
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [explain](http://elasticsearch.org/guide/reference/api/explain/) request
|
||||
* Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-explain.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
|
||||
@ -879,7 +882,7 @@ api.explain = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [get](http://elasticsearch.org/guide/reference/api/get/) request
|
||||
* Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return in the response
|
||||
@ -893,7 +896,7 @@ api.explain = ca({
|
||||
* @param {String, String[], Boolean} params._sourceInclude - A list of fields to extract and return from the _source field
|
||||
* @param {String} params.id - The document ID
|
||||
* @param {String} params.index - The name of the index
|
||||
* @param {String} params.type - The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
* @param {String} [params.type=_all] - The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
*/
|
||||
api.get = ca({
|
||||
params: {
|
||||
@ -929,23 +932,26 @@ api.get = ca({
|
||||
},
|
||||
url: {
|
||||
fmt: '/<%=index%>/<%=type%>/<%=id%>',
|
||||
opt: {
|
||||
type: {
|
||||
type: 'string',
|
||||
'default': '_all'
|
||||
}
|
||||
},
|
||||
req: {
|
||||
index: {
|
||||
type: 'string'
|
||||
},
|
||||
type: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
sortOrder: -3
|
||||
sortOrder: -2
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getSource](http://elasticsearch.org/guide/reference/api/get/) request
|
||||
* Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.exclude - A list of fields to exclude from the returned _source field
|
||||
@ -957,7 +963,7 @@ api.get = ca({
|
||||
* @param {String} params.routing - Specific routing value
|
||||
* @param {String} params.id - The document ID
|
||||
* @param {String} params.index - The name of the index
|
||||
* @param {String} params.type - The type of the document; use `_all` to fetch the first document matching the ID across all types
|
||||
* @param {String} [params.type=_all] - The type of the document; use `_all` to fetch the first document matching the ID across all types
|
||||
*/
|
||||
api.getSource = ca({
|
||||
params: {
|
||||
@ -985,23 +991,26 @@ api.getSource = ca({
|
||||
},
|
||||
url: {
|
||||
fmt: '/<%=index%>/<%=type%>/<%=id%>/_source',
|
||||
opt: {
|
||||
type: {
|
||||
type: 'string',
|
||||
'default': '_all'
|
||||
}
|
||||
},
|
||||
req: {
|
||||
index: {
|
||||
type: 'string'
|
||||
},
|
||||
type: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
sortOrder: -3
|
||||
sortOrder: -2
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [index](http://elasticsearch.org/guide/reference/api/index_/) request
|
||||
* Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
@ -1115,7 +1124,7 @@ api.indices = function IndicesNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/) request
|
||||
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.analyzer - The name of the analyzer to use
|
||||
@ -1177,7 +1186,7 @@ api.indices.prototype.analyze = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.clearCache](http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache/) request
|
||||
* Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.fieldData - Clear field data
|
||||
@ -1255,7 +1264,7 @@ api.indices.prototype.clearCache = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.close](http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/) request
|
||||
* Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1285,7 +1294,7 @@ api.indices.prototype.close = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.create](http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index/) request
|
||||
* Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1315,7 +1324,7 @@ api.indices.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.delete](http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index/) request
|
||||
* Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1349,7 +1358,7 @@ api.indices.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
|
||||
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -1383,7 +1392,7 @@ api.indices.prototype.deleteAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-mapping/) request
|
||||
* Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -1413,7 +1422,7 @@ api.indices.prototype.deleteMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/) request
|
||||
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1443,7 +1452,7 @@ api.indices.prototype.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/) request
|
||||
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -1497,7 +1506,7 @@ api.indices.prototype.deleteWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/reference/api/admin-indices-indices-exists/) request
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of indices to check
|
||||
@ -1517,7 +1526,7 @@ api.indices.prototype.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
|
||||
* Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
|
||||
@ -1562,7 +1571,7 @@ api.indices.prototype.existsAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsType](http://www.elasticsearch.org/guide/reference/api/admin-indices-types-exists/) request
|
||||
* Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
|
||||
@ -1598,7 +1607,7 @@ api.indices.prototype.existsType = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flush](http://www.elasticsearch.org/guide/reference/api/admin-indices-flush/) request
|
||||
* Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.force - 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)
|
||||
@ -1645,7 +1654,7 @@ api.indices.prototype.flush = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
|
||||
@ -1688,7 +1697,7 @@ api.indices.prototype.getAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAliases](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
|
||||
* Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1769,7 +1778,7 @@ api.indices.prototype.getFieldMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping/) request
|
||||
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of index names
|
||||
@ -1803,7 +1812,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/) request
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
@ -1825,7 +1834,7 @@ api.indices.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/) request
|
||||
* Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.name - The name of the template
|
||||
@ -1847,7 +1856,7 @@ api.indices.prototype.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/) request
|
||||
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` to perform the operation on all indices
|
||||
@ -1893,7 +1902,7 @@ api.indices.prototype.getWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.open](http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/) request
|
||||
* Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1923,7 +1932,7 @@ api.indices.prototype.open = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.optimize](http://www.elasticsearch.org/guide/reference/api/admin-indices-optimize/) request
|
||||
* Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
|
||||
@ -1985,7 +1994,7 @@ api.indices.prototype.optimize = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putAlias](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
|
||||
* Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -2039,7 +2048,7 @@ api.indices.prototype.putAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putMapping](http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/) request
|
||||
* Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false)
|
||||
@ -2078,7 +2087,7 @@ api.indices.prototype.putMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putSettings](http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/) request
|
||||
* Perform a [indices.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2108,7 +2117,7 @@ api.indices.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/) request
|
||||
* Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
|
||||
@ -2142,7 +2151,7 @@ api.indices.prototype.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/) request
|
||||
* Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2188,7 +2197,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.refresh](http://www.elasticsearch.org/guide/reference/api/admin-indices-refresh/) request
|
||||
* Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
|
||||
@ -2227,7 +2236,7 @@ api.indices.prototype.refresh = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.segments](http://elasticsearch.org/guide/reference/api/admin-indices-segments/) request
|
||||
* Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
|
||||
@ -2265,7 +2274,7 @@ api.indices.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.snapshotIndex](http://www.elasticsearch.org/guide/reference/api/admin-indices-gateway-snapshot/) request
|
||||
* Perform a [indices.snapshotIndex](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-gateway-snapshot.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
|
||||
@ -2300,7 +2309,7 @@ api.indices.prototype.snapshotIndex = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.stats](http://elasticsearch.org/guide/reference/api/admin-indices-stats/) request
|
||||
* Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.all - Return all available information
|
||||
@ -2417,7 +2426,7 @@ api.indices.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.status](http://elasticsearch.org/guide/reference/api/admin-indices-status/) request
|
||||
* Perform a [indices.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-status.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
|
||||
@ -2463,7 +2472,7 @@ api.indices.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
|
||||
* Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Request timeout
|
||||
@ -2487,7 +2496,7 @@ api.indices.prototype.updateAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/reference/api/validate/) request
|
||||
* Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-validate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.explain - Return detailed information about the error
|
||||
@ -2550,7 +2559,7 @@ api.indices.prototype.validateQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [info](http://elasticsearch.org/guide/) request
|
||||
* Perform a [info](http://www.elasticsearch.org/guide/) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
*/
|
||||
@ -2561,7 +2570,7 @@ api.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mget](http://elasticsearch.org/guide/reference/api/multi-get/) request
|
||||
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return in the response
|
||||
@ -2628,7 +2637,7 @@ api.mget = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mlt](http://elasticsearch.org/guide/reference/api/more-like-this/) request
|
||||
* Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-more-like-this.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.boostTerms - The boost factor
|
||||
@ -2751,7 +2760,7 @@ api.mlt = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [msearch](http://www.elasticsearch.org/guide/reference/api/multi-search/) request
|
||||
* Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-multi-search.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.searchType - Search operation type
|
||||
@ -2802,7 +2811,7 @@ api.msearch = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [percolate](http://elasticsearch.org/guide/reference/api/percolate/) request
|
||||
* Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.preferLocal - With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
|
||||
@ -2832,7 +2841,7 @@ api.percolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scroll](http://www.elasticsearch.org/guide/reference/api/search/scroll/) request
|
||||
* Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Duration} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
@ -2865,7 +2874,7 @@ api.scroll = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [search](http://www.elasticsearch.org/guide/reference/api/search/) request
|
||||
* Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.analyzer - The analyzer to use for the query string
|
||||
@ -2897,7 +2906,7 @@ api.scroll = ca({
|
||||
* @param {Text} params.suggestText - The source text for which the suggestions should be returned
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
* @param {Boolean} params.version - Specify whether to return document version as part of a hit
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
* @param {String, String[], Boolean} [params.index=_all] - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
*/
|
||||
api.search = ca({
|
||||
@ -3029,10 +3038,13 @@ api.search = ca({
|
||||
urls: [
|
||||
{
|
||||
fmt: '/<%=index%>/<%=type%>/_search',
|
||||
req: {
|
||||
opt: {
|
||||
index: {
|
||||
type: 'list'
|
||||
},
|
||||
type: 'list',
|
||||
'default': '_all'
|
||||
}
|
||||
},
|
||||
req: {
|
||||
type: {
|
||||
type: 'list'
|
||||
}
|
||||
@ -3040,9 +3052,10 @@ api.search = ca({
|
||||
},
|
||||
{
|
||||
fmt: '/<%=index%>/_search',
|
||||
req: {
|
||||
opt: {
|
||||
index: {
|
||||
type: 'list'
|
||||
type: 'list',
|
||||
'default': '_all'
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -3051,7 +3064,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://elasticsearch.org/guide/reference/api/search/suggest/) request
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
|
||||
@ -3098,7 +3111,7 @@ api.suggest = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [update](http://elasticsearch.org/guide/reference/api/update/) request
|
||||
* Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-update.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
@ -3201,7 +3214,7 @@ api.update = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [create](http://elasticsearch.org/guide/reference/api/index_/) request
|
||||
* Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
|
||||
Reference in New Issue
Block a user