Skip to content

docs: document nested field paths for FTS indexes#250

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/23a7998f
Open

docs: document nested field paths for FTS indexes#250
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/23a7998f

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 20, 2026

Summary

Document that FTS indexes accept dotted paths to text leaves inside struct columns, on both sync and async APIs.

Changes

  • Add a "Nested field paths" section to the FTS index page covering supported paths, async equivalence, and the error cases for struct containers, non-text leaves, and missing paths.
  • Add a testable fts_index_nested snippet that creates an index on payload.text and runs MatchQuery / PhraseQuery against it.
  • Export the generated snippet from the indexing snippets module so the docs page can import it.

Context

The upstream PR adds regression tests covering nested FTS field paths (sync and async match, phrase, and hybrid queries) and locks in the error boundary introduced in lancedb/lancedb#3408. The behavior was previously undocumented.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 20, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lancedb-bcbb4faf 🟢 Ready View Preview May 20, 2026, 10:57 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants