Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 1.3] Force merge API final editorial comment #5825

Merged
merged 1 commit into from
Dec 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _api-reference/index-apis/force-merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ When a document is deleted from an OpenSearch index, it is not deleted from the

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. Force merge 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.
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.
{: .warning}

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.
Expand Down Expand Up @@ -120,4 +120,4 @@ The following table lists all response fields.
| `shards` | Object | Contains information about the shards on which the request was executed. |
| `shards.total` | Integer | The number of shards on which the operation was executed. |
| `shards.successful` | Integer | The number of shards on which the operation was successful. |
| `shards.failed` | Integer | The number of shards on which the operation failed. |
| `shards.failed` | Integer | The number of shards on which the operation failed. |
Loading