IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« count create »
Elastic Docs ›elasticsearch.js ›5.6 API

countPercolate

edit

countPercolate

edit
client.countPercolate([params, [callback]])

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

Params

routing

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

preference

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

ignoreUnavailable

Boolean — Whether specified concrete indices should be ignored when unavailable (missing or closed)

allowNoIndices

Boolean — Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

[expandWildcards=open]

String — Whether to expand wildcard expression to concrete indices that are open, closed or both.

Options
  • "open"
  • "closed"
  • "none"
  • "all"

percolateIndex

String — The index to count percolate the document into. Defaults to index.

percolateType

String — The type to count percolate document into. Defaults to type.

version

Number — Explicit version number for concurrency control

versionType

String — Specific version type

Options
  • "internal"
  • "external"
  • "external_gte"
  • "force"

index

String — The index of the document being count percolated.

type

String — The type of the document being count percolated.

id

String — Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.

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

« count create »