Skip to content

Commit f4b4556

Browse files
Remove use of index-provider option
Supplying the index-provider option will no longer have any effect, and a user should not specify it. From 5.26 using the index-provider option will generate a warning. The index-provider has never controlled index behaviour in the 5.x series, and the latest provider will always be the best one.
1 parent 6efbb2a commit f4b4556

File tree

5 files changed

+14
-99
lines changed

5 files changed

+14
-99
lines changed

modules/ROOT/pages/constraints/managing-constraints.adoc

Lines changed: 0 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -910,7 +910,6 @@ Constraint already exists: Constraint( id=7, name='book_title_year', type='UNIQU
910910
=== Constraints and indexes
911911

912912
* xref:constraints/managing-constraints.adoc#constraints-and-backing-indexes[]
913-
* xref:constraints/managing-constraints.adoc#create-constraint-with-index-provider[]
914913
* xref:constraints/managing-constraints.adoc#constraint-failures-and-indexes[]
915914

916915
[[constraints-and-backing-indexes]]
@@ -994,60 +993,6 @@ SHOW INDEXES WHERE owningConstraint IS NOT NULL
994993
[NOTE]
995994
Property existence and property type constraints are not backed by indexes.
996995

997-
[[create-constraint-with-index-provider]]
998-
==== Creating constraints with an index provider
999-
1000-
Because property uniqueness and key constraints have backing indexes, an index provider can be provided when creating these constraints using the `OPTIONS` clause and the `indexProvider` option.
1001-
1002-
The only valid value for the index provider is:
1003-
1004-
* `range-1.0` label:default[]
1005-
1006-
1007-
.Create a node key constraint with a specified index provider
1008-
======
1009-
1010-
.Create a constraint requiring `Actor` nodes to have a unique `surname` property as a node key, specifying `range-1.0` as index provider
1011-
[source, cypher]
1012-
----
1013-
CREATE CONSTRAINT constraint_with_provider
1014-
FOR (actor:Actor) REQUIRE actor.surname IS NODE KEY
1015-
OPTIONS {
1016-
indexProvider: 'range-1.0'
1017-
}
1018-
----
1019-
1020-
.Result
1021-
[source, queryresult]
1022-
----
1023-
Added 1 constraint.
1024-
----
1025-
1026-
======
1027-
1028-
.Create a relationship property uniqueness constraint with a specified index provider
1029-
======
1030-
1031-
.Create a constraint requiring `SEQUEL_OF` relationships to have a unique combination of `order`, `seriesTitle`, and `number` properties, specifying `range-1.0` as index provider
1032-
[source, cypher]
1033-
----
1034-
CREATE CONSTRAINT rel_constraint_with_options
1035-
FOR ()-[sequel:SEQUEL_OF]-() REQUIRE (sequel.order, sequel.seriesTitle, sequel.number) IS UNIQUE
1036-
OPTIONS {
1037-
indexProvider: 'range-1.0'
1038-
}
1039-
----
1040-
1041-
.Result
1042-
[source, queryresult]
1043-
----
1044-
Added 1 constraint.
1045-
----
1046-
1047-
======
1048-
1049-
There are no valid index configuration values for the constraint-backing range indexes.
1050-
1051996
[[constraint-failures-and-indexes]]
1052997
==== Constraint failures and indexes
1053998

modules/ROOT/pages/constraints/syntax.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@ It may still throw an error if conflicting data, indexes, or constraints exist.
2626
Examples of this are nodes with missing properties, indexes with the same name, or constraints with same schema but a different conflicting constraint type.
2727
As of Neo4j 5.17, an informational notification is returned in case nothing happens showing the existing constraint which blocks the creation.
2828

29-
For constraints that are backed by an index, the index provider for the backing index can be specified using the `OPTIONS` clause.
30-
Only one valid value exists for the index provider, `range-1.0`, which is the default value.
31-
There is no supported index configuration for range indexes.
32-
3329
[[create-property-uniqueness-constraints]]
3430
=== Create property uniqueness constraints
3531

@@ -69,8 +65,6 @@ REQUIRE (r.propertyName_1, ..., r.propertyName_n) IS [REL[ATIONSHIP]] UNIQUE
6965
[OPTIONS "{" option: value[, ...] "}"]
7066
----
7167

72-
An index provider can be specified using the `OPTIONS` clause.
73-
7468
For examples on how to create property uniqueness constraints, see xref:constraints/managing-constraints.adoc#create-property-uniqueness-constraints[Create, show, and drop constraints -> Create property uniqueness constraint].
7569
Property uniqueness constraints are xref:constraints/managing-constraints.adoc#constraints-and-indexes[index-backed].
7670

@@ -198,8 +192,6 @@ REQUIRE (r.propertyName_1, ..., r.propertyName_n) IS [REL[ATIONSHIP]] KEY
198192
[OPTIONS "{" option: value[, ...] "}"]
199193
----
200194

201-
An index provider can be specified using the `OPTIONS` clause.
202-
203195
For examples on how to create key constraints, see xref:constraints/managing-constraints.adoc#create-key-constraints[Create, show, and drop constraints -> Create key constraints].
204196
Key constraints are xref:constraints/managing-constraints.adoc#constraints-and-indexes[index-backed].
205197

modules/ROOT/pages/indexes/search-performance-indexes/managing-indexes.adoc

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,9 @@ If `IF NOT EXISTS` is appended to the command, no error is thrown and nothing ha
3333
It may still throw an error if conflicting constraints exist, such as constraints with the same name or schema and backing index type.
3434
As of Neo4j 5.17, an informational notification is instead returned showing the existing index which blocks the creation.
3535

36-
Index providers and configuration settings can be specified using the `OPTIONS` clause.footnote:[Index providers are essentially different implementations of the same index type.
37-
Different providers are only available for xref:indexes/search-performance-indexes/managing-indexes.adoc#create-a-text-index-specifying-the-index-provider[text indexes].]
36+
Configuration settings can be specified using the `OPTIONS` clause.
3837

39-
However, not all indexes have available configuration settings or more than one provider.
38+
However, not all indexes have available configuration settings.
4039
In those cases, nothing needs to be specified and the `OPTIONS` map should be omitted from the query.
4140

4241
[TIP]
@@ -50,7 +49,7 @@ A newly created index is not immediately available but is created in the backgro
5049
Creating a range index can be done with the `CREATE INDEX` command.
5150
Note that the index name must be unique.
5251

53-
Range indexes have only one index provider available, `range-1.0`, and no supported index configuration.
52+
Range indexes have no supported index configuration.
5453

5554
[[range-indexes-supported-predicates]]
5655
[discrete]
@@ -294,7 +293,6 @@ Text indexes are only used for exact query matches. To perform approximate match
294293
* xref:indexes/search-performance-indexes/managing-indexes.adoc#create-a-relationship-text-index[]
295294
* xref:indexes/search-performance-indexes/managing-indexes.adoc#create-a-text-index-by-param[]
296295
* xref:indexes/search-performance-indexes/managing-indexes.adoc#create-a-text-index-only-if-it-does-not-already-exist[]
297-
* xref:indexes/search-performance-indexes/managing-indexes.adoc#create-a-text-index-specifying-the-index-provider[]
298296

299297
[discrete]
300298
[[create-a-node-text-index]]
@@ -366,30 +364,13 @@ As of Neo4j 5.17, an informational notification is instead returned.
366364
`TEXT INDEX node_text_index_nickname FOR (e:Person) ON (e.nickname)` already exists.
367365
----
368366

369-
[discrete]
370-
[[create-a-text-index-specifying-the-index-provider]]
371-
===== Create a text index specifying the index provider
372-
373-
To create a text index with a specific index provider, the `OPTIONS` clause is used.
374-
The valid values for the index provider are `text-2.0` and `text-1.0` (deprecated).
375-
The default provider is `text-2.0`.
376-
377-
.Creating a text index with index provider
378-
[source, cypher]
379-
----
380-
CREATE TEXT INDEX text_index_with_indexprovider FOR ()-[r:TYPE]-() ON (r.prop1)
381-
OPTIONS {indexProvider: 'text-2.0'}
382-
----
383-
384-
There is no supported index configuration for text indexes.
385-
386367
[[create-point-index]]
387368
=== Create a point index
388369

389370
Creating a point index can be done with the `CREATE POINT INDEX` command.
390371
Note that the index name must be unique.
391372

392-
Point indexes have supported index configuration, but only one index provider available, `point-1.0`.
373+
Point indexes have supported index configuration.
393374

394375
[discrete]
395376
[[point-indexes-supported-predicates]]
@@ -554,7 +535,7 @@ Only one node label and one relationship type lookup index can exist at the same
554535
If a token lookup index has been deleted, it can be recreated with the `CREATE LOOKUP INDEX` command.
555536
Note that the index name must be unique.
556537

557-
Token lookup indexes have only one index provider available, `token-lookup-1.0`, and no supported index configuration.
538+
Token lookup indexes have no supported index configuration.
558539

559540
[discrete]
560541
[[lookup-index-supported-predicates]]

modules/ROOT/pages/indexes/semantic-indexes/vector-indexes.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ A vector index allows you to retrieve a neighborhood of nodes or relationships b
7171

7272
A vector index is a single-label, single-property index for nodes or a single-relationship-type, single-property index for relationships.
7373
It can be used to index nodes or relationships by `LIST<INTEGER | FLOAT>` properties valid to the dimensions and vector similarity function of the index.
74-
Note that the available vector index providers (`vector-2.0` (default) and `vector-1.0`) support different index schemas, property value types, and vector dimensions.
74+
Note that the available vector index providers (`vector-2.0` (default) and `vector-1.0` (deprecated)) support different index schemas, property value types, and vector dimensions.
7575
For more information, see xref:indexes/semantic-indexes/vector-indexes.adoc#vector-index-providers[].
7676

7777
A vector index is created by using the `CREATE VECTOR INDEX` command.
@@ -350,9 +350,8 @@ DROP INDEX moviePlots
350350
[[vector-index-providers]]
351351
== Vector index providers for compatibility
352352

353-
As of Neo4j 5.18, the default and preferred vector index provider is `vector-2.0`.
353+
As of Neo4j 5.18, the default index provider is `vector-2.0`.
354354
Previously created `vector-1.0` indexes will continue to function.
355-
New indexes can still be created with the `vector-1.0` provider if it is specified in the `OPTIONS` map.
356355

357356
.Learn more about vector index provider differences
358357
[%collapsible]

modules/ROOT/pages/indexes/syntax.adoc

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ As of Neo4j 5.17, an informational notification is instead returned showing the
2727
The index name must be unique among both indexes and constraints.
2828
A random name will be assigned if no name is explicitly given when an index is created.
2929

30-
Index providers and configuration settings can be specified using the `OPTIONS` clause.
31-
However, not all indexes have available configuration settings or multiple providers.
30+
Configuration settings can be specified using the `OPTIONS` clause.
31+
However, not all indexes have available configuration settings.
3232
In those cases, nothing needs to be specified and the `OPTIONS` map should be omitted from the query.
3333

3434
[TIP]
@@ -37,8 +37,8 @@ Creating an index requires link:{neo4j-docs-base-uri}/operations-manual/{page-ve
3737
[[create-range-index]]
3838
=== Range indexes
3939

40-
Range indexes have only one index provider, `range-1.0`, and no supported index configuration.
41-
Since the index provider will be assigned by default, the `OPTIONS` map has been omitted from the syntax below.
40+
Range indexes have no supported index configuration.
41+
The `OPTIONS` map has been omitted from the syntax below.
4242

4343
.Create a range index for a node label, either on a single property or composite
4444
[source,syntax]
@@ -113,7 +113,6 @@ ON (r.propertyName_1)
113113
[OPTIONS “{“ option: value[, …] “}”]
114114
----
115115

116-
Point indexes have only one index provider available, `point-1.0`.
117116
The following settings can be specified for point indexes:
118117

119118
* `spatial.cartesian.min`
@@ -133,8 +132,8 @@ For more information, see xref:indexes/search-performance-indexes/managing-index
133132
[[create-lookup-index]]
134133
=== Token lookup indexes
135134

136-
Token lookup indexes have only one index provider, `token-lookup-1.0`, and no supported index configuration.
137-
Since the index provider will be assigned by default, the `OPTIONS` map has been omitted from the syntax below.
135+
Token lookup indexes have no supported index configuration.
136+
The `OPTIONS` map has been omitted from the syntax below.
138137

139138
.Create a node label lookup index
140139
[source,syntax]
@@ -177,7 +176,6 @@ ON EACH “[“ r.propertyName[, ...] “]”
177176
[OPTIONS “{“ option: value[, …] “}”]
178177
----
179178

180-
Full-text indexes have only one index provider available, `fulltext-1.0`.
181179
The following settings can be specified for full-text indexes:
182180

183181
* `fulltext.analyzer` - specifies what analyzer to use (the `db.index.fulltext.listAvailableAnalyzers` procedure lists what analyzers are available).
@@ -207,7 +205,7 @@ ON (r.propertyName)
207205
[OPTIONS “{“ option: value[, …] “}”]
208206
----
209207

210-
As of Neo4j 5.18, vector indexes have two vector index providers available, `vector-2.0` (default) and `vector-1.0`.
208+
As of Neo4j 5.18, vector indexes have two vector index providers available, `vector-2.0` (default) and `vector-1.0` (deprecated).
211209
For more information, see xref:indexes/semantic-indexes/vector-indexes.adoc#vector-index-providers[Vector index providers for compatibility].
212210

213211
For a full list of all vector index settings, see xref:indexes/semantic-indexes/vector-indexes.adoc#configuration-settings[Vector index configuration settings].

0 commit comments

Comments
 (0)