Skip to content

Commit b3f6e24

Browse files
Put back page-version for the Ops manual and fix links on locks/deadlocks
1 parent 0caf4c5 commit b3f6e24

File tree

8 files changed

+14
-14
lines changed

8 files changed

+14
-14
lines changed

modules/ROOT/pages/extending-neo4j/best-practices.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
= Best practices
66

77
It is important to consider any security implications of deploying customized code.
8-
Refer to the link:{neo4j-docs-base-uri}/operations-manual/current/security/securing-extensions[Operations Manual -> Securing Extensions] for details on best practices for securing user-defined procedures and functions.
8+
Refer to the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/security/securing-extensions[Operations Manual -> Securing Extensions] for details on best practices for securing user-defined procedures and functions.
99

1010
Since you will be running custom-built code and Neo4j in the same JVM, there are a few things you should keep in mind:
1111

modules/ROOT/pages/extending-neo4j/customized-code.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Examples of use cases for procedures and functions are:
1616

1717
Procedures and functions are written in Java and compiled into JAR files.
1818
They are deployed to the database by dropping that JAR file into the _plugins_ directory on each standalone or clustered server.
19-
For the location of the _plugins_ directory, refer to link:{neo4j-docs-base-uri}/operations-manual/current/configuration/file-locations[Operations Manual -> Default file locations].
19+
For the location of the _plugins_ directory, refer to link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/file-locations[Operations Manual -> Default file locations].
2020
The database must be restarted on each server to pick up new procedures and functions.
2121

2222
Procedures and functions can take arguments and return results.
@@ -53,7 +53,7 @@ In addition, procedures can perform write operations on the database.
5353

5454
Neo4j also comes bundled with a number of _built-in_ procedures and functions.
5555

56-
The available built-in procedures vary depending on edition and mode, as described in link:{neo4j-docs-base-uri}/operations-manual/current/reference/procedures[Operations Manual -> Procedures].
56+
The available built-in procedures vary depending on edition and mode, as described in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/procedures[Operations Manual -> Procedures].
5757
Running `SHOW PROCEDURES` displays the full list of procedures available in your Neo4j DBMS, including user-defined procedures.
5858

5959
The built-in functions are described in link:{neo4j-docs-base-uri}/cypher-manual/current/functions[Cypher Manual -> Functions].

modules/ROOT/pages/extending-neo4j/procedures.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ The classes that can be injected are:
195195
All of the above classes are considered safe and future-proof and do not compromise the security of the database.
196196
Several unsupported (restricted) classes can also be injected and can be changed with little or no notice.
197197
Procedures written to use these restricted APIs are not loaded by default, and you need to use the `dbms.security.procedures.unrestricted` to load unsafe procedures.
198-
Read more about this config setting in link:{neo4j-docs-base-uri}/operations-manual/current/security/securing-extensions[Operations Manual -> Securing extensions].
198+
Read more about this config setting in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/security/securing-extensions[Operations Manual -> Securing extensions].
199199

200200
[[memory-resource-tracking]]
201201
== Memory Resource Tracking
@@ -206,7 +206,7 @@ The memory resource tracking API for the procedure framework is available for pr
206206
Future versions of Neo4j might contain breaking changes to this API.
207207
====
208208

209-
If your procedure or function allocates significant amounts of heap memory, you can register allocations to count towards the configured transaction limits, see link:{neo4j-docs-base-uri}/operations-manual/current/performance/memory-configuration/#memory-configuration-limit-transaction-memory[Operations Manual -> Limit transaction memory usage] for more information.
209+
If your procedure or function allocates significant amounts of heap memory, you can register allocations to count towards the configured transaction limits, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/memory-configuration/#memory-configuration-limit-transaction-memory[Operations Manual -> Limit transaction memory usage] for more information.
210210
This allows you to avoid `OutOfMemory` errors that cause database restarts.
211211
Memory allocations also show up in query profiles.
212212

modules/ROOT/pages/extending-neo4j/security-plugins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Neo4j provides authentication and authorization plugin interfaces to support rea
99

1010
The SPI (Service Provider Interface) lives in the `com.neo4j.server.security.enterprise.auth.plugin.spi` package.
1111

12-
Customized-built plugins have access to the link:{neo4j-docs-base-uri}/operations-manual/current/configuration/file-locations[_<neo4j-home>_] directory in case you want to load any customized settings from a file located there.
12+
Customized-built plugins have access to the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/file-locations[_<neo4j-home>_] directory in case you want to load any customized settings from a file located there.
1313
Plugins can also write to the security event log.
1414

1515

modules/ROOT/pages/java-embedded/setup.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The following examples use the top-level artifact approach.
2121
====
2222
The examples are only valid for Neo4j Community Edition.
2323
To add Neo4j Enterprise Edition as a dependency, please get in contact with link:https://neo4j.com/contact-us/[Neo4j Professional Services^].
24-
See link:{neo4j-docs-base-uri}/operations-manual/current/introduction[Operations Manual -> Introduction] for details about the Community and Enterprise Editions.
24+
See link:{neo4j-docs-base-uri}/operations-manual/{page-version}/introduction[Operations Manual -> Introduction] for details about the Community and Enterprise Editions.
2525
====
2626

