mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-17 18:35:25 +00:00
df3f681ef0
Refresh flag in optimize is problematic, since the shards refresh is allowed to execute on is different compared to the optimize shards. In order to do optimize and then refresh, they should be executed as separate APIs when needed. closes #3690
53 lines
1.9 KiB
Plaintext
53 lines
1.9 KiB
Plaintext
[[indices-optimize]]
|
|
== Optimize
|
|
|
|
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.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
$ curl -XPOST 'http://localhost:9200/twitter/_optimize'
|
|
--------------------------------------------------
|
|
|
|
[float]
|
|
=== Request Parameters
|
|
|
|
The optimize API accepts the following request parameters:
|
|
|
|
[cols="<,<",options="header",]
|
|
|=======================================================================
|
|
|Name |Description
|
|
|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 allow to
|
|
only merge segments that have deletes. Defaults to `false`.
|
|
|
|
|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`.
|
|
|=======================================================================
|
|
|
|
[float]
|
|
=== Multi Index
|
|
|
|
The optimize API can be applied to more than one index with a single
|
|
call, or even on `_all` the indices.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
$ curl -XPOST 'http://localhost:9200/kimchy,elasticsearch/_optimize'
|
|
|
|
$ curl -XPOST 'http://localhost:9200/_optimize'
|
|
--------------------------------------------------
|