RDoc-3912 Document Search() behavior when analyzer splits a single term into multiple tokens by Danielle9897 · Pull Request #2586 · ravendb/docs

Danielle9897 · 2026-08-02T19:24:18Z

Issue link

https://issues.hibernatingrhinos.com/issue/RDoc-3912/Document-Search-behavior-when-analyzer-splits-a-single-term-into-multiple-tokens

Additional description

in: ..\client-api\session\querying\text-search\content\_full-text-search-csharp.mdx
Added new section: Search with analyzer-generated phrases
in: ..\indexes\querying\content\_searching-csharp.mdx
Added new section: Analyzer-generated phrases in static-index searches
in: ..\indexes\content\_using-analyzers-csharp.mdx
Added info under: Analyzers at query time
Added info under: Creating custom analyzers
in: ..\session\querying\text-search\content\_proximity-search-csharp.mdx
Added info under: Proximity search (0 distance)
in: ..\migration\server\previous-versions-server-breaking-changes.mdx
Added new section: Full-text search when the analyzer splits a search term
Apply to all other client articles (Node.js, Python, Java, php)
Fix text and layout as needed
Fix broken links
Apply to v6.2, v7.0, v7.1, v7.2

Type of change

Changes in docs URLs

No changes in docs URLs
Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

No changes in UX/UI
Changes in UX/UI (include screenshots and description)

Danielle9897 · 2026-08-02T19:51:31Z

=======================================
C#:
@maciejaszyk pls review these files:

../client-api/session/querying/text-search/content/_full-text-search-csharp.mdx
../client-api/session/querying/text-search/content/_proximity-search-csharp.mdx
../indexes/content/_using-analyzers-csharp.mdx
../indexes/querying/content/_searching-csharp.mdx
../migration/server/previous-versions-server-breaking-changes.mdx

======================================
Python:
@poissoncorp pls review these files:

../client-api/session/querying/text-search/content/_full-text-search-python.mdx
../client-api/session/querying/text-search/content/_proximity-search-python.mdx
../indexes/content/_using-analyzers-python.mdx
../indexes/querying/content/_searching-python.mdx

=======================================
Node.js:
@M4xymm pls review these files:

../client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx
../client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx
../indexes/content/_using-analyzers-nodejs.mdx
../indexes/querying/content/_searching-nodejs.mdx

==========================================
Java:
@LielNagar pls review these files:

../client-api/session/querying/text-search/content/_full-text-search-java.mdx
../client-api/session/querying/text-search/content/_proximity-search-java.mdx
../indexes/content/_using-analyzers-java.mdx
../indexes/querying/content/_searching-java.mdx

===========================================

maciejaszyk

LGTM

LielNagar · 2026-08-04T08:36:28Z

+
+* The queried index must use the **Lucene** search engine.  
+  [Corax](../../../../../indexes/search-engine/corax.mdx#unsupported-features) does not support proximity over the `search` method,  
+  and running such a query against a Corax index throws a `NotSupportedInCoraxException`.  


In java the client will throw InvalidQueryException

but
https://github.com/ravendb/ravendb/blob/d8e955bb5becaa2fc1fcb745a90daadff2fa8d15/src/Raven.Server/Documents/Indexes/Persistence/Corax/CoraxQueryBuilder.cs#L1042
throws NotSupportedInCoraxException
?

Server indeed throws NotSupportedInCoraxException, but Java client process the exception and throws its own client exception

The client sends where proximity(search(notes, $p0), 0), so ToCoraxQuery is invoked on the outer expression first and GetMethodType returns MethodType.Proximity - not Search. That switch has no case MethodType.Proximity, so it falls straight to default: → QueryMethod.ThrowMethodNotSupported → InvalidQueryException

@LielNagar
Modified to InvalidQueryException

LielNagar · 2026-08-04T09:00:03Z

+* A **proximity search** retrieves documents containing search terms that are located within a specified distance from each other.
+  The distance is measured by the number of intermediate terms.
+
+* Proximity search is available only via [DocumentQuery](../../../../../querying/document-query/what-is-document-query.mdx) or RQL.  


In Java proximity is available on both session.query() and session.advanced().documentQuery() APIs, or RQL

done + added session.query() examples

M4xymm · 2026-08-04T09:56:43Z


        // Configure the index-field for FTS:
        // Set 'Search' on index-field 'employeeNotes'
        this.index("employeeNotes", "Search");


Wrong field name. The map defines employeeData

Suggested change

this.index("employeeNotes", "Search");

this.index("employeeData", "Search");

M4xymm · 2026-08-04T09:59:16Z

RemoveWildcardsAnalyzer is not defined. The template literal above is declared as removeWildcardsanalyzer (lowercase a), so this throws a ReferenceError

also use camelCase for naming conventions in js

M4xymm · 2026-08-04T10:03:16Z

Pre-existing naming slip: the prose says PutServerWideOperation, while the actual class, used in the tab right below, is PutServerWideAnalyzersOperation.

…rm into multiple tokens

Danielle9897 requested review from LielNagar, M4xymm, maciejaszyk and poissoncorp August 2, 2026 19:54

maciejaszyk approved these changes Aug 3, 2026

View reviewed changes

LielNagar suggested changes Aug 4, 2026

View reviewed changes

M4xymm suggested changes Aug 4, 2026

View reviewed changes

Danielle9897 requested review from LielNagar and M4xymm August 4, 2026 13:46

poissoncorp approved these changes Aug 5, 2026 •

edited

Loading

View reviewed changes

M4xymm approved these changes Aug 5, 2026

View reviewed changes

Danielle9897 force-pushed the RDoc-3912-searchBehavior branch from 24ee88f to 6d2bab1 Compare August 13, 2026 08:35

LielNagar approved these changes Aug 13, 2026

View reviewed changes

Danielle9897 and others added 5 commits August 13, 2026 13:57

RDoc-3912 Document Search() behavior when analyzer splits a single te…

05e6d07

…rm into multiple tokens

RDoc-3912 fix comments for java

3c10163

RDoc-3912 fix comments for node.js

c28a273

RDoc-3912 fix Python proximity 0 example and Corax exception name

6660b13

RDoc-3912 fix exception type

ffbde2c

Danielle9897 force-pushed the RDoc-3912-searchBehavior branch from 6d2bab1 to ffbde2c Compare August 13, 2026 11:01

ppekrol merged commit a8b2aeb into ravendb:main Aug 13, 2026
1 check passed

	this.index("employeeNotes", "Search");
	this.index("employeeData", "Search");

Uh oh!

Conversation

Danielle9897 commented Aug 2, 2026

Issue link

Additional description

Type of change

Changes in docs URLs

Changes in UX/UI

Uh oh!

Danielle9897 commented Aug 2, 2026

Uh oh!

maciejaszyk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Danielle9897 Aug 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Danielle9897 Aug 13, 2026 •

edited

Loading