Clarify documentation of scroll_id #29424
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Scroll API may return the same scroll ID for multiple requests due to server side state. This is not clear from the current documentation.
dnhatn
added
>docs
|
Pinging @elastic/es-search-aggs |
|
test this please. |
jpountz
approved these changes
Apr 9, 2018
|
I'm not sure if this change adds confusion in a different way now. It could now be read that the response may or may not return a scroll id field which I think is a bigger source of confusion than whether or not the scroll id might be the same as the previous one. We need to be clear that the scroll id is always returned in the response. I'm not really sure about the advantage of the documentation stating that the scroll id may or may not change between responses since this doesn't change the fact that the user should always use the scroll id returned to them in the most recent response regardless of whether it changed. |
|
Stating that it will always be new is more misleading in my opinion. The whole reason I made this change was spending the morning tearing my hair out because I wasn't getting a new scroll id, thinking I was repeating the same request over and over.
… On 9/04/2018, at 20:03, Colin Goodheart-Smithe ***@***.***> wrote:
I'm not sure if this change adds confusion in a different way now. It could now be read that the response may or may not return a scroll id field which I think is a bigger source of confusion than whether or not the scroll id might be the same as the previous one. We need to be clear that the scroll id is always returned in the response.
I'm not really sure about the advantage of the documentation stating that the scroll id may or may not change between responses since this doesn't change the fact that the user should always use the scroll id returned to them in the most recent response regardless of whether it changed.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute the thread.
|
|
Ok, I understand the motive for your change much better now. Maybe we can word it in a way that conveys both that the scroll id will be returned in every response and that the returned scroll id may not change between responses all the time? |
colings86
approved these changes
Apr 26, 2018
There was a problem hiding this comment.
@SarenCurrie sorry for the delay in getting back to this.
Thanks for updating the wording. I'll merge and back port this change shortly
colings86
pushed a commit
that referenced
this pull request
Apr 26, 2018
* Clarify documentation of scroll_id The Scroll API may return the same scroll ID for multiple requests due to server side state. This is not clear from the current documentation. * Further clarify scroll ID return behaviour
colings86
pushed a commit
that referenced
this pull request
Apr 26, 2018
* Clarify documentation of scroll_id The Scroll API may return the same scroll ID for multiple requests due to server side state. This is not clear from the current documentation. * Further clarify scroll ID return behaviour
colings86
pushed a commit
that referenced
this pull request
Apr 26, 2018
* Clarify documentation of scroll_id The Scroll API may return the same scroll ID for multiple requests due to server side state. This is not clear from the current documentation. * Further clarify scroll ID return behaviour
colings86
pushed a commit
that referenced
this pull request
Apr 26, 2018
* Clarify documentation of scroll_id The Scroll API may return the same scroll ID for multiple requests due to server side state. This is not clear from the current documentation. * Further clarify scroll ID return behaviour
|
merged to master and backported to 6.x (6.4), 6.3, 6.2, and 5.6 |
|
Thanks for the contribution @SarenCurrie |
dnhatn
added a commit
that referenced
this pull request
Apr 27, 2018
* 6.x: Watcher: Ensure mail message ids are unique per watch action (#30112) SQL: Correct error message (#30138) SQL: Add BinaryMathProcessor to named writeables list (#30127) Tests: Use buildDir as base for generated-resources (#30191) Fix SliceBuilderTests#testRandom failures Fix edge cases in CompositeKeyExtractorTests (#30175) Document time unit limitations for date histograms (#30177) Remove licenses missed by the migration [DOCS] Updates docker installation package details (#30110) Fix TermsSetQueryBuilder.doEquals() method (#29629) [Monitoring] Remove unhelpful Monitoring tests (#30144) [Test] Fix RenameProcessorTests.testRenameExistingFieldNullValue() (#29655) [test] include oss tar in packaging tests (#30155) TEST: Update settings should go through cluster state (#29682) Add additional shards routing info in ShardSearchRequest (#29533) Reinstate missing documentation (#28781) Clarify documentation of scroll_id (#29424) Fixes Eclipse build for sql jdbc project (#30114) Watcher: Fold two smoke test projects into smoke-test-watcher (#30137)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Scroll API may return the same scroll ID for multiple requests due to server side state. This is not clear from the current documentation.