Add documentation of proposed new Querying API [draft] #298
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
…into ephys/querying-v2-api
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 PR isn't meant to be merged.
This is an attempt at a documentation-first approach to the new querying API. I've attempted to cover all use cases that people have regularly requested.
It's build on top of the Query Builder RFC and the Advanced Literals RFC. It also introduces many breaking changes. I don't expect to release this in v7 (it should probably be its own major release considering the importance of the changes).
It adds the ability to do arbitrary joins & subQueries. Allowing us to lock down the
includeAPI to a set of safe, controlled, use cases as users can fall back to joins & subQueries ifincludedoesn't cover their use case.