WARNING: Version 1.3 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 Guide [1.3] ›Indices APIs

Optimize

edit

Optimize

edit

The optimize API allows to optimize one or more indices through an API. The optimize process basically optimizes the index for faster search operations (and relates to the number of segments a Lucene index holds within each shard). The optimize operation allows to reduce the number of segments by merging them.

$ curl -XPOST 'http://localhost:9200/twitter/_optimize'

Request Parameters

edit

The optimize API accepts the following request parameters:

max_num_segments

The number of segments to optimize to. To fully optimize 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 optimize 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 optimize. Defaults to true.

wait_for_merge

Should the request wait for the merge to end. Defaults to true. Note, a merge can potentially be a very heavy operation, so it might make sense to run it set to false.

force

Force a merge operation, even if there is a single segment in the shard with no deletions. [1.1.0] Added in 1.1.0.

Multi Index

edit

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

$ curl -XPOST 'http://localhost:9200/kimchy,elasticsearch/_optimize'

$ curl -XPOST 'http://localhost:9200/_optimize'
« Refresh cat APIs »