Force merge

Introduced 1.0

The force merge API operation forces a merge on the shards of one or more indexes. For a data stream, the API forces a merge on the shards of the stream’s backing index.

The merge operation

In OpenSearch, a shard is a Lucene index, which consists of segments (or segment files). Segments store the indexed data. Periodically, smaller segments are merged into larger ones and the larger segments become immutable. Merging reduces the overall number of segments on each shard and frees up disk space.

OpenSearch performs background segment merges that produce segments no larger than index.merge.policy.max_merged_segment (the default is 5 GB).

Deleted documents

When a document is deleted from an OpenSearch index, it is not deleted from the Lucene segment but is rather only marked to be deleted. When the segment files are merged, deleted documents are removed (or expunged). Thus, merging also frees up space occupied by documents marked as deleted.

Force Merge API

In addition to periodic merging, you can force a segment merge using the Force Merge API.

Use the Force Merge API on an index only after all write requests sent to the index are completed. The force merge operation can produce very large segments. If write requests are still sent to the index, then the merge policy does not merge these segments until they primarily consist of deleted documents. This can increase disk space usage and lead to performance degradation.

When you call the Force Merge API, the call is blocked until merge completion. If during this time the connection is lost, the force merge operation continues in the background. New force merge requests sent to the same index will be blocked until the currently running merge operation is complete.

Force merging multiple indexes

To force merge multiple indexes, you can call the Force Merge API on the following index combinations:

• Multiple indexes
• One or more data streams containing multiple backing indexes
• One or more index aliases pointing to multiple indexes
• All data streams and indexes in a cluster

When you force merge multiple indexes, the merge operation is executed on each shard of a node sequentially. When the force merge operation is in progress, the storage for the shard temporarily increases so that all segments can be rewritten into a new segment. When max_num_segments is set to 1, the storage for the shard temporarily doubles.

Force merging data streams

It can be useful to force merge data streams in order to manage a data stream’s backing indexes, especially after a rollover operation. Time-based indexes receive indexing requests only during a specified time period. Once that time period has elapsed and the index receives no more write requests, you can force merge segments of all index shards into one segment. Searches on single-segment shards are more efficient because they use simpler data structures.

Path and HTTP methods

POST /_forcemerge
POST /<index>/_forcemerge/

Path parameters

The following table lists the available path parameters. All path parameters are optional.

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Example requests

The following examples show how to use the Force merge API.

Force merge a specific index

The following example force merges a specific index:

POST /testindex1/_forcemerge

copy

Force merge multiple indexes

The following example force merges multiple indexes:

POST /testindex1,testindex2/_forcemerge

copy

Force merge all indexes

The following example force merges all indexes:

POST /_forcemerge

copy

Force merge a data stream’s backing indexes into one segment

The following example force merges a data stream’s backing indexes into one segment:

POST /.testindex-logs/_forcemerge?max_num_segments=1

copy

Force merge primary shards

The following example force merges an index’s primary shards:

POST /.testindex-logs/_forcemerge?primary_only=true

copy

Example response

{
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  }
}

Response fields

The following table lists all response fields.