Skip to content

docs: add FTS docs#5888

Merged
prrao87 merged 8 commits intomainfrom
feat/add-fts
Feb 11, 2026
Merged

docs: add FTS docs#5888
prrao87 merged 8 commits intomainfrom
feat/add-fts

Conversation

@prrao87
Copy link
Copy Markdown
Contributor

@prrao87 prrao87 commented Feb 4, 2026

We lack docs for how to create and query an FTS index in Lance. This PR adds detailed docs, based on the latest v1.0.4 pylance API. All code snippets have been tested with the latest stable release and I gave it another pass with GPT 5.2 to ensure accuracy per the latest Rust code in tokenizer.rs.

@prrao87 prrao87 requested a review from jackye1995 February 4, 2026 22:40
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 4, 2026

ACTION NEEDED
Lance follows the Conventional Commits specification for release automation.

The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification.

For details on the error please inspect the "PR Title Check" action.

@prrao87 prrao87 changed the title Add FTS docs feat: add FTS docs Feb 4, 2026
@prrao87 prrao87 changed the title feat: add FTS docs docs: add FTS docs Feb 4, 2026
@prrao87 prrao87 added the documentation Improvements or additions to documentation label Feb 4, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 4, 2026

PR Review: docs: add FTS docs

Good documentation addition covering FTS capabilities in Lance. The content is well-organized and the code examples are consistent with the current Python API.

P1: Documentation Link Error

In docs/src/quickstart/vector-search.md, the "Next Steps" section links to the wrong file:

Check out **[Full-text Search](../quickstart/versioning.md)**, where we show...

This should link to full-text-search.md, not versioning.md:

Check out **[Full-text Search](../quickstart/full-text-search.md)**, where we show...

The API examples appear accurate based on current implementation in python/python/lance/dataset.py and python/python/lance/query.py.

@prrao87 prrao87 requested a review from BubbleCal February 11, 2026 14:32
Copy link
Copy Markdown
Contributor

@BubbleCal BubbleCal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's worth mentioning fuzzy search

LGTM overall

Comment thread docs/src/quickstart/full-text-search.md Outdated

### Index Maintenance

As your data evolves over time, it's important to periodically rebuild your indexes to maintain optimal search performance. When you add, modify, or delete documents, the existing index may become less efficient. Consider scheduling regular index rebuilds, especially for datasets with frequent updates.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does one update the existing FTS index in Lance? @BubbleCal

@prrao87
Copy link
Copy Markdown
Contributor Author

prrao87 commented Feb 11, 2026

Good point about fuzzy search! Will add.

Copy link
Copy Markdown
Contributor

@jackye1995 jackye1995 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me!

@prrao87
Copy link
Copy Markdown
Contributor Author

prrao87 commented Feb 11, 2026

Give me till end of day to finalize the fuzzy search doc and will add that in. Thanks for reviewing!

@prrao87 prrao87 merged commit eb0e61f into main Feb 11, 2026
4 checks passed
@prrao87 prrao87 deleted the feat/add-fts branch February 11, 2026 23:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants