0.90 APIedit

Note

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

consistency

String — Explicit write consistency setting for the operation

Options
  • "one"
  • "quorum"
  • "all"

refresh

Boolean — Refresh the index after performing the operation

[replication=sync]

String — Explicitely set the replication type

Options
  • "sync"
  • "async"

type

String — Default document type for items which don’t provide one

timeout

DurationString — Explicit operation timeout

index

String — Default index for items which don’t provide one

body

Object[], JSONLines — The request body, as either an array of objects or new-line delimited JSON objects. See the elasticsearch docs for details about what can be specified here.

back to top

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

scrollId

String, String[], Boolean — A comma-separated list of scroll IDs to clear

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

minScore

Number — Include only documents with a specific _score value in the result

preference

String — Specify the node or shard the operation should be performed on (default: random)

routing

String — Specific routing value

source

String — The URL-encoded query definition (instead of using the request body)

index

String, String[], Boolean — A comma-separated list of indices to restrict the results

type

String, String[], Boolean — A comma-separated list of types to restrict the results

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

consistency

String — Explicit write consistency setting for the operation

Options
  • "one"
  • "quorum"
  • "all"

parent

String — ID of the parent document

percolate

String — Percolator queries to execute while indexing the document

refresh

Boolean — Refresh the index after performing the operation

[replication=sync]

String — Specific replication type

Options
  • "sync"
  • "async"

routing

String — Specific routing value

timeout

DurationString — Explicit operation timeout

timestamp

Timestamp — Explicit timestamp for the document

ttl

DurationString — Expiration time for the document

version

Number — Explicit version number for concurrency control

versionType

String — Specific version type

Options
  • "internal"
  • "external"

id

String — Document ID

index

String — The name of the index

type

String — The type of the document

body

Object, JSON — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

consistency

String — Specific write consistency setting for the operation

Options
  • "one"
  • "quorum"
  • "all"

parent

String — ID of parent document

refresh

Boolean — Refresh the index after performing the operation

[replication=sync]

String — Specific replication type

Options
  • "sync"
  • "async"

routing

String — Specific routing value

timeout

DurationString — Explicit operation timeout

version

Number — Explicit version number for concurrency control

versionType

String — Specific version type

Options
  • "internal"
  • "external"

id

String — The document ID

index

String — The name of the index

type

String — The type of the document

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

analyzer

String — The analyzer to use for the query string

consistency

String — Specific write consistency setting for the operation

Options
  • "one"
  • "quorum"
  • "all"

[defaultOperator=OR]

String — The default operator for query string query (AND or OR)

Options
  • "AND"
  • "OR"

df

String — The field to use as default where no field prefix is given in the query string

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

[replication=sync]

String — Specific replication type

Options
  • "sync"
  • "async"

q

String — Query in the Lucene query string syntax

routing

String — Specific routing value

source

String — The URL-encoded query definition (instead of using the request body)

timeout

DurationString — Explicit operation timeout

index

String, String[], Boolean — A comma-separated list of indices to restrict the operation; use _all to perform the operation on all indices

type

String, String[], Boolean — A comma-separated list of types to restrict the operation

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

parent

String — The ID of the parent document

preference

String — Specify the node or shard the operation should be performed on (default: random)

realtime

Boolean — Specify whether to perform the operation in realtime or search mode

refresh

Boolean — Refresh the shard containing the document before performing the operation

routing

String — Specific routing value

id

String — The document ID

index

String — The name of the index

type

String — The type of the document (use _all to fetch the first document matching the ID across all types)

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

analyzeWildcard

Boolean — Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)

analyzer

String — The analyzer for the query string query

[defaultOperator=OR]

String — The default operator for query string query (AND or OR)

Options
  • "AND"
  • "OR"

df

String — The default field for query string query (default: _all)

fields

String, String[], Boolean — A comma-separated list of fields to return in the response

lenient

Boolean — Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

lowercaseExpandedTerms

Boolean — Specify whether query terms should be lowercased

parent

String — The ID of the parent document

preference

String — Specify the node or shard the operation should be performed on (default: random)

q

String — Query in the Lucene query string syntax

routing

String — Specific routing value

source

String — The URL-encoded query definition (instead of using the request body)

_source

String, String[], Boolean — True or false to return the _source field or not, or a list of fields to return

_sourceExclude

String, String[], Boolean — A list of fields to exclude from the returned _source field

_sourceInclude

