You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/indexes/search-performance-indexes/managing-indexes.adoc
+13-1Lines changed: 13 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -214,7 +214,7 @@ Instad an informational notification is returned.
214
214
Creating a text index can be done with the `CREATE TEXT INDEX` command.
215
215
Note that the index name must be unique.
216
216
217
-
Text indexes have no supported index configuration and they have two index providers available, `text-2.0` (default) and `text-1.0` (deprecated).
217
+
Text indexes have no supported index configuration and they have two index providers available, `text-2.0` (default -- see xref:indexes/search-performance-indexes/managing-indexes.adoc#text-indexes-trigram-indexes[Trigram indexing] below for more information) and `text-1.0` (deprecated).
218
218
219
219
[[text-indexes-supported-predicates]]
220
220
[discrete]
@@ -284,6 +284,18 @@ See the section about xref:indexes/search-performance-indexes/using-indexes.adoc
284
284
[TIP]
285
285
Text indexes are only used for exact query matches. To perform approximate matches (including, for example, variations and typos), and to compute a similarity score between `STRING` values, use semantic xref:indexes/semantic-indexes/full-text-indexes.adoc[full-text indexes] instead.
286
286
287
+
[[text-indexes-trigram-indexes]]
288
+
==== Trigram indexing
289
+
290
+
The default text index provider, `text-2.0`, uses trigram indexing.
291
+
This means that `STRING` values are indexed into overlapping trigrams, each containing three Unicode code points.
292
+
For example, the word `"developer"` would be indexed by the following trigrams: `["dev", "eve", "vel", "elo", "lop", "ope", "per"]`.
293
+
294
+
This makes text indexes particularly suitable for substring (`CONTAINS`) and suffix (`ENDS WITH`) searches, as well as prefix searches (`STARTS WITH`).
295
+
For example, searches like `CONTAINS "vel"` or `ENDS WITH "per"` can be efficiently performed by directly looking up the relevant trigrams in the index.
296
+
By comparison, range indexes, which indexes `STRING` values lexicographically (see xref:indexes/search-performance-indexes/using-indexes.adoc#range-index-backed-order-by[Range index-backed `ORDER BY`] for more information) and are therefore more suited for prefix searches, would need to scan through all indexed values to check if `"vel"` existed anywhere within the text.
297
+
For more information, see xref:indexes/search-performance-indexes/using-indexes.adoc#text-indexes[The impact of indexes on query performance -> Text indexes].
Copy file name to clipboardExpand all lines: modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -232,7 +232,7 @@ Total database accesses: 7, total allocated memory: 312
232
232
233
233
This is because range indexes store `STRING` values alphabetically.
234
234
This means that, while they are very efficient for retrieving exact matches of a `STRING`, or for prefix matching, they are less efficient for suffix and contains searches, where they have to scan all relevant properties to filter any matches.
235
-
Text indexes do not store `STRING` properties alphabetically, and are instead optimized for suffix and contains searches.
235
+
Text indexes do not store `STRING` properties alphabetically, and are instead optimized for suffix and contains searches (for more information, see xref:indexes/search-performance-indexes/managing-indexes.adoc#text-indexes-trigram-indexes[Create a text index -> Trigram indexing]).
236
236
That said, if no range index had been present on the name property, the previous query would still have been able to utilize the text index.
237
237
It would have done so less efficiently than a range index, but it still would have been useful.
0 commit comments