docs: document scalar indexing on nested struct fields#249
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
Document how to build scalar indexes on fields nested inside struct columns, including how to escape literal dots in field names.
Changes
create_indexwith dot-separated paths (e.g.metadata.user_id) and backtick-escaped segments (e.g.metadata.`user.id`).list_indices()returns the canonical path you passed in, so nested indexes round-trip through index metadata.Context
Upstream fix makes index metadata APIs return canonical Lance field paths instead of leaf names, so nested indexes such as
metadata.user_idand escaped literal-dot fields now round-trip throughlist_indices(). Native index creation also canonicalizes the input path before handing it to Lance, keeping local metadata consistent with the field-path contract.