Skip to content

docs: Add multi-field search documentation for SEARCH function - #3287

Open
airborne12 wants to merge 4 commits into
apache:masterfrom
airborne12:feature/search-lucene-mode-docs
Open

docs: Add multi-field search documentation for SEARCH function#3287
airborne12 wants to merge 4 commits into
apache:masterfrom
airborne12:feature/search-lucene-mode-docs

Conversation

@airborne12

Copy link
Copy Markdown
Member

Summary

Add documentation for the multi-field search feature in SEARCH function, which is being added in apache/doris#59845.

Changes:

  • Added new JSON options syntax format: SEARCH('<search_expression>', '<options_json>')
  • Documented fields array parameter for searching across multiple fields
  • Added type parameter documentation with best_fields and cross_fields modes
  • Documented mode and minimum_should_match parameters for lucene mode

Multi-field Search Modes:

ModeBehaviorUse Case
best_fieldsAll terms must match within the same fieldDocument search where relevance is field-specific
cross_fieldsTerms can match across any fieldEntity search (e.g., person name split across fields)

Related PR


🤖 Generated with Claude Code

airborne12and others added 2 commits January 15, 2026 16:45
… search function
Add documentation for two new features in the SEARCH function:
1. Lucene Boolean Mode:
- JSON-based options parameter (mode, minimum_should_match)
- Left-to-right modifier parsing (MUST/SHOULD/MUST_NOT)
- Behavior comparison table with standard mode
2. Escape Characters:
- Support for escaping special characters in DSL
- Backslash escapes for space, parentheses, colon, backslash
Updated both English and Chinese versions of search-function.md.
Related PR: apache/doris#59394
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add documentation for the multi-field search feature including:
- New JSON options syntax format
- fields array parameter for multi-field search
- type parameter with best_fields and cross_fields modes
- mode parameter for lucene parsing mode
- minimum_should_match parameter
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
airborne12and others added 2 commits January 15, 2026 16:52
Add Chinese translation of multi-field search documentation for SEARCH function:
- New JSON options syntax format
- fields array parameter for multi-field search
- type parameter with best_fields and cross_fields modes
- mode and minimum_should_match parameters
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Remove incorrect claim that "Pure NOT queries return empty results".
NOT queries work correctly in both standard and Lucene modes.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for freeto 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

@airborne12