WARNING: Version 5.6 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Refresh cat APIs »
Elastic Docs ›Elasticsearch Reference [5.6] ›Indices APIs

Force Merge

edit

Force Merge

edit

The force merge API allows to force merging of one or more indices through an API. The merge relates to the number of segments a Lucene index holds within each shard. The force merge operation allows to reduce the number of segments by merging them.

This call will block until the merge is complete. If the http connection is lost, the request will continue in the background, and any new requests will block until the previous force merge is complete.

POST /twitter/_forcemerge

Request Parameters

edit

The force merge API accepts the following request parameters:

max_num_segments

The number of segments to merge to. To fully merge the index, set it to 1. Defaults to simply checking if a merge needs to execute, and if so, executes it.

only_expunge_deletes

Should the merge process only expunge segments with deletes in it. In Lucene, a document is not deleted from a segment, just marked as deleted. During a merge process of segments, a new segment is created that does not have those deletes. This flag allows to only merge segments that have deletes. Defaults to false. Note that this won’t override the index.merge.policy.expunge_deletes_allowed threshold.

flush

Should a flush be performed after the forced merge. Defaults to true.

Multi Index

edit

The force merge API can be applied to more than one index with a single call, or even on _all the indices.

POST /kimchy,elasticsearch/_forcemerge

POST /_forcemerge
« Refresh cat APIs »