2727

@@ -127,7 +127,7 @@ registerShutdownHook( managementService );
127127

128128
If you are using the Enterprise Edition of Neo4j in embedded mode, you have to create your database with the link:{com-neo4j-dbms-api-EnterpriseDatabaseManagementServiceBuilder}[`com.neo4j.dbms.api.EnterpriseDatabaseManagementServiceBuilder`^] to enable the Enterprise Edition features.
129129
If you intend to operate embedded clusters, you need to provide the appropriate configuration to the instances you create (for example ports and discovery endpoints).
130-
For maintainability purposes, you can define your embedded DBMS configuration in the link:{neo4j-docs-base-uri}/operations-manual/current/configuration/neo4j-conf[_neo4j.conf_] file as follows:
130+
For maintainability purposes, you can define your embedded DBMS configuration in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/neo4j-conf[_neo4j.conf_] file as follows:
131131

132132
//https://github.com/neo4j/neo4j-documentation/blob/dev/embedded-examples/src/main/java/org/neo4j/examples/EmbeddedNeo4jClusterUsingBuilder.java
133133
//EmbeddedNeo4jClusterUsingBuilder.java[tag=neo4jConf]

modules/ROOT/pages/java-embedded/unique-nodes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,5 +82,5 @@ You might also be tempted to use Java synchronization for pessimistic locking, b
8282
By mixing locks in Neo4j and the Java runtime, it is possible to produce deadlocks that are not detectable by Neo4j.
8383
As long as all locking is done by Neo4j, all deadlocks will be detected and avoided.
8484

85-
For more information on locks and deadlocks, see link:{neo4j-docs-base-uri}/operations-manual/current/database-internals/locks-deadlocks.adoc#_locks[Operations Manual -> Locks and deadlocks^].
85+
For more information on locks and deadlocks, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-internals/concurrent-data-access#_locks[Operations Manual -> Locks and deadlocks^].
8686

modules/ROOT/pages/jmx-metrics.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@
77
This topic describes how to access JMX for Neo4j DBMS to monitor metrics.
88

99
Neo4j provides different levels of monitoring facilities to supply a continuous overview of the system's health.
10-
For a description of the monitoring options, see link:{neo4j-docs-base-uri}/operations-manual/current/monitoring[Neo4j Operations Manual -> Monitoring].
10+
For a description of the monitoring options, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/monitoring[Neo4j Operations Manual -> Monitoring].
1111
Many of the metrics are exposed through link:https://www.oracle.com/java/technologies/javase/javamanagement.html[JMX^].
1212

1313
[NOTE]
1414
====
1515
The available JMX MBeans and their names have been updated in Neo4j 4.0.
16-
Beans that duplicate metrics or monitoring options, described in link:{neo4j-docs-base-uri}/operations-manual/current/monitoring/metrics/reference/#jvm-metrics[Neo4j Operations Manual -> Monitoring], have been removed.
16+
Beans that duplicate metrics or monitoring options, described in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/monitoring/metrics/reference/#jvm-metrics[Neo4j Operations Manual -> Monitoring], have been removed.
1717
====
1818

1919
[[jmx-remote]]
2020
== Adjusting remote JMX access to Neo4j
2121

2222
By default, the Neo4j Enterprise edition does not allow remote JMX connections.
23-
To enable this feature, you need to enable JMX Remote Management and also configure JMX for secure remote access, in the link:{neo4j-docs-base-uri}/operations-manual/current/configuration/neo4j-conf[_conf/neo4j.conf_ file].
23+
To enable this feature, you need to enable JMX Remote Management and also configure JMX for secure remote access, in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/neo4j-conf[_conf/neo4j.conf_ file].
2424

2525

2626
[[enable-jmx-remote]]

modules/ROOT/pages/transaction-management.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
====
1313
This page describes only some specific aspects of transaction management when used with the Neo4j Java API and provides some examples of how to avoid deadlocks, and how to register a transaction event listener for a specific database and perform basic operations on top of the transaction change set.
1414
15-
Therefore, it is highly recommended that you read link:{neo4j-docs-base-uri}/operations-manual/current/database-internals/[Operations Manual -> Database internals and transactional behavior] before you continue reading this page.
15+
Therefore, it is highly recommended that you read link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-internals/[Operations Manual -> Database internals and transactional behavior] before you continue reading this page.
1616
====
1717

1818
[[transactions-overview]]
@@ -31,7 +31,7 @@ The interaction cycle of working with transactions follows the steps:
3131
[NOTE]
3232
====
3333
It is crucial to finish each transaction because the locks or memory acquired by a transaction are only released upon completion.
34-
For more information on locks and deadlocks, see link:{neo4j-docs-base-uri}/operations-manual/current/database-internals/locks-deadlocks[Operations Manual -> Locks and deadlocks^].
34+
For more information on locks and deadlocks, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-internals/concurrent-data-access/#_locks[Operations Manual -> Locks and deadlocks^].
3535
====
3636

3737
The idiomatic use of transactions in Neo4j is to use a `try-with-resources` statement and declare `transaction` as one of the resources.

0 commit comments

Comments
 (0)