0.90 APIedit
At this time, you must opt into the 0.90 API by setting the apiVersion config parameter.
bulkedit
client.bulk([params, [callback]])
Perform many index/delete operations in a single API call.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Perform three operations in a single request.
client.bulk({
body: [
// action description
{ index: { _index: 'myindex', _type: 'mytype', _id: 1 } },
// the document to index
{ title: 'foo' },
// action description
{ update: { _index: 'myindex', _type: 'mytype', _id: 2 } },
// the document to update
{ doc: { title: 'foo' } },
// action description
{ delete: { _index: 'myindex', _type: 'mytype', _id: 3 } },
// no document needed for this delete
]
}, function (err, resp) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
clearScrolledit
client.clearScroll([params, [callback]])
Clear the scroll request created by specifying the scroll parameter to search.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
countedit
client.count([params, [callback]])
Get the number of documents for the cluster, index, type, or a query.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Get the number of all documents in the cluster.
client.count(function (error, response, status) {
// check for and handle error
var count = response.count;
});
Get the number of documents in an index.
client.count({
index: 'index_name'
}, function (error, response) {
// ...
});
Get the number of documents matching a query.
client.count({
index: 'index_name',
body: {
query: {
filtered: {
filter: {
terms: {
foo: ['bar']
}
}
}
}
}
}, function (err, response) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
createedit
client.create([params, [callback]])
Adds a typed JSON document in a specific index, making it searchable. If a document with the same index, type, and id already exists, an error will occur.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Create a document.
client.create({
index: 'myindex',
type: 'mytype',
id: '1',
body: {
title: 'Test 1',
tags: ['y', 'z'],
published: true,
published_at: '2013-01-01',
counter: 1
}
}, function (error, response) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Timestamp — Explicit timestamp for the document |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
deleteedit
client.delete([params, [callback]])
Delete a typed JSON document from a specific index based on its id.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Delete the document /myindex/mytype/1.
client.delete({
index: 'myindex',
type: 'mytype',
id: '1'
}, function (error, response) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
deleteByQueryedit
client.deleteByQuery([params, [callback]])
Delete documents from one or more indices and one or more types based on a query.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Deleting documents with a simple query.
client.deleteByQuery({
index: 'myindex',
q: 'test'
}, function (error, response) {
// ...
});
Deleting documents using the Query DSL.
client.deleteByQuery({
index: 'posts',
body: {
query: {
term: { published: false }
}
}
}, function (error, response) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
existsedit
client.exists([params, [callback]])
Returns a boolean indicating whether or not a given document exists.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Check that the document /myindex/mytype/1 exist.
client.exists({
index: 'myindex',
type: 'mytype',
id: 1
}, function (error, exists) {
if (exists === true) {
// ...
} else {
// ...
}
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
explainedit
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 percolaters.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
See how a document is scored against a simple query.
client.explain({
// the document to test
index: 'myindex',
type: 'mytype',
id: '1',
// the query to score it against
q: 'field:value'
}, function (error, response) {
// ...
});
See how a document is scored against a query written in the Query DSL.
client.explain({
index: 'myindex',
type: 'mytype',
id: '1',
body: {
query: {
match: { title: 'test' }
}
}
}, function (error, response) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
getedit
client.get([params, [callback]])
Get a typed JSON document from the index based on its id.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Get /myindex/mytype/1.
client.get({
index: 'myindex',
type: 'mytype',
id: 1
}, function (error, response) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
getSourceedit
client.getSource([params, [callback]])
Get the source of a document by its index, type and id.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indexedit
client.index([params, [callback]])
Stores a typed JSON document in an index, making it searchable. When the id param is not set, a unique id will be auto-generated. When you specify an id either a new document will be created, or an existing document will be updated. To enforce "put-if-absent" behavior set the opType to "create" or use the create() method.
Optimistic concurrency control is performed, when the version argument is specified. By default, no version checks are performed.
By default, the document will be available for get() actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See indices.refresh.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Create or update a document.
client.index({
index: 'myindex',
type: 'mytype',
id: '1',
body: {
title: 'Test 1',
tags: ['y', 'z'],
published: true,
}
}, function (error, response) {
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Timestamp — Explicit timestamp for the document |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
infoedit
client.info([params, [callback]])
Get basic info from the current cluster.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
mgetedit
client.mget([params, [callback]])
Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
An array of doc locations. Useful for getting documents from different indices.
client.mget({
body: {
docs: [
{ _index: 'indexA', _type: 'typeA', _id: '1' },
{ _index: 'indexB', _type: 'typeB', _id: '1' },
{ _index: 'indexC', _type: 'typeC', _id: '1' }
]
}
}, function(error, response){
// ...
});
An array of ids. You must also specify the index and type that apply to all of the ids.
client.mget({
index: 'myindex',
type: 'mytype',
body: {
ids: [1, 2, 3]
}
}, function(error, response){
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
mltedit
client.mlt([params, [callback]])
(more like this) Gets more documents that are “like” the document specified using index, type, and id.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Search for similar documents using the title property of document myindex/mytype/1.
client.mlt({
index: 'myindex',
type: 'mytype',
id: 1,
mlt_fields: 'title'
}, function (errors, response) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
msearchedit
client.msearch([params, [callback]])
Execute several search requests within the same request.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Perform multiple different searches, the body is made up of meta/data pairs.
client.msearch({
body: [
// match all query, on all indices and types
{},
{ query: { match_all: {} } },
// query_string query, on index/mytype
{ index: 'myindex', type: 'mytype' },
{ query: { query_string: { query: '"Test 1"' } } }
]
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
percolateedit
client.percolate([params, [callback]])
Match a document against registered percolator queries.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
First, Register queries named “alert-1” and “alert-2” for the “myindex” index.
client.index({
index: 'myindex',
type: '.percolator',
id: 'alert-1',
body: {
// This query will be run against documents sent to percolate
query: {
query_string: {
query: 'foo'
}
}
}
}, function (error, response) {
// ...
});
client.index({
index: 'myindex',
type: '.percolator',
id: 'alert-2',
body: {
// This query will also be run against documents sent to percolate
query: {
query_string: {
query: 'bar'
}
}
}
}, function (error, response) {
// ...
});
Then you can send documents to learn which query _percolator queries they match.
client.percolate({
index: 'myindex',
type: 'mytype',
body: {
doc: {
title: "Foo"
}
}
}, function (error, response) {
// response would equal
// {
// total: 1,
// matches: [ { _index: 'myindex', _id: 'alert-1' } ]
// }
});
client.percolate({
index: 'myindex',
type: 'mytype',
body: {
doc: {
title: "Foo Bar"
}
}
}, function (error, response) {
// response would equal
// {
// total: 2,
// matches: [
// { _index: 'myindex', _id: 'alert-1' },
// { _index: 'myindex', _id: 'alert-2' }
// ]
// }
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
pingedit
client.ping([params, [callback]])
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
scrolledit
client.scroll([params, [callback]])
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a search() call.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Collect every title in the index that contains the word "test".
var allTitles = [];
// first we do a search, and specify a scroll timeout
client.search({
index: 'myindex',
// Set to 30 seconds because we are calling right back
scroll: '30s',
search_type: 'scan',
fields: ['title'],
q: 'title:test'
}, function getMoreUntilDone(error, response) {
// collect the title from each response
response.hits.hits.forEach(function (hit) {
allTitles.push(hit.fields.title);
});
if (response.hits.total !== allTitles.length) {
// now we can call scroll over and over
client.scroll({
scrollId: response._scroll_id,
scroll: '30s'
}, getMoreUntilDone);
} else {
console.log('every "test" title', allTitles);
}
});
Params
|
|
|
|
|
|
|
|
|
searchedit
client.search([params, [callback]])
Return documents matching a query, aggregations/facets, highlighted snippets, suggestions, and more. Write your queries as either simple query strings in the q parameter, or by specifying a full request definition using the Elasticsearch Query DSL in the body parameter.
elastic.js, esq, or bodybuilder can be used to make building query bodies easier.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Search with a simple query string query.
client.search({
index: 'myindex',
q: 'title:test'
}, function (error, response) {
// ...
});
Passing a full request definition in the Elasticsearch’s Query DSL as a Hash.
client.search({
index: 'myindex',
body: {
query: {
match: {
title: 'test'
}
},
facets: {
tags: {
terms: {
field: 'tags'
}
}
}
}
}, function (error, response) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
suggestedit
client.suggest([params, [callback]])
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Return query terms suggestions (“auto-correction”).
client.suggest({
index: 'myindex',
body: {
mysuggester: {
text: 'tset',
term: {
field: 'title'
}
}
}
}, function (error, response) {
// response will be formatted like so:
//
// {
// ...
// mysuggester: [
// {
// text: "tset",
// ...
// options: [
// {
// text: "test",
// score: 0.75,
// freq: 5
// }
// ]
// }
// ]
// }
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
updateedit
client.update([params, [callback]])
Update parts of a document. The required body parameter can contain one of two things:
- a partial document, which will be merged with the existing one.
-
a
scriptwhich will update the document content
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Update document title using partial document.
client.update({
index: 'myindex',
type: 'mytype',
id: '1',
body: {
// put the partial document under the `doc` key
doc: {
title: 'Updated'
}
}
}, function (error, response) {
// ...
})
Add a tag to document tags property using a script.
client.update({
index: 'myindex',
type: 'mytype',
id: '1',
body: {
script: 'ctx._source.tags += tag',
params: { tag: 'some new tag' }
}
}, function (error, response) {
// ...
});
Increment a document counter by 1 or initialize it, when the document does not exist.
client.update({
index: 'myindex',
type: 'mytype',
id: '777',
body: {
script: 'ctx._source.counter += 1',
upsert: {
counter: 1
}
}
}, function (error, response) {
// ...
})
Delete a document if it’s tagged “to-delete”.
client.update({
index: 'myindex',
type: 'mytype',
id: '1',
body: {
script: 'ctx._source.tags.contains(tag) ? ctx.op = "delete" : ctx.op = "none"',
params: {
tag: 'to-delete'
}
}
}, function (error, response) {
// ...
});
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Timestamp — Explicit timestamp for the document |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
cluster.getSettingsedit
client.cluster.getSettings([params, [callback]])
Get cluster settings (previously set with putSettings())
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
cluster.healthedit
client.cluster.health([params, [callback]])
Get a very simple status on the health of the cluster.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
cluster.nodeHotThreadsedit
client.cluster.nodeHotThreads([params, [callback]])
Returns information about the hottest threads in the cluster or on a specific node as a String. The information is returned as text, and allows you to understand what are currently the most taxing operations happening in the cluster, for debugging or monitoring purposes.
This endpoint returns plain text
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Return 10 hottest threads.
client.cluster.nodeHotThreads({
threads: 10
nodeId: 'mymisbehavingnode',
maxRetries: 10
}, function (error, response) {
console.log(response);
})
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
cluster.nodeInfoedit
client.cluster.nodeInfo([params, [callback]])
Retrieve one or more (or all) of the cluster nodes' information.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Return information about JVM.
client.cluster.nodeInfo({ jvm: true })
.then(function (response) {
// enjoy your sweet info!
}, function (error) {
// scream!
})
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
cluster.nodeShutdownedit
client.cluster.nodeShutdown([params, [callback]])
Shutdown one or more (or all) nodes in the cluster.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
cluster.nodeStatsedit
client.cluster.nodeStats([params, [callback]])
Retrieve one or more (or all) of the cluster nodes statistics.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
cluster.pendingTasksedit
client.cluster.pendingTasks([params, [callback]])
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
cluster.putSettingsedit
client.cluster.putSettings([params, [callback]])
Update cluster wide specific settings.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
cluster.rerouteedit
client.cluster.reroute([params, [callback]])
Explicitly execute a cluster reroute allocation command including specific commands.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
cluster.stateedit
client.cluster.state([params, [callback]])
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.analyzeedit
client.indices.analyze([params, [callback]])
Perform the analysis process on a text and return the tokens breakdown of the text.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.clearCacheedit
client.indices.clearCache([params, [callback]])
Clear either all caches or specific cached associated with one ore more indices.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.closeedit
client.indices.close([params, [callback]])
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.createedit
client.indices.create([params, [callback]])
Create an index in Elasticsearch.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.deleteedit
client.indices.delete([params, [callback]])
Delete an index in Elasticsearch
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.deleteAliasedit
client.indices.deleteAlias([params, [callback]])
Delete a specific alias.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.deleteMappingedit
client.indices.deleteMapping([params, [callback]])
Delete a mapping (type definition) along with its data.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.deleteTemplateedit
client.indices.deleteTemplate([params, [callback]])
Delete an index template by its name.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.deleteWarmeredit
client.indices.deleteWarmer([params, [callback]])
Delete an index warmer.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.existsedit
client.indices.exists([params, [callback]])
Return a boolean indicating whether given index exists.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
indices.existsAliasedit
client.indices.existsAlias([params, [callback]])
Return a boolean indicating whether given alias exists.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.existsTypeedit
client.indices.existsType([params, [callback]])
Check if a type/types exists in an index/indices.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.flushedit
client.indices.flush([params, [callback]])
Explicitly flush one or more indices.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.getAliasedit
client.indices.getAlias([params, [callback]])
Retrieve a specified alias.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
indices.getAliasesedit
client.indices.getAliases([params, [callback]])
Retrieve specified aliases
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
indices.getFieldMappingedit
client.indices.getFieldMapping([params, [callback]])
Retrieve mapping definition of a specific field.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.getMappingedit
client.indices.getMapping([params, [callback]])
Retrieve mapping definition of index or index/type.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
indices.getSettingsedit
client.indices.getSettings([params, [callback]])
Retrieve settings for one or more (or all) indices.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
indices.getTemplateedit
client.indices.getTemplate([params, [callback]])
Retrieve an index template by its name.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
indices.getWarmeredit
client.indices.getWarmer([params, [callback]])
Retreieve an index warmer.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
indices.openedit
client.indices.open([params, [callback]])
Open a closed index, making it available for search.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.optimizeedit
client.indices.optimize([params, [callback]])
Explicitly optimize one or more indices.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
anything — TODO: ? |
|
|
|
|
|
|
|
|
|
|
|
|
indices.putAliasedit
client.indices.putAlias([params, [callback]])
Create an alias for a specific index/indices.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.putMappingedit
client.indices.putMapping([params, [callback]])
Register specific mapping definition for a specific type.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.putSettingsedit
client.indices.putSettings([params, [callback]])
Change specific index level settings in real time.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
indices.putTemplateedit
client.indices.putTemplate([params, [callback]])
Create an index template that will automatically be applied to new indices created.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.putWarmeredit
client.indices.putWarmer([params, [callback]])
Create an index warmer to run registered search requests to warm up the index before it is available for search.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.refreshedit
client.indices.refresh([params, [callback]])
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
anything — TODO: ? |
|
|
|
|
|
|
indices.segmentsedit
client.indices.segments([params, [callback]])
Retrieve low level segments information that a Lucene index (shard level) is built with.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
indices.snapshotIndexedit
client.indices.snapshotIndex([params, [callback]])
Initiate a snapshot through the gateway of one or more indices.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
indices.statsedit
client.indices.stats([params, [callback]])
Retrieve statistics on different operations happening on an index.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
indices.statusedit
client.indices.status([params, [callback]])
Get a comprehensive status information of one or more indices.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
anything — TODO: ? |
|
|
|
|
|
|
|
|
|
indices.updateAliasesedit
client.indices.updateAliases([params, [callback]])
Update specified aliases.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Perform an atomic alias swap, for a rotating index.
client.indices.updateAliases({
body: {
actions: [
{ remove: { index: 'logstash-2014.04', alias: 'logstash-current' } },
{ add: { index: 'logstash-2014.05', alias: 'logstash-current' } }
]
}
}).then(function (response) {
// ...
}, errorHandler);
Params
|
|
|
|
|
|
|
|
|
|
|
|
indices.validateQueryedit
client.indices.validateQuery([params, [callback]])
Validate a potentially expensive query without executing it.
Check the API Conventions and the elasticsearch docs for more information pertaining to this method.
Params
|
|
|
|
|
|
|
|
anything — TODO: ? |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|