String, String[], Boolean — A list of fields to extract and return from the _source field

id

String — The document ID

index

String — The name of the index

type

String — The type of the document

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

fields

String, String[], Boolean — A comma-separated list of fields to return in the response

parent

String — The ID of the parent document

preference

String — Specify the node or shard the operation should be performed on (default: random)

realtime

Boolean — Specify whether to perform the operation in realtime or search mode

refresh

Boolean — Refresh the shard containing the document before performing the operation

routing

String — Specific routing value

_source

String, String[], Boolean — True or false to return the _source field or not, or a list of fields to return

_sourceExclude

String, String[], Boolean — A list of fields to exclude from the returned _source field

_sourceInclude

String, String[], Boolean — A list of fields to extract and return from the _source field

id

String — The document ID

index

String — The name of the index

type

String — The type of the document (use _all to fetch the first document matching the ID across all types)

back to top

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

parent

String — The ID of the parent document

preference

String — Specify the node or shard the operation should be performed on (default: random)

realtime

Boolean — Specify whether to perform the operation in realtime or search mode

refresh

Boolean — Refresh the shard containing the document before performing the operation

routing

String — Specific routing value

_source

String, String[], Boolean — True or false to return the _source field or not, or a list of fields to return

_sourceExclude

String, String[], Boolean — A list of fields to exclude from the returned _source field

_sourceInclude

String, String[], Boolean — A list of fields to extract and return from the _source field

version

Number — Explicit version number for concurrency control

versionType

String — Specific version type

Options
  • "internal"
  • "external"

id

String — The document ID

index

String — The name of the index

type

String — The type of the document; use _all to fetch the first document matching the ID across all types

back to top

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

consistency

String — Explicit write consistency setting for the operation

Options
  • "one"
  • "quorum"
  • "all"

[opType=index]

String — Explicit operation type

Options
  • "index"
  • "create"

parent

String — ID of the parent document

percolate

String — Percolator queries to execute while indexing the document

refresh

Boolean — Refresh the index after performing the operation

[replication=sync]

String — Specific replication type

Options
  • "sync"
  • "async"

routing

String — Specific routing value

timeout

DurationString — Explicit operation timeout

timestamp

Timestamp — Explicit timestamp for the document

ttl

DurationString — Expiration time for the document

version

Number — Explicit version number for concurrency control

versionType

String — Specific version type

Options
  • "internal"
  • "external"

id

String — Document ID

index

String — The name of the index

type

String — The type of the document

body

Object, JSON — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

fields

String, String[], Boolean — A comma-separated list of fields to return in the response

preference

String — Specify the node or shard the operation should be performed on (default: random)

realtime

Boolean — Specify whether to perform the operation in realtime or search mode

refresh

Boolean — Refresh the shard containing the document before performing the operation

_source

String, String[], Boolean — True or false to return the _source field or not, or a list of fields to return

_sourceExclude

String, String[], Boolean — A list of fields to exclude from the returned _source field

_sourceInclude

String, String[], Boolean — A list of fields to extract and return from the _source field

index

String — The name of the index

type

String — The type of the document

body

Object, JSON — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

boostTerms

Number — The boost factor

maxDocFreq

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

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

minWordLen

Number — The minimum length of the word: shorter words will be ignored

mltFields

String, String[], Boolean — Specific fields to perform the query against

percentTermsToMatch

Number — How many terms have to match in order to consider the document a match (default: 0.3)

routing

String — Specific routing value

searchFrom

Number — The offset from which to return results

searchIndices

String, String[], Boolean — A comma-separated list of indices to perform the query against (default: the index containing the document)

searchQueryHint

String — The search query hint

searchScroll

String — A scroll search request definition

searchSize

Number — The number of documents to return (default: 10)

searchSource

String — A specific search request definition (instead of using the request body)

searchType

String — Specific search type (eg. dfs_then_fetch, count, etc)

searchTypes

String, String[], Boolean — A comma-separated list of types to perform the query against (default: the same type as the document)

stopWords

String, String[], Boolean — A list of stop words to be ignored

id

String — The document ID

index

String — The name of the index

type

String — The type of the document (use _all to fetch the first document matching the ID across all types)

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

searchType

String — Search operation type

Options
  • "query_then_fetch"
  • "query_and_fetch"
  • "dfs_query_then_fetch"
  • "dfs_query_and_fetch"
  • "count"
  • "scan"

index

