Skip to content

Commit ba43982

Browse files
fix case-sensitive links to procedures (#1386) (#1387)
1 parent 84a6705 commit ba43982

File tree

8 files changed

+40
-40
lines changed

8 files changed

+40
-40
lines changed

modules/ROOT/pages/clauses/call.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Omission of parentheses is available only in a so-called standalone procedure ca
7272
====
7373
7474
75-
This example calls the procedure link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_dbms_checkconfigvalue[`dbms.checkConfigValue()`], which checks the validity of a configuration setting value, using literal arguments.
75+
This example calls the procedure link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_dbms_checkConfigValue[`dbms.checkConfigValue()`], which checks the validity of a configuration setting value, using literal arguments.
7676
7777
.Query
7878
[source, cypher]

modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ CALL db.schema.nodeTypeProperties() YIELD propertyTypes RETURN propertyTypes;
395395
CALL db.schema.relTypeProperties() YIELD propertyTypes RETURN propertyTypes;
396396
----
397397
a|
398-
The column `propertyTypes` currently returned by the procedures link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_schema_nodetypeproperties[`db.schema.nodeTypeProperties()`] and link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_schema_reltypeproperties[`db.schema.relTypeProperties()`] produces a list of strings representing the potential Java types for a given property.
398+
The column `propertyTypes` currently returned by the procedures link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_schema_nodeTypeProperties[`db.schema.nodeTypeProperties()`] and link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_schema_relTypeProperties[`db.schema.relTypeProperties()`] produces a list of strings representing the potential Java types for a given property.
399399
In an upcoming major release of Neo4j, this will be updated to represent the possible Cypher types for that property instead.
400400
For all available Cypher types, see the section on xref::values-and-types/property-structural-constructed.adoc#types-synonyms[types and their synonyms].
401401

modules/ROOT/pages/indexes/semantic-indexes/full-text-indexes.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Removing stop words can help reduce the size of stored data and thereby improve
9191
In some cases, using different analyzers for the indexed values and query string is more appropriate.
9292
For example, if handling `STRING` values written in Swedish, it may be beneficial to select the `swedish` analyzer, which knows how to tokenize Swedish words, and will avoid indexing Swedish stop words.
9393

94-
The link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_listavailableanalyzers[`db.index.fulltext.listAvailableAnalyzers()`] procedure shows all available analyzers.
94+
The link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_listAvailableAnalyzers[`db.index.fulltext.listAvailableAnalyzers()`] procedure shows all available analyzers.
9595

9696
Neo4j also supports the use of custom analyzers.
9797
For more information, see the link:{neo4j-docs-base-uri}/java-reference/current/extending-neo4j/full-text-analyzer-provider[Java Reference Manual -> Full-text index analyzer providers].
@@ -135,7 +135,7 @@ For more information on how to configure full-text indexes, refer to the link:{n
135135
== Query full-text indexes
136136

137137
Unlike xref:indexes/search-performance-indexes/managing-indexes.adoc[search-performance indexes], full-text indexes are not automatically used by the xref:planning-and-tuning/execution-plans.adoc[Cypher query planner].
138-
To query a full-text index, use either the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_querynodes[`db.index.fulltext.queryNodes`] or the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_queryRelationships[`db.index.fulltext.queryRelationships`] procedure.
138+
To query a full-text index, use either the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_queryNodes[`db.index.fulltext.queryNodes`] or the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_queryRelationships[`db.index.fulltext.queryRelationships`] procedure.
139139

140140
[NOTE]
141141
An index cannot be used while its `state` is `POPULATING`, which occurs immediately after it is created.
@@ -363,15 +363,15 @@ The procedures for full-text indexes are listed in the table below:
363363
| Usage | Procedure/Command | Description
364364

365365
| Eventually consistent indexes.
366-
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_awaiteventuallyconsistentindexrefresh[`db.index.fulltext.awaitEventuallyConsistentIndexRefresh`]
366+
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_awaitEventuallyConsistentIndexRefresh[`db.index.fulltext.awaitEventuallyConsistentIndexRefresh`]
367367
| Wait for the updates from recently committed transactions to be applied to any eventually-consistent full-text indexes.
368368

369369
| List available analyzers.
370-
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_listavailableanalyzers[`db.index.fulltext.listAvailableAnalyzers`]
370+
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_listAvailableAnalyzers[`db.index.fulltext.listAvailableAnalyzers`]
371371
| List the available analyzers that the full-text indexes can be configured with.
372372

373373
| Use full-text node index.
374-
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_querynodes[`db.index.fulltext.queryNodes`]
374+
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_queryNodes[`db.index.fulltext.queryNodes`]
375375
| Query the given full-text index. Returns the matching nodes and their Lucene query score, ordered by score.
376376

377377
| Use full-text relationship index.

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ In this example, the vector dimension is explicitly set to `1536` and the vector
110110
To read more about the available similarity functions, see xref:indexes/semantic-indexes/vector-indexes.adoc#similarity-functions[].
111111

112112
[NOTE]
113-
Prior to Neo4j 5.15, node vector indexes were created using the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createnodeindex[`db.index.vector.createNodeIndex`] procedure.
113+
Prior to Neo4j 5.15, node vector indexes were created using the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createNodeIndex[`db.index.vector.createNodeIndex`] procedure.
114114

115115
You can also create a vector index for relationships with a particular type on a given property using the following syntax:
116116

@@ -194,7 +194,7 @@ Default value::: `100`
194194
[[query-vector-index]]
195195
== Query vector indexes
196196

197-
To query a node vector index, use the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_querynodes[`db.index.vector.queryNodes`] procedure.
197+
To query a node vector index, use the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryNodes[`db.index.vector.queryNodes`] procedure.
198198

199199
[NOTE]
200200
An index cannot be used while its `state` is `POPULATING`, which occurs immediately after it is created.
@@ -240,7 +240,7 @@ Note that all movies returned have a plot centred around criminal family organiz
240240
The `score` results are returned in _descending order_, where the best matching result entry is put first (in this case, `The Godfather` has a similarity score of `1.0`, which is to be expected as the index was queried with this specific property).
241241
If the query vector itself is not wanted, adding the predicate `WHERE score < 1` removes identical vectors.
242242

243-
To query a relationship vector index, use the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryrelationships[`db.index.vector.queryRelationships`] procedure.
243+
To query a relationship vector index, use the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryRelationships[`db.index.vector.queryRelationships`] procedure.
244244

245245
.Signature for `db.index.vector.queryRelationships` label:new[Introduced in 5.18]
246246
[source,syntax]
@@ -483,30 +483,30 @@ image::euclidean_similarity_equation.svg["The Euclidean of vector v and vector u
483483
| Usage | Procedure | Description
484484

485485
| Create node vector index.
486-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createnodeindex[`db.index.vector.createNodeIndex`]
486+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createNodeIndex[`db.index.vector.createNodeIndex`]
487487
| Create a vector index for the specified label and property with the given vector dimension using the given similarity function.
488488
Replaced by the `CREATE VECTOR INDEX` command.
489489

490490
| Use node vector index.
491-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_querynodes[`db.index.vector.queryNodes`]
491+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryNodes[`db.index.vector.queryNodes`]
492492
| Query the given node vector index.
493493
Returns the requested number of approximate nearest neighbor nodes and their similarity score, ordered by score.
494494

495495
| Use relationship vector index.
496-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryrelationships[`db.index.vector.queryRelationships`]
496+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryRelationships[`db.index.vector.queryRelationships`]
497497
| Query the given relationship vector index.
498498
Returns the requested number of approximate nearest neighbor relationships and their similarity score, ordered by score. label:new[Introduced in 5.18]
499499

500500
| Set node vector property.
501-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setnodevectorproperty[`db.create.setNodeVectorProperty`]
502-
| Update a given node property with the given vector in a more space-efficient way than directly using xref:clauses/set.adoc#set-set-a-property[`SET`]. Replaces link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setvectorproperty[`db.create.setVectorProperty`]. label:beta[] label:new[Introduced in 5.13]
501+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setnodeVectorProperty[`db.create.setNodeVectorProperty`]
502+
| Update a given node property with the given vector in a more space-efficient way than directly using xref:clauses/set.adoc#set-set-a-property[`SET`]. Replaces link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setVectorProperty[`db.create.setVectorProperty`]. label:beta[] label:new[Introduced in 5.13]
503503

504504
| Set node vector property.
505-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setvectorproperty[`db.create.setVectorProperty`]
505+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setVectorProperty[`db.create.setVectorProperty`]
506506
| Replaced by link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setnodevectorproperty[`db.create.setNodeVectorProperty`]. label:deprecated[] label:beta[]
507507

508508
| Set relationship vector property.
509-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setrelationshipvectorproperty[`db.create.setRelationshipVectorProperty`]
509+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setRelationshipVectorProperty[`db.create.setRelationshipVectorProperty`]
510510
| Update a given relationship property with the given vector in a more space-efficient way than directly using xref:clauses/set.adoc#set-set-a-property[`SET`]. label:beta[] label:new[Introduced in 5.18]
511511

512512
|===
@@ -535,7 +535,7 @@ The following table lists the issues and, if fixed, the version in which they we
535535
|===
536536
| Known issues | Fixed in
537537

538-
| The creation of a vector index using the legacy procedure link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createnodeindex[`db.index.vector.createNodeIndex`] may fail with an error in Neo4j 5.18 and later if the database was last written to with a version prior to Neo4j 5.11, and the legacy procedure is the first write operation used on the newer version.
538+
| The creation of a vector index using the legacy procedure link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createNodeIndex[`db.index.vector.createNodeIndex`] may fail with an error in Neo4j 5.18 and later if the database was last written to with a version prior to Neo4j 5.11, and the legacy procedure is the first write operation used on the newer version.
539539
In Neo4j 5.20, the error was clarified.
540540
[TIP]
541541
--
@@ -611,9 +611,9 @@ To work around this issue if you need to run multiple vector index queries and m
611611

612612
| xref:clauses/listing-procedures.adoc[`SHOW PROCEDURES`] does not show the vector index procedures:
613613

614-
* link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setvectorproperty[`db.create.setVectorProperty`]
615-
* link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createnodeindex[`db.index.vector.createNodeIndex`]
616-
* link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_querynodes[`db.index.vector.queryNodes`]
614+
* link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setVectorProperty[`db.create.setVectorProperty`]
615+
* link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createNodeIndex[`db.index.vector.createNodeIndex`]
616+
* link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryNodes[`db.index.vector.queryNodes`]
617617

618618
[NOTE]
619619
--
@@ -636,7 +636,7 @@ d| The validation for xref:indexes/semantic-indexes/vector-indexes.adoc#similari
636636
This can lead to certain large component vectors being incorrectly indexed, and return a similarity score of `&plusmn;0.0`.
637637
| Neo4j 5.12
638638

639-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_querynodes[`db.index.vector.queryNodes`] query vector validation is incorrect with a xref:indexes/semantic-indexes/vector-indexes.adoc#similarity-functions[cosine] vector index. The {l2-norm} validation only considers the last component of the vector. If that component is `&plusmn;0.0`, an otherwise valid query vector will be thrown as invalid. This can also result in some invalid vectors being used to query, and return a similarity score of `&plusmn;0.0`.
639+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryNodes[`db.index.vector.queryNodes`] query vector validation is incorrect with a xref:indexes/semantic-indexes/vector-indexes.adoc#similarity-functions[cosine] vector index. The {l2-norm} validation only considers the last component of the vector. If that component is `&plusmn;0.0`, an otherwise valid query vector will be thrown as invalid. This can also result in some invalid vectors being used to query, and return a similarity score of `&plusmn;0.0`.
640640

641641
[TIP]
642642
--

modules/ROOT/pages/introduction/cypher-neo4j.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ For examples of the API, or the commands used to start and commit transactions,
136136
* For information on using transactions with a Neo4j driver, see _The session API_ in the link:{docs-base-uri}[Neo4j Driver manuals].
137137
* For information on using transactions over the HTTP API, see the link:{neo4j-docs-base-uri}/http-api/current/transactions[HTTP API documentation -> Run transactions].
138138
* For information on using transactions within the embedded Core API, see the link:{neo4j-docs-base-uri}/java-reference/current/java-embedded/cypher-java/[Java Reference -> Cypher queries].
139-
* For information on using transactions within the Neo4j Browser or Cypher-shell, see the link:{neo4j-docs-base-uri}/browser-manual/current/reference-commands/[Neo4j Browser documentation] or the link:{neo4j-docs-base-uri}/operations-manual/current/cypher-shell/#cypher-shell-commands[Cypher-shell documentation].
139+
* For information on using transactions within the Neo4j Browser or Cypher-shell, see the link:{neo4j-docs-base-uri}/browser/reference-commands/[Neo4j Browser documentation] or the link:{neo4j-docs-base-uri}/operations-manual/current/cypher-shell/#cypher-shell-commands[Cypher-shell documentation].
140140

141141
When writing procedures or using Neo4j embedded, remember that all iterators returned from an execution result should be either fully exhausted or closed.
142142
This ensures that the resources bound to them are properly released.

modules/ROOT/pages/planning-and-tuning/execution-plans.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ RETURN count(*)
9292
----
9393

9494
This is the resulting execution planfootnote:[The format of the execution plans displayed in this section are those generated when using link:{neo4j-docs-base-uri}/operations-manual/current/cypher-shell/[Cypher Shell].
95-
The execution plans generated by link:{neo4j-docs-base-uri}/browser-manual/current/[Neo4j Browser] use a different format.]:
95+
The execution plans generated by link:{neo4j-docs-base-uri}/browser/[Neo4j Browser] use a different format.]:
9696

9797
[role="queryplan"]
9898
----

0 commit comments

Comments
 (0)