Skip to content

Clarify text index use #1028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 20, 2024
Merged

Clarify text index use #1028

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions modules/ROOT/pages/query-tuning/indexes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,26 @@ In summary, `TEXT` indexes support the following predicates:

|===

=== Ensuring text index use

In order for the planner to use text indexes, it must be able to confirm that the properties included in the predicate are `STRING` values.
This is not possible when accessing property values within nodes or relationships, or values within a `MAP`, since Cypher does not store the type information of these values.
To ensure text indexes are used in these cases, the xref:functions/string.adoc#functions-tostring[`toString`] function should be used.

.Text index not used
[source,cypher]
----
WITH {name: 'John'} AS varName
MERGE (:Person {name:varName.name})
----

.Text index used
[source,cypher]
----
WITH {name: 'John'} AS varName
MERGE (:Person {name: toString(varName.name)})
----

== Index preference

When multiple indexes are available and able to solve a predicate, there is an order defined that decides which index to use.
Expand Down