String, String[], Boolean — A comma-separated list of index names to use as default

type

String, String[], Boolean — A comma-separated list of document types to use as default

body

Object[], JSONLines — The request body, as either an array of objects or new-line delimited JSON objects. See the elasticsearch docs for details about what can be specified here.

back to top

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

preferLocal

Boolean — With true, specify that a local shard should be used if available, with false, use a random shard (default: true)

index

String — The name of the index with a registered percolator query

type

String — The document type

body

Object, JSON — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

scroll

DurationString — Specify how long a consistent view of the index should be maintained for scrolled search

scrollId

String — The scroll ID

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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.

Tip

bodybuilder, esq, and elastic.js 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

analyzer

String — The analyzer to use for the query string

analyzeWildcard

Boolean — Specify whether wildcard and prefix queries should be analyzed (default: false)

[defaultOperator=OR]

String — The default operator for query string query (AND or OR)

Options
  • "AND"
  • "OR"

df

String — The field to use as default where no field prefix is given in the query string

explain

Boolean — Specify whether to return detailed information about score computation as part of a hit

fields

String, String[], Boolean — A comma-separated list of fields to return as part of a hit

from

Number — Starting offset (default: 0)

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

indicesBoost

String, String[], Boolean — Comma-separated list of index boosts

lenient

Boolean — Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

lowercaseExpandedTerms

Boolean — Specify whether query terms should be lowercased

preference

String — Specify the node or shard the operation should be performed on (default: random)

q

String — Query in the Lucene query string syntax

routing

String, String[], Boolean — A comma-separated list of specific routing values

scroll

DurationString — Specify how long a consistent view of the index should be maintained for scrolled search

searchType

String — Search operation type

Options
  • "query_then_fetch"
  • "query_and_fetch"
  • "dfs_query_then_fetch"
  • "dfs_query_and_fetch"
  • "count"
  • "scan"

size

Number — Number of hits to return (default: 10)

sort

String, String[], Boolean — A comma-separated list of <field>:<direction> pairs

source

String — The URL-encoded request definition using the Query DSL (instead of using request body)

_source

String, String[], Boolean — True or false to return the _source field or not, or a list of fields to return

_sourceExclude

String, String[], Boolean — A list of fields to exclude from the returned _source field

_sourceInclude

String, String[], Boolean — A list of fields to extract and return from the _source field

stats

String, String[], Boolean — Specific tag of the request for logging and statistical purposes

suggestField

String — Specify which field to use for suggestions

[suggestMode=missing]

String — Specify suggest mode

Options
  • "missing"
  • "popular"
  • "always"

suggestSize

Number — How many suggestions to return in response

suggestText

String — The source text for which the suggestions should be returned

timeout

DurationString — Explicit operation timeout

version

Boolean — Specify whether to return document version as part of a hit

index

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

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

preference

String — Specify the node or shard the operation should be performed on (default: random)

routing

String — Specific routing value

source

String — The URL-encoded request definition (instead of using request body)

index

String, String[], Boolean — A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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 script which 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

consistency

String — Explicit write consistency setting for the operation

Options
  • "one"
  • "quorum"
  • "all"

fields

String, String[], Boolean — A comma-separated list of fields to return in the response

lang

String — The script language (default: mvel)

parent

String — ID of the parent document

percolate

String — Perform percolation during the operation; use specific registered query name, attribute, or wildcard

refresh

Boolean — Refresh the index after performing the operation

[replication=sync]

String — Specific replication type

Options
  • "sync"
  • "async"

retryOnConflict

Number — Specify how many times should the operation be retried when a conflict occurs (default: 0)

routing

String — Specific routing value

script

String — The URL-encoded script definition (instead of using request body)

timeout

DurationString — Explicit operation timeout

timestamp

Timestamp — Explicit timestamp for the document

ttl

DurationString — Expiration time for the document

version

Number — Explicit version number for concurrency control

versionType

String — Specific version type

Options
  • "internal"
  • "external"

id

String — Document ID

index

String — The name of the index

type

String — The type of the document

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

[level=cluster]

String — Specify the level of detail for returned information

Options
  • "cluster"
  • "indices"
  • "shards"

local

Boolean — Return local information, do not retrieve the state from master node (default: false)

masterTimeout

DurationString — Explicit operation timeout for connection to master node

timeout

DurationString — Explicit operation timeout

waitForActiveShards

Number — Wait until the specified number of shards is active

