Skip to content

Reindex conflicts clarification (docs) #40442

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 29, 2019
Merged

Reindex conflicts clarification (docs) #40442

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8244931
Reindex conflicts clarification (docs)
henningandersen Mar 26, 2019
7f76ba8
Reindex conflicts clarification (docs)
henningandersen Mar 29, 2019
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
7 changes: 5 additions & 2 deletions docs/reference/docs/reindex.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,11 @@ POST _reindex
// CONSOLE
// TEST[setup:twitter]

By default, version conflicts abort the `_reindex` process, but you can just
count them by setting `"conflicts": "proceed"` in the request body:
By default, version conflicts abort the `_reindex` process. The `"conflicts"` request body
parameter can be used to instruct `_reindex` to proceed with next document on version conflicts.
Copy link
Contributor

@Tim-Brooks Tim-Brooks Mar 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion:
parameter can be used to instruct _reindex to proceed with the next document on version conflicts.

Copy link
Contributor Author

@henningandersen henningandersen Mar 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 7f76ba8

Notice that the handling of other types of errors is unaffected by the `"conflicts"` parameter.
Copy link
Contributor

@Tim-Brooks Tim-Brooks Mar 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion:
The handling of other types of errors is unaffected by the "conflicts" parameter.

I think that the Notice that part is unnecessary and feels weird for this documentation. If you do want emphasis, I would probably go with "It is important to note that the handling of other error types is unaffected by the..."

Copy link
Contributor Author

@henningandersen henningandersen Mar 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opted for keeping the emphasis with your modified text. The whole point of this PR was this note, since that was the clarification asked for in the issue. See 7f76ba8

By setting `"conflicts": "proceed"` in the request body the `_reindex` process will continue on version conflicts
Copy link
Contributor

@Tim-Brooks Tim-Brooks Mar 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is confusing because "By setting...the _reindex process will continue" seems to suggest that it is the process that is setting the parameter.

Suggestion:
When "conflicts": "proceed" is set in the request body, the _reindex process will continue on version conflicts

Copy link
Contributor Author

@henningandersen henningandersen Mar 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, so good to have native speakers review docs, fixed in 7f76ba8

and return a count of version conflicts encountered:

[source,js]
--------------------------------------------------
Expand Down