[dataquery] Add ability to retrieve results of previous run from API #9301
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
This implements the endpoint that is listed as "aspirational" in the dataquery api schema to load the results of a previously run query. It was originally left out for fear of performance issues but with this implementation performance seems to be comparable to without it. This does not implement a frontend to reload query results, but the API functionality is useful for eg api callbacks that want to process the results of a query without the need to re-run it (and the possibility to get different results.)
driusan
commented
Jun 20, 2024
| function ( | ||
| $candid, | ||
| $rowsArray, | ||
| /* @phan-suppress-next-line PhanUnusedClosureParameter */ |
There was a problem hiding this comment.
Closure signature needs to match the callback of DataIteratorBinaryStream, so the unused parameter can't be removed.
driusan
commented
Jun 20, 2024
| * | ||
| * @return ResponseInterface | ||
| */ | ||
| public function countResults(\User $user) : ResponseInterface |
There was a problem hiding this comment.
This function was unused in this class, so I removed it while I was cleaning up the code.
driusan
commented
Jun 20, 2024
| public function queryResults(\User $user) : ResponseInterface | ||
| { | ||
| $db = $this->loris->getDatabaseConnection(); | ||
| // FIXME: Check permissions. Check if count(*) > 0. |
There was a problem hiding this comment.
Sent as a draft until the permissions checks are added, but otherwise the rest of this PR should be ready to be reviewed or tested.
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 implements the endpoint that is listed as "aspirational" in the
dataquery api schema to load the results of a previously run query.
It was originally left out for fear of performance issues but with
this implementation performance seems to be comparable to without
it.
This does not implement a frontend to reload query results, but
the API functionality is useful for i.e. api callbacks that want
to process the results of a query without the need to re-run
it (and the possibility to get different results.)