waitForNodes

String — Wait until the specified number of nodes is available

waitForRelocatingShards

Number — Wait until the specified number of relocating shards is finished

waitForStatus

String — Wait until cluster is in a specific state

Options
  • "green"
  • "yellow"
  • "red"

index

String — Limit the information returned to a specific index

back to top

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.

Warning

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

interval

DurationString — The interval for the second sampling of threads

snapshots

Number — Number of samples of thread stacktrace (default: 10)

threads

Number — Specify the number of threads to provide information for (default: 3)

type

String — The type to sample (default: cpu)

Options
  • "cpu"
  • "wait"
  • "block"

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

back to top

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

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

DurationString — 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

back to top

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

delay

DurationString — Set the delay for the operation (default: 1s)

exit

Boolean — Exit the JVM as well (default: true)

nodeId

String, String[], Boolean — A comma-separated list of node IDs or names to perform the operation on; use _local to perform the operation on the node you’re connected to, leave empty to perform the operation on all nodes

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

all

Boolean — Return all available information

clear

Boolean — Reset the default level of detail

fields

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

Options
  • "all"
  • "fs"
  • "http"
  • "indices"
  • "jvm"
  • "network"
  • "os"
  • "process"
  • "thread_pool"
  • "transport"

metric

String — Limit the information returned for indices family to a specific metric

Options
  • "completion"
  • "docs"
  • "fielddata"
  • "filter_cache"
  • "flush"
  • "get"
  • "id_cache"
  • "indexing"
  • "merges"
  • "refresh"
  • "search"
  • "store"
  • "warmer"

nodeId

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

back to top

cluster.pendingTasksedit

client.cluster.pendingTasks([params, [callback]])

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

local

Boolean — Return local information, do not retrieve the state from master node (default: false)

masterTimeout

DurationString — Specify timeout for connection to master

back to top

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

dryRun

Boolean — Simulate the operation only and return the resulting state

filterMetadata

Boolean — Don’t return cluster state metadata (default: false)

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

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

DurationString — Specify timeout for connection to master

back to top

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

analyzer

String — The name of the analyzer to use

field

String — Use the analyzer configured for this field (instead of passing the analyzer name)

filters

String, String[], Boolean — A comma-separated list of filters to use for the analysis

index

String — The name of the index to scope the operation

preferLocal

Boolean — With true, specify that a local shard should be used if available, with false, use a random shard (default: true)

text

String — The text on which the analysis should be performed (when request body is not used)

tokenizer

String — The name of the tokenizer to use for the analysis

[format=detailed]

String — Format of the output

Options
  • "detailed"
  • "text"

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

fieldData

Boolean — Clear field data

fielddata

Boolean — Clear field data

fields

String, String[], Boolean — A comma-separated list of fields to clear when using the field_data parameter (default: all)

filter

Boolean — Clear filter caches

filterCache

Boolean — Clear filter caches

filterKeys

Boolean — A comma-separated list of keys to clear when using the filter_cache parameter (default: all)

id

Boolean — Clear ID caches for parent/child

idCache

Boolean — Clear ID caches for parent/child

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

index

String, String[], Boolean — A comma-separated list of index name to limit the operation

recycler

Boolean — Clear the recycler cache

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

timeout

DurationString — Explicit operation timeout

masterTimeout

DurationString — Specify timeout for connection to master

index

String — The name of the index

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

timeout

DurationString — Explicit operation timeout

masterTimeout

DurationString — Specify timeout for connection to master

index

String — The name of the index

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

timeout

DurationString — Explicit operation timeout

masterTimeout

DurationString — Specify timeout for connection to master

index

String, String[], Boolean — A comma-separated list of indices to delete; use _all or empty string to delete all indices

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

timeout

DurationString — Explicit timestamp for the document

masterTimeout

DurationString — Specify timeout for connection to master

index

String — The name of the index with an alias

name

String — The name of the alias to be deleted

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

masterTimeout

DurationString — Specify timeout for connection to master

index

String, String[], Boolean — A comma-separated list of index names; use _all for all indices

type

String — The name of the document type to delete

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

timeout

DurationString — Explicit operation timeout

masterTimeout

DurationString — Specify timeout for connection to master

name

String — The name of the template

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

masterTimeout

DurationString — Specify timeout for connection to master

index

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

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

index

String, String[], Boolean — A comma-separated list of indices to check

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

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 return

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

index

