Skip to content

docs: nested field paths for scalar, vector, and FTS indexes#245

Merged
prrao87 merged 1 commit into
mainfrom
docs/nested-field-path-indexes
May 29, 2026
Merged

docs: nested field paths for scalar, vector, and FTS indexes#245
prrao87 merged 1 commit into
mainfrom
docs/nested-field-path-indexes

Conversation

@mintlify

@mintlify mintlify Bot commented May 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Document that scalar, vector, and FTS indexes accept nested field paths using dotted notation (e.g. metadata.user_id, image.embedding, nested.text).

Changes

  • Added an "Indexing nested fields" section to the scalar index page with a create_scalar_index + where example.
  • Added an "Indexing nested vector fields" subsection to the vector index page with a create_index + search example.
  • Added an "Indexing nested string fields" section to the FTS index page with a create_fts_index + fts_columns search example.
  • Each section calls out that the canonical dotted path is what you pass in, what list_indices() returns under columns, and what you reference in filters and queries.

Context

Upstream change made native index creation resolve columns using Lance field-path semantics instead of top-level Arrow lookup, and dropped the Python FTS guard that previously rejected dotted paths. Scalar, vector, and FTS indexes now share the same nested-field contract, which wasn't reflected anywhere in the docs.

@mintlify

mintlify Bot commented May 19, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
lancedb-bcbb4faf 🟢 Ready View Preview May 19, 2026, 3:59 PM

@prrao87
prrao87 merged commit 6b265a8 into main May 29, 2026
2 checks passed
@prrao87
prrao87 deleted the docs/nested-field-path-indexes branch May 29, 2026 17:49
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.

1 participant