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.

« indices.flushSynced indices.get »
Elastic Docs ›elasticsearch.js ›5.6 API

indices.forcemerge

edit

indices.forcemerge

edit
client.indices.forcemerge([params, [callback]])

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)

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"

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: ?

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.flushSynced indices.get »