docs: document options.orderByIndexedField on getFromIndex and query - #143
Merged
Conversation
cocodb 1.0.8+ (via libmysql 1.0.52) accepts
`options.orderByIndexedField = {field, direction}` on getFromIndex and query
to order results by an indexed json field. This client already forwards
options verbatim, so this only documents the option and adds tests asserting
it is sent on the wire. getFromNonIndex does not support it (scan api).
Bumps the version to 1.0.29.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UF3R7vkyyRCF9UE2kosVUs
|
3 tasks
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
1 participant
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.
Summary
options.orderByIndexedField = {field, direction: 'ASC'|'DESC'}ongetFromIndexandquery, matching libmysql 1.0.52 and the upcoming cocodb server change.optionsverbatim, so there is no behaviour change; new unit tests assert the option is sent on the wire for both apis.getFromNonIndexis the scan api and does not support the option, as documented.Related PRs
@aicore/libmysqlto 1.0.52 and this client to 1.0.29 and add end-to-end integration tests for the option.Test plan
main; unit tests: 78 passingRollout order
libmysql 1.0.52 (published) → this client (publish 1.0.29) → cocodb server → loginService.
🤖 Generated with Claude Code
https://claude.ai/code/session_01UF3R7vkyyRCF9UE2kosVUs