String, String[], Boolean — A comma-separated list of index names; use _all to check the types across all indices

type

String, String[], Boolean — A comma-separated list of document types to check

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

force

Boolean — Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)

full

Boolean — If set to true a new index writer is created and settings that have been changed related to the index writer will be refreshed. Note: if a full flush is required for a setting to take effect this will be part of the settings update process and it not required to be executed by the user. (This setting can be considered as internal)

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

refresh

Boolean — Refresh the index after performing the operation

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string for all indices

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

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 return

back to top

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

timeout

DurationString — Explicit operation timeout

index

String, String[], Boolean — A comma-separated list of index names to filter aliases

back to top

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

includeDefaults

Boolean — Whether the default mapping values should be returned as well

index

String, String[], Boolean — A comma-separated list of index names

type

String, String[], Boolean — A comma-separated list of document types

field

String, String[], Boolean — A comma-separated list of fields

back to top

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

index

String, String[], Boolean — A comma-separated list of index names

type

String, String[], Boolean — A comma-separated list of document types

back to top

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

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string to perform the operation on all indices

back to top

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

name

String — The name of the template

back to top

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

index

String, String[], Boolean — A comma-separated list of index names to restrict the operation; use _all to perform the operation on all indices

name

String — The name of the warmer (supports wildcards); leave empty to get all warmers

type

String, String[], Boolean — A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types

back to top

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

timeout

DurationString — Explicit operation timeout

masterTimeout

DurationString — Specify timeout for connection to master

index

String — The name of the index

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

flush

Boolean — Specify whether the index should be flushed after performing the operation (default: true)

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

maxNumSegments

Number — The number of segments the index should be merged into (default: dynamic)

onlyExpungeDeletes

Boolean — Specify whether the operation should only expunge deleted documents

operationThreading

anything — TODO: ?

refresh

Boolean — Specify whether the index should be refreshed after performing the operation (default: true)

waitForMerge

Boolean — Specify whether the request should block until the merge process is finished (default: true)

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string to perform the operation on all indices

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

timeout

DurationString — Explicit timestamp for the document

masterTimeout

DurationString — Specify timeout for connection to master

index

String — The name of the index with an alias

name

String — The name of the alias to be created or updated

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

ignoreConflicts

Boolean — Specify whether to ignore conflicts while updating the mapping (default: false)

timeout

DurationString — Explicit operation timeout

masterTimeout

DurationString — Specify timeout for connection to master

index

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

body

Object, JSON — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

masterTimeout

DurationString — Specify timeout for connection to master

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string to perform the operation on all indices

body

Object, JSON — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

order

Number — The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)

timeout

DurationString — Explicit operation timeout

masterTimeout

DurationString — Specify timeout for connection to master

name

String — The name of the template

body

Object, JSON — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

masterTimeout

DurationString — Specify timeout for connection to master

index

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

String, String[], Boolean — A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types

body

Object, JSON — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

operationThreading

anything — TODO: ?

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string to perform the operation on all indices

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

operationThreading

anything — TODO: ?

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string to perform the operation on all indices

back to top

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

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string for all indices

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

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 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 metric (supports wildcards)

fields

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 statistics

idCache

Boolean — Return information about ID cache

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

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

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

Options
  • "completion"
  • "docs"
  • "fielddata"
  • "filter_cache"
  • "flush"
  • "get"
  • "groups"
  • "id_cache"
  • "ignore_indices"
  • "indexing"
  • "merge"
  • "refresh"
  • "search"
  • "store"
  • "warmer"

searchGroups

String, String[], Boolean — A comma-separated list of search groups to include in the search statistics

back to top

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

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

operationThreading

anything — TODO: ?

recovery

Boolean — Return information about shard recovery

snapshot

Boolean — TODO: ?

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string to perform the operation on all indices

back to top

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

timeout

DurationString — Request timeout

masterTimeout

DurationString — Specify timeout for connection to master

index

String, String[], Boolean — A comma-separated list of index names to filter aliases

body

Object, JSON — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

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

explain

Boolean — Return detailed information about the error

[ignoreIndices=none]

String — When performed on multiple indices, allows to ignore missing ones

Options
  • "none"
  • "missing"

operationThreading

anything — TODO: ?

source

String — The URL-encoded query definition (instead of using the request body)

q

String — Query in the Lucene query string syntax

index

String, String[], Boolean — A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices

type

String, String[], Boolean — A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top