Skip to content

docs: add fuzzy search and relevance ordering documentation#596

Open
docloulou wants to merge 1 commit intozenstackhq:mainfrom
docloulou:docs/fuzzy-search
Open

docs: add fuzzy search and relevance ordering documentation#596
docloulou wants to merge 1 commit intozenstackhq:mainfrom
docloulou:docs/fuzzy-search

Conversation

@docloulou
Copy link
Copy Markdown

@docloulou docloulou commented Apr 10, 2026

Add documentation for the new fuzzy and fuzzyContains filter
operators and _relevance ordering, available on PostgreSQL only.

linked to : zenstackhq/zenstack#2573

Summary by CodeRabbit

  • Documentation
    • Added detailed documentation for new fuzzy search filter operators exclusively available for PostgreSQL databases, providing powerful and flexible string matching capabilities.
    • Documented their implementation across queries and mutation operations, relevance-based result sorting functionality, required setup prerequisites, and important pagination limitations to consider.

Add documentation for the new `fuzzy` and `fuzzyContains` filter
operators and `_relevance` ordering, available on PostgreSQL only.
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 10, 2026

@docloulou is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: dc7e4595-46b4-4727-aec3-90d3b1ba7899

📥 Commits

Reviewing files that changed from the base of the PR and between 51f95aa and dfc105e.

📒 Files selected for processing (2)
  • docs/orm/api/filter.md
  • docs/orm/api/find.md

Walkthrough

Two documentation files were updated to introduce fuzzy search filtering capabilities for PostgreSQL. The primary documentation in filter.md covers fuzzy search filters with prerequisites, operator semantics, usage examples, and relevance-based sorting. A cross-reference was added to find.md noting fuzzy search relevance sorting availability.

Changes

Cohort / File(s) Summary
Fuzzy search filters documentation
docs/orm/api/filter.md
Added comprehensive guide for fuzzy search filters including fuzzy and fuzzyContains operators, pg_trgm/unaccent prerequisites, operator semantics, examples with combined filters, and relevance-based sorting via _relevance field with pagination cautions.
Sorting reference
docs/orm/api/find.md
Added brief note linking to fuzzy search relevance sorting capabilities from the Sorting section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main change: adding documentation for fuzzy search filters and relevance-based ordering, which is the primary focus of both modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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