From 536df20cde4c7a6561cc6761349aa3eac754c736 Mon Sep 17 00:00:00 2001 From: Neil Dewhurst Date: Tue, 15 Nov 2022 10:00:15 +0000 Subject: [PATCH 1/2] Update external xrefs to links and fix table --- .../ROOT/pages/access-control/built-in-roles.adoc | 4 ++-- .../ROOT/pages/access-control/manage-roles.adoc | 2 +- .../ROOT/pages/access-control/manage-users.adoc | 10 +++------- .../pages/access-control/privileges-writes.adoc | 4 ++-- modules/ROOT/pages/aliases.adoc | 14 +++++++------- modules/ROOT/pages/clauses/call.adoc | 4 ++-- modules/ROOT/pages/clauses/delete.adoc | 2 +- modules/ROOT/pages/clauses/load-csv.adoc | 8 ++++---- modules/ROOT/pages/clauses/use.adoc | 2 +- modules/ROOT/pages/databases.adoc | 2 +- ...recations-additions-removals-compatibility.adoc | 7 ++++--- modules/ROOT/pages/execution-plans/index.adoc | 2 +- .../execution-plans/shortestpath-planning.adoc | 2 +- modules/ROOT/pages/functions/index.adoc | 4 ++-- modules/ROOT/pages/functions/user-defined.adoc | 6 +++--- .../ROOT/pages/indexes-for-full-text-search.adoc | 4 ++-- .../ROOT/pages/indexes-for-search-performance.adoc | 4 ++-- modules/ROOT/pages/introduction/transactions.adoc | 6 +++--- .../ROOT/pages/query-tuning/advanced-example.adoc | 6 +++--- modules/ROOT/pages/query-tuning/basic-example.adoc | 4 ++-- modules/ROOT/pages/query-tuning/query-options.adoc | 4 ++-- modules/ROOT/pages/query-tuning/using.adoc | 2 +- modules/ROOT/pages/syntax/maps.adoc | 2 +- modules/ROOT/pages/syntax/parameters.adoc | 4 ++-- modules/ROOT/pages/syntax/temporal.adoc | 2 +- preview.yml | 2 ++ publish.yml | 2 ++ 27 files changed, 58 insertions(+), 57 deletions(-) diff --git a/modules/ROOT/pages/access-control/built-in-roles.adoc b/modules/ROOT/pages/access-control/built-in-roles.adoc index c2022ae4e..729f10114 100644 --- a/modules/ROOT/pages/access-control/built-in-roles.adoc +++ b/modules/ROOT/pages/access-control/built-in-roles.adoc @@ -361,7 +361,7 @@ SHOW ROLE admin PRIVILEGES AS COMMANDS a|Rows: 11 |=== -If the built-in `admin` role has been altered or dropped, and needs to be restored to its original state, see xref:4.4@operations-manual:ROOT:configuration/password-and-user-recovery/index.adoc[Operations Manual -> Password and user recovery]. +If the built-in `admin` role has been altered or dropped, and needs to be restored to its original state, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/password-and-user-recovery[Operations Manual -> Password and user recovery]. [[access-control-built-in-roles-admin-recreate]] @@ -413,4 +413,4 @@ GRANT ALL ON DATABASE * TO admin The resulting `admin` role now has the same privileges as the original built-in `admin` role. -Additional information about restoring the `admin` role can be found at xref:4.4@operations-manual:ROOT:configuration/password-and-user-recovery/index.adoc#recover-admin-role[Operations Manual -> Recover the admin role]. +Additional information about restoring the `admin` role can be found at link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/password-and-user-recovery#recover-admin-role[Operations Manual -> Recover the admin role]. diff --git a/modules/ROOT/pages/access-control/manage-roles.adoc b/modules/ROOT/pages/access-control/manage-roles.adoc index a7639379a..9b29d9011 100644 --- a/modules/ROOT/pages/access-control/manage-roles.adoc +++ b/modules/ROOT/pages/access-control/manage-roles.adoc @@ -361,7 +361,7 @@ By default it gives access to the home database and to execute privileges for pr 1+a|Rows: 6 |=== -More information about the built-in roles can be found in xref:4.4@operations-manual:ROOT:authentication-authorization/built-in-roles/index.adoc[Operations Manual -> Built-in roles]. +More information about the built-in roles can be found in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/built-in-roles[Operations Manual -> Built-in roles]. There are multiple versions of this command, the default being `SHOW ALL ROLES`. To only show roles that are assigned to users, the command is `SHOW POPULATED ROLES`. diff --git a/modules/ROOT/pages/access-control/manage-users.adoc b/modules/ROOT/pages/access-control/manage-users.adoc index 6faf44a28..8c15df491 100644 --- a/modules/ROOT/pages/access-control/manage-users.adoc +++ b/modules/ROOT/pages/access-control/manage-users.adoc @@ -113,8 +113,6 @@ GRANT SHOW PRIVILEGE (see xref::access-control/dbms-administration.adoc#access-control-dbms-administration-privilege-management[DBMS PRIVILEGE MANAGEMENT privileges]) -|=== - [source, privilege, role="noheader"] ---- GRANT SHOW USER @@ -187,8 +185,6 @@ GRANT CREATE USER (see xref::access-control/dbms-administration.adoc#access-control-dbms-administration-user-management[DBMS USER MANAGEMENT privileges]) -|=== - [source, privilege, role="noheader"] ---- GRANT DROP USER @@ -468,7 +464,7 @@ SHOW USERS |=== When first starting a Neo4j DBMS, there is always a single default user `neo4j` with administrative privileges. -It is possible to set the initial password using xref:4.4@operations-manual:ROOT:configuration/set-initial-password/index.adoc[neo4j-admin set-initial-password], otherwise it is necessary to change the password after the first login. +It is possible to set the initial password using link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/set-initial-password[neo4j-admin set-initial-password], otherwise it is necessary to change the password after the first login. .Show user ====== @@ -536,7 +532,7 @@ Consequently, it is never possible to get the plaintext of a password back out o A password can be set in either fashion at any time. ** The optional `PLAINTEXT` in `SET PLAINTEXT PASSWORD` has the same behavior as `SET PASSWORD`. ** The optional `ENCRYPTED` is used to recreate an existing user when the plaintext password is unknown, but the encrypted password is available in the _data/scripts/databasename/restore_metadata.cypher_ file of a database backup. -See xref:4.4@operations-manual:ROOT:backup-restore/restore-backup/index.adoc#restore-backup-example[Operations Manual -> Restore a database backup -> Example]. + +See link:{neo4j-docs-base-uri}/operations-manual/{page-version}/backup-restore/restore-backup#restore-backup-example[Operations Manual -> Restore a database backup -> Example]. + With `ENCRYPTED`, the password string is expected to be in the format of ``, `` or ``, where, for example: *** `0` is the first version and refers to the `SHA-256` cryptographic hash function with iterations `1`. *** `1` is the second version and refers to the `SHA-256` cryptographic hash function with iterations `1024`. @@ -695,7 +691,7 @@ Consequently, it is never possible to get the plaintext of a password back out o A password can be set in either fashion at any time. ** The optional `PLAINTEXT` in `SET PLAINTEXT PASSWORD` has the same behavior as `SET PASSWORD`. ** The optional `ENCRYPTED` is used to update an existing user's password when the plaintext password is unknown, but the encrypted password is available in the _data/scripts/databasename/restore_metadata.cypher_ file of a database backup. -See xref:4.4@operations-manual:ROOT:backup-restore/restore-backup/index.adoc#restore-backup-example[Operations Manual -> Restore a database backup -> Example]. + +See link:{neo4j-docs-base-uri}/operations-manual/{page-version}/backup-restore/restore-backup#restore-backup-example[Operations Manual -> Restore a database backup -> Example]. + With `ENCRYPTED`, the password string is expected to be in the format of ``,`` or ``, where, for example: *** `0` is the first version and refers to the `SHA-256` cryptographic hash function with iterations `1`. *** `1` is the second version and refers to the `SHA-256` cryptographic hash function with iterations `1024`. diff --git a/modules/ROOT/pages/access-control/privileges-writes.adoc b/modules/ROOT/pages/access-control/privileges-writes.adoc index 662b70c81..8b1b5adfd 100644 --- a/modules/ROOT/pages/access-control/privileges-writes.adoc +++ b/modules/ROOT/pages/access-control/privileges-writes.adoc @@ -126,7 +126,7 @@ DENY DELETE ON GRAPH * RELATIONSHIPS bar TO regularUsers [NOTE] ==== Users with `DELETE` privilege, but restricted `TRAVERSE` privileges, will not be able to do `DETACH DELETE` in all cases. -See xref:4.4@operations-manual:ROOT:authentication-authorization/access-control/index.adoc#detach-delete-restricted-user[Operations Manual -> Fine-grained access control] for more info. +See link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/access-control#detach-delete-restricted-user[Operations Manual -> Fine-grained access control] for more info. ==== @@ -350,7 +350,7 @@ DENY WRITE ON GRAPH neo4j TO regularUsers [NOTE] ==== Users with `WRITE` privilege but restricted `TRAVERSE` privileges will not be able to do `DETACH DELETE` in all cases. -See xref:4.4@operations-manual:ROOT:authentication-authorization/access-control/index.adoc#detach-delete-restricted-user[Operations Manual -> Fine-grained access control] for more info. +See link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/access-control#detach-delete-restricted-user[Operations Manual -> Fine-grained access control] for more info. ==== diff --git a/modules/ROOT/pages/aliases.adoc b/modules/ROOT/pages/aliases.adoc index e43f2965d..0625e489e 100644 --- a/modules/ROOT/pages/aliases.adoc +++ b/modules/ROOT/pages/aliases.adoc @@ -19,7 +19,7 @@ Please note that the local alias will be resolved while executing the command. Privileges are defined on the database, and not the local alias. A remote alias can be used for connecting to a database of a remote Neo4j DBMS, use clauses, setting a user's home database and defining the access privileges to the remote database. -Remote aliases requires configuration to safely connect to the remote target, which is described in xref:4.4@operations-manual:ROOT:manage-databases/remote-alias/index.adoc[Connecting remote databases]. +Remote aliases requires configuration to safely connect to the remote target, which is described in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/manage-databases/remote-alias[Connecting remote databases]. It is not possible to impersonate a user on the remote database or to execute an administration command on the remote database via a remote alias. Aliases can be created and managed using a set of Cypher administration commands executed against the `system` database. @@ -151,7 +151,7 @@ A timeout of zero is treated as an infinite timeout and will be bound by the tim | Duration | Default value -| xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.routing.driver.connection.connect_timeout[dbms.routing.driver.connection.connect_timeout] +| link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.routing.driver.connection.connect_timeout[dbms.routing.driver.connection.connect_timeout] |=== @@ -171,7 +171,7 @@ It is recommended to set maximum lifetime to a slightly smaller value than the o Zero and negative values result in lifetime not being checked. | Default value -| xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.routing.driver.connection.max_lifetime[dbms.routing.driver.connection.max_lifetime] +| link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.routing.driver.connection.max_lifetime[dbms.routing.driver.connection.max_lifetime] |=== @@ -191,7 +191,7 @@ Negative values are allowed and result in unlimited acquisition timeout. Value of `0` is allowed and results in no timeout and immediate failure when connection is unavailable. | Default value -| xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.routing.driver.connection.pool.acquisition_timeout[dbms.routing.driver.connection.pool.acquisition_timeout] +| link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.routing.driver.connection.pool.acquisition_timeout[dbms.routing.driver.connection.pool.acquisition_timeout] |=== @@ -211,7 +211,7 @@ Negative values are allowed and result in unlimited pool. Value of `0` is not allowed. | Default value -| xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.routing.driver.connection.pool.max_size[dbms.routing.driver.connection.pool.max_size] +| link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.routing.driver.connection.pool.max_size[dbms.routing.driver.connection.pool.max_size] |=== @@ -228,7 +228,7 @@ Value of `0` is not allowed. One of `DEBUG`, `INFO`, `WARN`, `ERROR`, or `NONE`. | Default value -| xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.routing.driver.logging.level[dbms.routing.driver.logging.level] +| link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.routing.driver.logging.level[dbms.routing.driver.logging.level] |=== @@ -698,7 +698,7 @@ CREATE ALIAS `northwind` FOR DATABASE `northwind-graph-2020` === Creating remote database aliases Database aliases can also point to remote databases by providing an url and the credentials of a user on the remote Neo4j DBMS. -See xref:4.4@operations-manual:ROOT:manage-databases/remote-alias/index.adoc[Connecting remote databases] for the necessary configurations. +See link:{neo4j-docs-base-uri}/operations-manual/{page-version}/manage-databases/remote-alias[Connecting remote databases] for the necessary configurations. Creating remote aliases also allows `IF NOT EXISTS` and `OR REPLACE` clauses. Both check for any remote or local database aliases. diff --git a/modules/ROOT/pages/clauses/call.adoc b/modules/ROOT/pages/clauses/call.adoc index 9116bb438..c6d1ae164 100644 --- a/modules/ROOT/pages/clauses/call.adoc +++ b/modules/ROOT/pages/clauses/call.adoc @@ -47,10 +47,10 @@ Calling a `VOID` procedure in the middle of a larger query will simply pass on e [NOTE] ==== Neo4j comes with a number of built-in procedures. -For a list of these, see xref:4.4@operations-manual:ROOT:reference/procedures/index.adoc[Operations Manual -> Procedures]. +For a list of these, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/procedures[Operations Manual -> Procedures]. Users can also develop custom procedures and deploy to the database. -See xref:4.4@java-reference:ROOT:extending-neo4j/procedures.adoc#extending-neo4j-procedures[Java Reference -> User-defined procedures] for details. +See link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/procedures#extending-neo4j-procedures[Java Reference -> User-defined procedures] for details. ==== diff --git a/modules/ROOT/pages/clauses/delete.adoc b/modules/ROOT/pages/clauses/delete.adoc index 43018311c..352437a0c 100644 --- a/modules/ROOT/pages/clauses/delete.adoc +++ b/modules/ROOT/pages/clauses/delete.adoc @@ -93,7 +93,7 @@ Relationships deleted: 2 [NOTE] ==== -For `DETACH DELETE` for users with restricted security privileges, see xref:4.4@operations-manual:ROOT:authentication-authorization/access-control/index.adoc#detach-delete-restricted-user[Operations Manual -> Fine-grained access control]. +For `DETACH DELETE` for users with restricted security privileges, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/access-control#detach-delete-restricted-user[Operations Manual -> Fine-grained access control]. ==== diff --git a/modules/ROOT/pages/clauses/load-csv.adoc b/modules/ROOT/pages/clauses/load-csv.adoc index 71eddd9e7..92a9d0ad3 100644 --- a/modules/ROOT/pages/clauses/load-csv.adoc +++ b/modules/ROOT/pages/clauses/load-csv.adoc @@ -36,18 +36,18 @@ * `LOAD CSV` is often used in conjunction with the query hint `PERIODIC COMMIT`; more information on this may be found in xref::query-tuning/using.adoc#query-using-periodic-commit-hint[[deprecated\]#`PERIODIC COMMIT` query hint]. .Configuration settings for file URLs -xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.security.allow_csv_import_from_file_urls[dbms.security.allow_csv_import_from_file_urls]:: +link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.security.allow_csv_import_from_file_urls[dbms.security.allow_csv_import_from_file_urls]:: This setting determines if Cypher will allow the use of `+file:///+` URLs when loading data using `LOAD CSV`. Such URLs identify files on the filesystem of the database server. Default is _true_. Setting `dbms.security.allow_csv_import_from_file_urls=false` will completely disable access to the file system for `LOAD CSV`. -xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.directories.import[dbms.directories.import]:: +link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.directories.import[dbms.directories.import]:: Sets the root directory for `+file:///+` URLs used with the Cypher `LOAD CSV` clause. This should be set to a single directory relative to the Neo4j installation path on the database server. All requests to load from `+file:///+` URLs will then be relative to the specified directory. The default value set in the config settings is _import_. -This is a security measure which prevents the database from accessing files outside the standard xref:4.4@operations-manual:ROOT:configuration/file-locations/index.adoc[import directory], +This is a security measure which prevents the database from accessing files outside the standard link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/file-locations[import directory], similar to how a Unix `chroot` operates. Setting this to an empty field will allow access to all files within the Neo4j installation folder. Commenting out this setting will disable the security feature, allowing all files in the local system to be imported. @@ -241,7 +241,7 @@ The xref::clauses/use.adoc[`USE` clause] can not be used together with the `PERI [NOTE] ==== -Queries with the `PERIODIC COMMIT` query hint can not be routed by xref:4.4@operations-manual:ROOT:clustering/internals/index.adoc#causal-clustering-routing[Server-side routing]. +Queries with the `PERIODIC COMMIT` query hint can not be routed by link:{neo4j-docs-base-uri}/operations-manual/{page-version}/clustering/internals#causal-clustering-routing[Server-side routing]. ==== .Query diff --git a/modules/ROOT/pages/clauses/use.adoc b/modules/ROOT/pages/clauses/use.adoc index 40a1adf44..3f0628a3d 100644 --- a/modules/ROOT/pages/clauses/use.adoc +++ b/modules/ROOT/pages/clauses/use.adoc @@ -61,7 +61,7 @@ CALL { In subqueries, a `USE` clause may appear as the second clause, if directly following an xref::clauses/call-subquery.adoc#subquery-correlated-importing[importing `WITH` clause] When executing queries against a Fabric database, in addition to referring to databases in the DBMS, the `` may also refer to a graph mounted through the Fabric configuration. -For more information, see xref:4.4@operations-manual:ROOT:fabric/index.adoc[Operations Manual -> Fabric]. +For more information, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/fabric[Operations Manual -> Fabric]. [[query-use-examples]] diff --git a/modules/ROOT/pages/databases.adoc b/modules/ROOT/pages/databases.adoc index f1e03e621..9bc2d79c0 100644 --- a/modules/ROOT/pages/databases.adoc +++ b/modules/ROOT/pages/databases.adoc @@ -531,7 +531,7 @@ Subsequently, the database access mode can be switched back to read-write using Altering the database access mode is allowed at all times, whether a database is online or offline. Database access modes can also be managed using the configuration parameters `dbms.databases.default_to_read_only`, `dbms.databases.read_only`, and `dbms.database.writable`. -For details, see xref:4.4@operations-manual:ROOT:manage-databases/configuration/index.adoc#manage-databases-parameters[Configuration parameters]. +For details, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/manage-databases/configuration#manage-databases-parameters[Configuration parameters]. If conflicting modes are set by the `ALTER DATABASE` command and the configuration parameters, i.e. one says read-write and the other read-only, the database will be read-only and prevent write queries. diff --git a/modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc b/modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc index add195a66..aa45cfe56 100644 --- a/modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc +++ b/modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc @@ -613,6 +613,7 @@ SHOW ALIAS a| New privilege that allows a user to show aliases. Only supported since version 4.4.8. + |=== @@ -2510,7 +2511,7 @@ Replaced by: MATCH (n)-[x:A\|B\|C*]-() RETURN n ---- -| xref:4.4@java-reference:ROOT:extending-neo4j/aggregation-functions.adoc#extending-neo4j-aggregation-functions[User-defined aggregation functions] +| link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/aggregation-functions#extending-neo4j-aggregation-functions[User-defined aggregation functions] | Functionality | Added | @@ -2633,7 +2634,7 @@ a| See xref::functions/scalar.adoc#functions-toboolean[`toBoolean()`]. | Added | -| xref:4.4@java-reference:ROOT:extending-neo4j/functions.adoc#extending-neo4j-functions[User-defined functions] +| link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/functions#extending-neo4j-functions[User-defined functions] | Functionality | Added | @@ -2737,7 +2738,7 @@ distance() | Added a| See xref::functions/spatial.adoc#functions-distance[`distance()`]. -| xref:4.4@java-reference:ROOT:extending-neo4j/procedures.adoc#extending-neo4j-procedures[User-defined procedures] +| link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/procedures#extending-neo4j-procedures[User-defined procedures] | Functionality | Added | diff --git a/modules/ROOT/pages/execution-plans/index.adoc b/modules/ROOT/pages/execution-plans/index.adoc index d33d7ffec..0f4706541 100644 --- a/modules/ROOT/pages/execution-plans/index.adoc +++ b/modules/ROOT/pages/execution-plans/index.adoc @@ -77,7 +77,7 @@ The statistical information maintained by Neo4j is: . Selectivity per index. . The number of relationships by type, ending with or starting from a node with a specific label. -Information about how the statistics are kept up to date, as well as configuration options for managing query replanning and caching, can be found in the xref:4.4@operations-manual:ROOT:performance/statistics-execution-plans/index.adoc[Operations Manual -> Statistics and execution plans]. +Information about how the statistics are kept up to date, as well as configuration options for managing query replanning and caching, can be found in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/statistics-execution-plans[Operations Manual -> Statistics and execution plans]. xref::query-tuning/index.adoc[] describes how to tune Cypher queries. In particular, see xref::query-tuning/query-profile.adoc[] for how to view the execution plan for a query and xref::query-tuning/using.adoc[Planner hints and the USING keyword] for how to use _hints_ to influence the decisions of the planner when building an execution plan for a query. diff --git a/modules/ROOT/pages/execution-plans/shortestpath-planning.adoc b/modules/ROOT/pages/execution-plans/shortestpath-planning.adoc index 644010499..139613b0c 100644 --- a/modules/ROOT/pages/execution-plans/shortestpath-planning.adoc +++ b/modules/ROOT/pages/execution-plans/shortestpath-planning.adoc @@ -23,7 +23,7 @@ When the exhaustive search is planned, it is still only executed when the fast a The fast algorithm is always executed first, since it is possible that it can find a valid path even though that could not be guaranteed at planning time. Please note that falling back to the exhaustive search may prove to be a very time consuming strategy in some cases; such as when there is no shortest path between two nodes. -Therefore, in these cases, it is recommended to set `cypher.forbid_exhaustive_shortestpath` to `true`, as explained in xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_cypher.forbid_exhaustive_shortestpath[Operations Manual -> Configuration settings]. +Therefore, in these cases, it is recommended to set `cypher.forbid_exhaustive_shortestpath` to `true`, as explained in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_cypher.forbid_exhaustive_shortestpath[Operations Manual -> Configuration settings]. == Shortest path -- fast algorithm diff --git a/modules/ROOT/pages/functions/index.adoc b/modules/ROOT/pages/functions/index.adoc index 9e025a47f..90ca95657 100644 --- a/modules/ROOT/pages/functions/index.adoc +++ b/modules/ROOT/pages/functions/index.adoc @@ -746,12 +746,12 @@ There are two main types of functions that can be developed and used: | Scalar | For each row the function takes parameters and returns a result. | xref::functions/user-defined.adoc#query-functions-udf[Using UDF] -| xref:4.4@java-reference:ROOT:extending-neo4j/functions.adoc#extending-neo4j-functions[Extending Neo4j (UDF)] +| link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/functions#extending-neo4j-functions[Extending Neo4j (UDF)] | Aggregating | Consumes many rows and produces an aggregated result. | xref::functions/user-defined.adoc#query-functions-user-defined-aggregation[Using aggregating UDF] -| xref:4.4@java-reference:ROOT:extending-neo4j/aggregation-functions.adoc#extending-neo4j-aggregation-functions[Extending Neo4j (Aggregating UDF)] +| link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/aggregation-functions#extending-neo4j-aggregation-functions[Extending Neo4j (Aggregating UDF)] |=== diff --git a/modules/ROOT/pages/functions/user-defined.adoc b/modules/ROOT/pages/functions/user-defined.adoc index 3bbcc06af..f21f155c9 100644 --- a/modules/ROOT/pages/functions/user-defined.adoc +++ b/modules/ROOT/pages/functions/user-defined.adoc @@ -17,12 +17,12 @@ There are two main types of functions that can be developed and used: | Scalar | For each row the function takes parameters and returns a result. | xref::functions/user-defined.adoc#query-functions-udf[Using UDF] -| xref:4.4@java-reference:ROOT:extending-neo4j/functions.adoc#extending-neo4j-functions[Extending Neo4j (UDF)] +| link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/functions#extending-neo4j-functions[Extending Neo4j (UDF)] | Aggregating | Consumes many rows and produces an aggregated result. | xref::functions/user-defined.adoc#query-functions-user-defined-aggregation[Using aggregating UDF] -| xref:4.4@java-reference:ROOT:extending-neo4j/aggregation-functions.adoc#extending-neo4j-aggregation-functions[Extending Neo4j (Aggregating UDF)] +| link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/aggregation-functions#extending-neo4j-aggregation-functions[Extending Neo4j (Aggregating UDF)] |=== @@ -32,7 +32,7 @@ There are two main types of functions that can be developed and used: For each incoming row the function takes parameters and returns a single result. -For developing and deploying user-defined functions in Neo4j, see xref:4.4@java-reference:ROOT:extending-neo4j/functions.adoc#extending-neo4j-functions[Extending Neo4j -> User-defined functions]. +For developing and deploying user-defined functions in Neo4j, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/functions#extending-neo4j-functions[Extending Neo4j -> User-defined functions]. .Call a user-defined function diff --git a/modules/ROOT/pages/indexes-for-full-text-search.adoc b/modules/ROOT/pages/indexes-for-full-text-search.adoc index 50d881ea5..8940d2609 100644 --- a/modules/ROOT/pages/indexes-for-full-text-search.adoc +++ b/modules/ROOT/pages/indexes-for-full-text-search.adoc @@ -42,13 +42,13 @@ In contrast to xref::indexes-for-search-performance.adoc[B-tree indexes], a full * applied to more than one property at a time (similar to a xref::indexes-for-search-performance.adoc#administration-indexes-create-a-composite-b-tree-index-for-nodes[_composite index_]) but with an important difference: While a composite index applies only to entities that match the indexed label and _all_ of the indexed properties, full-text index will index entities that have at least one of the indexed labels or relationship types, and at least one of the indexed properties. -For information on how to configure full-text indexes, refer to xref:4.4@operations-manual:ROOT:performance/index-configuration/index.adoc#index-configuration-fulltext[Operations Manual -> Indexes to support full-text search]. +For information on how to configure full-text indexes, refer to link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/index-configuration#index-configuration-fulltext[Operations Manual -> Indexes to support full-text search]. [[administration-indexes-fulltext-search-manage]] == Full-text search procedures -Full-text indexes are managed through commands and used through built-in procedures, see xref:4.4@operations-manual:ROOT:reference/procedures/index.adoc[Operations Manual -> Procedures] for a complete reference. +Full-text indexes are managed through commands and used through built-in procedures, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/procedures[Operations Manual -> Procedures] for a complete reference. The commands and procedures for full-text indexes are listed in the table below: diff --git a/modules/ROOT/pages/indexes-for-search-performance.adoc b/modules/ROOT/pages/indexes-for-search-performance.adoc index 6cde0b9ba..e45fdbc47 100644 --- a/modules/ROOT/pages/indexes-for-search-performance.adoc +++ b/modules/ROOT/pages/indexes-for-search-performance.adoc @@ -12,7 +12,7 @@ For query performance purposes, it is important to also understand how the index Refer to xref::query-tuning/index.adoc[] for examples and in-depth discussions on how query plans result from different index and query scenarios. See specifically xref::query-tuning/indexes.adoc[The use of indexes] for examples of how various index scenarios result in different query plans. -For information on index configuration and limitations, refer to xref:4.4@operations-manual:ROOT:performance/index-configuration/index.adoc[Operations Manual -> Index configuration]. +For information on index configuration and limitations, refer to link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/index-configuration[Operations Manual -> Index configuration]. [[administration-indexes-types]] @@ -1505,7 +1505,7 @@ DROP INDEX missing_index_name IF EXISTS Two new types of indexes, point and range indexes, will be introduced in a future release. They cannot be used in queries yet, but they can be created and dropped for migration purposes. These new index types together with text indexes will replace the current B-tree indexes. -For more details on these new types, see the xref:4.4@operations-manual:ROOT:performance/index-configuration/index.adoc#future-indexes[Operations Manual -> Future indexes]. +For more details on these new types, see the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/index-configuration#future-indexes[Operations Manual -> Future indexes]. Like B-tree indexes, range indexes are created on one or more properties for all nodes or relationships with a given label or relationship type: diff --git a/modules/ROOT/pages/introduction/transactions.adoc b/modules/ROOT/pages/introduction/transactions.adoc index 56becfb3f..44862f0c9 100644 --- a/modules/ROOT/pages/introduction/transactions.adoc +++ b/modules/ROOT/pages/introduction/transactions.adoc @@ -17,7 +17,7 @@ In short, an updating query always either fully succeeds, or does not succeed at [NOTE] ==== A query that makes a large number of updates consequently uses large amounts of memory since the transaction holds changes in memory. -For memory configuration in Neo4j, see the xref:4.4@operations-manual:ROOT:performance/memory-configuration.adoc[Neo4j Operations Manual -> Memory configuration]. +For memory configuration in Neo4j, see the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/memory-configuration[Neo4j Operations Manual -> Memory configuration]. ==== Transactions can be either _explicit_ or _implicit_. @@ -37,8 +37,8 @@ Queries that start separate transactions themselves, such as queries using xref: For examples of the API's used to start and commit transactions, refer to the API specific documentation: * For information on using transactions with a Neo4j driver, see _The session API_ in the link:{docs-base-uri}[Neo4j Driver manuals]. -* For information on using transactions over the HTTP API, see the xref:4.4@http-api:ROOT:actions/index.adoc#http-api-actions[HTTP API documentation -> Using the HTTP API]. -* For information on using transactions within the embedded Core API, see the xref:4.4@java-reference:ROOT:java-embedded/cypher-java.adoc#cypher-java[Java Reference -> Executing Cypher queries from Java]. +* For information on using transactions over the HTTP API, see the link:{neo4j-docs-base-uri}/http-api/{page-version}/actions#http-api-actions[HTTP API documentation -> Using the HTTP API]. +* For information on using transactions within the embedded Core API, see the link:{neo4j-docs-base-uri}/java-reference/{page-version}/java-embedded/cypher-java#cypher-java[Java Reference -> Executing Cypher queries from Java]. When writing procedures or using Neo4j embedded, remember that all iterators returned from an execution result should be either fully exhausted or closed. This ensures that the resources bound to them are properly released. diff --git a/modules/ROOT/pages/query-tuning/advanced-example.adoc b/modules/ROOT/pages/query-tuning/advanced-example.adoc index ee246d787..846063427 100644 --- a/modules/ROOT/pages/query-tuning/advanced-example.adoc +++ b/modules/ROOT/pages/query-tuning/advanced-example.adoc @@ -20,7 +20,7 @@ Let's explain how to use these features with a more advanced query tuning exampl [NOTE] ==== If you are upgrading an existing store to {neo4j-version-exact}, it may be necessary to drop and re-create existing indexes. -For information on native index support and upgrade considerations regarding indexes, see xref:4.4@operations-manual:ROOT:performance/index-configuration.adoc#index-configuration-btree[Operations Manual -> Indexes]. +For information on native index support and upgrade considerations regarding indexes, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/index-configuration#index-configuration-btree[Operations Manual -> Indexes]. ==== @@ -544,8 +544,8 @@ It assumes that your current work directory is the __ directory of t [NOTE] ==== -* For the default directory of other installations see, xref:4.4@operations-manual:ROOT:configuration/file-locations/index.adoc[Operations Manual -> File locations]. -* The import location can be configured with xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.directories.import[Operations Manual -> `dbms.directories.import`]. +* For the default directory of other installations see, link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/file-locations[Operations Manual -> File locations]. +* The import location can be configured with link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.directories.import[Operations Manual -> `dbms.directories.import`]. ==== == Importing the data diff --git a/modules/ROOT/pages/query-tuning/basic-example.adoc b/modules/ROOT/pages/query-tuning/basic-example.adoc index e20bedac6..c6951426b 100644 --- a/modules/ROOT/pages/query-tuning/basic-example.adoc +++ b/modules/ROOT/pages/query-tuning/basic-example.adoc @@ -531,8 +531,8 @@ It assumes that your current work directory is the __ directory of t [NOTE] ==== -* For the default directory of other installations see, xref:4.4@operations-manual:ROOT:configuration/file-locations/index.adoc[Operations Manual -> File locations]. -* The import location can be configured with xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.directories.import[Operations Manual -> `dbms.directories.import`]. +* For the default directory of other installations see, link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/file-locations[Operations Manual -> File locations]. +* The import location can be configured with link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.directories.import[Operations Manual -> `dbms.directories.import`]. ==== == Importing the data diff --git a/modules/ROOT/pages/query-tuning/query-options.adoc b/modules/ROOT/pages/query-tuning/query-options.adoc index 8c30bb7b0..7befed65a 100644 --- a/modules/ROOT/pages/query-tuning/query-options.adoc +++ b/modules/ROOT/pages/query-tuning/query-options.adoc @@ -315,8 +315,8 @@ This setting is experimental, and using it in a production environment is discou Cypher replanning occurs in the following circumstances: * When the query is not in the cache. -This can either be when the server is first started or restarted, if the cache has recently been cleared, or if xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.query_cache_size[dbms.query_cache_size] was exceeded. -* When the time has past the xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_cypher.min_replan_interval[cypher.min_replan_interval] value, and the database statistics have changed more than the xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_cypher.statistics_divergence_threshold[cypher.statistics_divergence_threshold] value. +This can either be when the server is first started or restarted, if the cache has recently been cleared, or if link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.query_cache_size[dbms.query_cache_size] was exceeded. +* When the time has past the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_cypher.min_replan_interval[cypher.min_replan_interval] value, and the database statistics have changed more than the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_cypher.statistics_divergence_threshold[cypher.statistics_divergence_threshold] value. There may be situations where xref::execution-plans/index.adoc[Cypher query planning] can occur at a non-ideal time. For example, when a query must be as fast as possible and a valid plan is already in place. diff --git a/modules/ROOT/pages/query-tuning/using.adoc b/modules/ROOT/pages/query-tuning/using.adoc index c72247abd..c1ee73977 100644 --- a/modules/ROOT/pages/query-tuning/using.adoc +++ b/modules/ROOT/pages/query-tuning/using.adoc @@ -1031,7 +1031,7 @@ The xref::clauses/use.adoc[`USE` clause] can not be used together with the `PERI [NOTE] ==== -Queries with the `PERIODIC COMMIT` query hint can not be routed by xref:4.4@operations-manual:ROOT:clustering/internals/index.adoc#causal-clustering-routing[Server-side routing]. +Queries with the `PERIODIC COMMIT` query hint can not be routed by link:{neo4j-docs-base-uri}/operations-manual/{page-version}/clustering/internals#causal-clustering-routing[Server-side routing]. Such queries must rely on standard client-side routing, done by the Neo4j Driver. ==== diff --git a/modules/ROOT/pages/syntax/maps.adoc b/modules/ROOT/pages/syntax/maps.adoc index c4b54db38..0d83cf820 100644 --- a/modules/ROOT/pages/syntax/maps.adoc +++ b/modules/ROOT/pages/syntax/maps.adoc @@ -23,7 +23,7 @@ The behavior of the `[]` operator with respect to `null` is detailed xref::synta Cypher supports construction of maps. The key names in a map must be of type `String`. -If returned through an xref:4.4@http-api:ROOT:index.adoc#http-api[HTTP API call], a JSON object will be returned. +If returned through an link:{neo4j-docs-base-uri}/http-api/{page-version}/index#http-api[HTTP API call], a JSON object will be returned. If returned in Java, an object of type `java.util.Map` will be returned. //// diff --git a/modules/ROOT/pages/syntax/parameters.adoc b/modules/ROOT/pages/syntax/parameters.adoc index b86f351d4..6068de5c2 100644 --- a/modules/ROOT/pages/syntax/parameters.adoc +++ b/modules/ROOT/pages/syntax/parameters.adoc @@ -33,11 +33,11 @@ Setting parameters when running a query is dependent on the client environment. For example: * To set a parameter in Cypher Shell use `+:param name => 'Joe'+`. - For more information refer to xref:4.4@operations-manual:ROOT:tools/cypher-shell/index.adoc#cypher-shell-parameters[Operations Manual -> Cypher Shell - Query Parameters]. + For more information refer to link:{neo4j-docs-base-uri}/operations-manual/{page-version}/tools/cypher-shell#cypher-shell-parameters[Operations Manual -> Cypher Shell - Query Parameters]. * For Neo4j Browser use the same syntax as Cypher Shell, `+:param name => 'Joe'+`. * When using drivers, the syntax is dependent on the language choice. See the examples in _Transactions_ in the link:{docs-base-uri}[Neo4j Driver manuals]. -* For usage via the Neo4j HTTP API, see the xref:4.4@http-api:ROOT:index.adoc#http-api[HTTP API documentation]. +* For usage via the Neo4j HTTP API, see the link:{neo4j-docs-base-uri}/http-api/{page-version}/index#http-api[HTTP API documentation]. We provide below a comprehensive list of examples of parameter usage. In these examples, parameters are given in JSON; the exact manner in which they are to be submitted depends upon the driver being used. diff --git a/modules/ROOT/pages/syntax/temporal.adoc b/modules/ROOT/pages/syntax/temporal.adoc index 09b23b95f..f5034bfc1 100644 --- a/modules/ROOT/pages/syntax/temporal.adoc +++ b/modules/ROOT/pages/syntax/temporal.adoc @@ -61,7 +61,7 @@ See xref::syntax/temporal.adoc#cypher-temporal-specify-time-zone[Specifying time The named time zone form uses the rules of the IANA time zone database to manage _daylight savings time_ (DST). -The default time zone of the database can be configured using the configuration option xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_db.temporal.timezone[`db.temporal.timezone`]. +The default time zone of the database can be configured using the configuration option link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_db.temporal.timezone[`db.temporal.timezone`]. This configuration option influences the creation of temporal types for the following functions: * Getting the current date and time without specifying a time zone. diff --git a/preview.yml b/preview.yml index faac98146..b1626a555 100644 --- a/preview.yml +++ b/preview.yml @@ -54,3 +54,5 @@ asciidoc: docs-base-uri: https://neo4j.com/docs check-mark: icon:check[] cross-mark: icon:times[] + neo4j-base-uri: https://neo4j.com + neo4j-docs-base-uri: https://neo4j.com/docs diff --git a/publish.yml b/publish.yml index 4087df0c4..8c740fe45 100644 --- a/publish.yml +++ b/publish.yml @@ -54,3 +54,5 @@ asciidoc: docs-base-uri: https://neo4j.com/docs check-mark: icon:check[] cross-mark: icon:times[] + neo4j-base-uri: '' + neo4j-docs-base-uri: /docs \ No newline at end of file From 962704ee37b498998757bc1c2a6715260c16ea3e Mon Sep 17 00:00:00 2001 From: Neil Dewhurst Date: Tue, 15 Nov 2022 10:05:10 +0000 Subject: [PATCH 2/2] fix two links to http-api --- modules/ROOT/pages/syntax/maps.adoc | 2 +- modules/ROOT/pages/syntax/parameters.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/syntax/maps.adoc b/modules/ROOT/pages/syntax/maps.adoc index 0d83cf820..2268b4fb8 100644 --- a/modules/ROOT/pages/syntax/maps.adoc +++ b/modules/ROOT/pages/syntax/maps.adoc @@ -23,7 +23,7 @@ The behavior of the `[]` operator with respect to `null` is detailed xref::synta Cypher supports construction of maps. The key names in a map must be of type `String`. -If returned through an link:{neo4j-docs-base-uri}/http-api/{page-version}/index#http-api[HTTP API call], a JSON object will be returned. +If returned through an link:{neo4j-docs-base-uri}/http-api/{page-version}[HTTP API call], a JSON object will be returned. If returned in Java, an object of type `java.util.Map` will be returned. //// diff --git a/modules/ROOT/pages/syntax/parameters.adoc b/modules/ROOT/pages/syntax/parameters.adoc index 6068de5c2..9d318ce3b 100644 --- a/modules/ROOT/pages/syntax/parameters.adoc +++ b/modules/ROOT/pages/syntax/parameters.adoc @@ -37,7 +37,7 @@ For example: * For Neo4j Browser use the same syntax as Cypher Shell, `+:param name => 'Joe'+`. * When using drivers, the syntax is dependent on the language choice. See the examples in _Transactions_ in the link:{docs-base-uri}[Neo4j Driver manuals]. -* For usage via the Neo4j HTTP API, see the link:{neo4j-docs-base-uri}/http-api/{page-version}/index#http-api[HTTP API documentation]. +* For usage via the Neo4j HTTP API, see the link:{neo4j-docs-base-uri}/http-api/{page-version}[HTTP API documentation]. We provide below a comprehensive list of examples of parameter usage. In these examples, parameters are given in JSON; the exact manner in which they are to be submitted depends upon the driver being used.