Enumerable query results #37
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
`TInterface` was renamed to `TResults`, because that matches what it is better (it's the specific implementation of `IPagedQueryResult` being used, not an interface). Adjusted documentation. Reorganized `PagedQueryResults` with regions, separating code that implements `IPagedQueryResults` from the internals and the protected elements used by subclasses.
To keep file size down, this is now split further by the type of element being returned by the methods.
Its implementation (`StreamingQueryResults`) wraps a `PagedQueryResults` and implements both `IEnumerable` and `IAsyncEnumerable` to iterate over *all* results in one pass. This also adds an (internal) `IsActive` property to `IPagedQueryResults` to indicate whether or not any requests have been executed. This is needed by `StreamingQueryResults` to determine whether it should start by executing `Next[Async]()`.
Instead of documenting their return value as "An asynchronous operation returning ...", they now document the actual return value, ignoring the presence of the `Task`.
To keep file size down, this is now split further by the type of element being returned by the methods.
These are like the existing `FindXxx` and `FindXxxAsync` method but they return an `IStreamingQueryResults` instead, allowing for easy bulk processing. This also leverages <inheritdoc> to significantly reduce duplication of doc comments.
These now use <inheritdoc> to copy the documentation from their async counterparts.
These are like the existing `BrowseXxx` and `BrowseXxxAsync` methods but they return an `IStreamingQueryResults` instead, allowing for easy bulk processing. This also adds a few overloads of `Query.BuildExtraText`.
Zastai
added
the
feature
This enables users to call the non-stream browse/search methods (to find out how many results there are in total, for example), and then still easily enumerate the full result set.
|
Keeping this open a bit to allow comments. I'm also preparing a follow-up PR that will make all async methods cancelable (without adding more overloads, so this will break binary (but not source) compatibility and become a 5.0.0 release). |
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.
This adds new
BrowseAll...andFindAll...methods, which return a newIStreamingQueryResultsinterface.That interface includes both
IEnumerableandIAsyncEnumerabe, enabling easy bulk processing of browse/search results usingforeachorawait foreach.Note: this still uses paged requests "under the hood". This means that items might be missed or returned twice, if the result set changes inbetween calls.