Repository navigation
docs: mention querying durable state changes by slices - #3595
Merged
Merged
Conversation
Motivation: The durable state Persistence Query page says the query is only based on tags, but persistence-query also provides DurableStateStoreBySliceQuery with changesBySlices and currentChangesBySlices. Modification: Describe both ways of querying durable state changes: by tag with DurableStateStoreQuery, and by slices with DurableStateStoreBySliceQuery (marked @ApiMayChange), including what a slice is and the sliceForPersistenceId/sliceRanges helpers, and link to the EventsBySlice section. Note that support depends on the state store plugin. Result: Users know the by-slices query exists. Tests: - Not run - docs only References: None - found during a review of the docs
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
The durable state Persistence Query page says the query is only based
on tags, but persistence-query also provides
DurableStateStoreBySliceQuery with changesBySlices and
currentChangesBySlices.
Modification
Describe both ways of querying durable state changes: by tag with
DurableStateStoreQuery, and by slices with DurableStateStoreBySliceQuery
(marked @ApiMayChange), including what a slice is and the
sliceForPersistenceId/sliceRanges helpers, and link to the
EventsBySlice section. Note that support depends on the state store
plugin.
Result
Users know the by-slices query exists.
Tests
References
None - found during a review of the docs