docs: clarify supported regular expression syntax, scope, and anchor behavior - #4924
Open
basisworks wants to merge 1 commit into
Open
docs: clarify supported regular expression syntax, scope, and anchor behavior#4924basisworks wants to merge 1 commit into
basisworks wants to merge 1 commit into
Conversation
…behavior Document that text search regular expressions use Lucene's regular expression engine (via Elasticsearch/Lucene/Solr backends). Clarify how textContainsRegex evaluates against individual tokens (where anchors match token boundaries) versus textRegex evaluating against full un-tokenized strings. Fixes JanusGraph#1377 Signed-off-by: basisworks <basisworfks.dev@gmail.com>
|
porunov
approved these changes
Aug 5, 2026
porunov
left a comment
Member
There was a problem hiding this comment.
LGTM. Thank you @basisworks !
Merging with CTR
Member
|
@basisworks before we merge it, could you please sign your commit according to EastCLA? Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1377.
What changed
Adds a dedicated section
Regular Expression Syntax and Behaviortodocs/index-backend/text-search.md:textContainsRegex) and string regex (textRegex):textContainsRegex: Evaluates against individual tokens. Anchors (^and$) match individual token start/end, which explains why queries liketextContainsRegex('^loves')act as token prefix matches rather than matching the start of the whole property string.textRegex: Evaluates against the entire un-tokenized string (Mapping.STRING). Note that Lucene implicitly anchors regex queries to full terms.Docs update only — no code changes.