Skip to content

Commit 918489c

Browse files
authored
Merge branch 'dev' into kubernetes-diagram
2 parents e37414b + 7613a00 commit 918489c

File tree

14 files changed

+69
-57
lines changed

14 files changed

+69
-57
lines changed

modules/ROOT/pages/authentication-authorization/built-in-roles.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -827,7 +827,7 @@ These include the rights to perform the following classes of tasks:
827827

828828
* Manage xref:authentication-authorization/database-administration.adoc[database privileges] to control the rights to perform actions on specific databases:
829829
** Manage access to a database and the right to start and stop a database.
830-
** Manage link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/search-performance-indexes/overview/[indexes] and link:{neo4j-docs-base-uri}/cypher-manual/current/constraints/[constraints].
830+
** Manage link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/[indexes] and link:{neo4j-docs-base-uri}/cypher-manual/current/constraints/[constraints].
831831
** Allow the creation of labels, relationship types, or property names.
832832
** Manage transactions.
833833
* Manage xref:authentication-authorization/dbms-administration.adoc[DBMS privileges] to control the rights to perform actions on the entire system:

modules/ROOT/pages/authentication-authorization/dbms-administration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ This includes the following tasks and their relevant privileges:
9797
* Manage xref:authentication-authorization/privileges-reads.adoc[read] and xref:authentication-authorization/privileges-writes.adoc[write] sub-graph privileges.
9898
* Manage <<access-control-dbms-administration-impersonation, impersonation privileges>>.
9999
* Manage <<access-control-dbms-administration-execute, procedure security>>.
100-
* Manage <<access-control-dbms-administration-load-privileges, load data security>>.
100+
* Manage xref:authentication-authorization/load-privileges.adoc[load data security].
101101

102102
To enable a user to perform these tasks, you can grant them the `admin` role, but it is also possible to make a custom role with a subset of these privileges.
103103
All privileges are also assignable using Cypher commands.

modules/ROOT/pages/authentication-authorization/limitations.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ Further to that, Neo4j's role-based access control has some limitations and impl
2626
== Security and indexes
2727

2828
Neo4j lets you create and use indexes to speed up Cypher queries.
29-
See the link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/search-performance-indexes/[Cypher Manual -> Indexes] for more details on the different types of indexes available in Neo4j.
29+
See the link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/[Cypher Manual -> Indexes] for more details on the different types of indexes available in Neo4j.
3030

3131
However, Neo4j’s security model still controls what results you see, regardless of whether or not you use indexes.
32-
For example, when you use link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/search-performance-indexes/overview/[search-performance indexes] (non–full-text) indexes, queries return the same results they would without any index.
32+
For example, when you use link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/search-performance-indexes/[search-performance indexes] (non–full-text) indexes, queries return the same results they would without any index.
3333
This means that, if the security model causes fewer results to be returned due to restricted read access in xref:authentication-authorization/manage-privileges.adoc[graph and sub-graph access control],
3434
the index will also return the same fewer results.
3535

modules/ROOT/pages/backup-restore/planning.adoc

Lines changed: 46 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you have zero tolerance for downtime and data loss, you might want to conside
3838
** use SSL/TLS for the backup network communication (online only).
3939
** keep your databases as archive files (online or offline).
4040
* How many backups you want to keep.
41-
* Where the backups will be stored —drive or remote server, cloud storage, different data center, different location, etc.
41+
* Where the backups will be stored — drive or remote server, cloud storage, different data center, different location, etc.
4242
+
4343
[TIP]
4444
====
@@ -51,15 +51,14 @@ This ensures that if for some reason your Neo4j DBMS crashes, you will be able t
5151
== Backup and restore options
5252

5353
Neo4j supports backing up and restoring both online and offline databases.
54-
It uses xref:neo4j-admin-neo4j-cli.adoc[Neo4j Admin tool] commands, which can be run from a live, as well as from an offline Neo4j DBMS.
54+
It uses xref:neo4j-admin-neo4j-cli.adoc[Neo4j Admin tool] commands that can be executed on a Neo4j DBMS, whether it is running or offline.
5555
All `neo4j-admin` commands must be invoked as the `neo4j` user to ensure the appropriate file permissions.
5656

57-
* `neo4j-admin database backup/restore` (Enterprise only) -– used for performing online backup (xref:backup-restore/modes.adoc#full-backup[full] and xref:backup-restore/modes.adoc#differential-backup[differential]) and restore operations.
58-
The database to be backed up must be in **online** mode.
59-
The command produces an immutable artifact, which has an inspectable API to aid management and operability.
60-
This command is suitable for production environments, where you cannot afford downtime.
61-
+
62-
The command can also be invoked over the network if access is enabled using `server.backup.listen_address`.
57+
* `neo4j-admin database backup/restore` label:enterprise[Enterprise Edition] – used for performing online backup (xref:backup-restore/modes.adoc#full-backup[full] and xref:backup-restore/modes.adoc#differential-backup[differential]) and restore operations.
58+
** The database to be backed up must be in **online** mode.
59+
** The command produces an immutable artifact, which has an inspectable API to aid management and operability.
60+
** This command is suitable for production environments, where you cannot afford downtime.
61+
** The command can also be invoked over the network if access is enabled using `server.backup.listen_address`.
6362
+
6463
[NOTE]
6564
====
@@ -73,9 +72,9 @@ For more information, refer to the xref:backup-restore/online-backup.adoc#backup
7372
When using `neo4j-admin database backup` in a cluster, it is recommended to back up from an external instance as opposed to reuse instances that form part of the cluster.
7473
====
7574
* `neo4j-admin database dump/load` –- used for performing offline dump and load operations.
76-
The database to be dumped must be in **offline** mode.
77-
The dump command can only be invoked from the server command line and is suitable for environments where downtime is not a factor.
78-
The command produces an archive file that follows the format _<databasename><timestamp>.dump_.
75+
** The database to be dumped must be in **offline** mode.
76+
** The dump command can only be invoked from the server command line and is suitable for environments where downtime is not a factor.
77+
** The command produces an archive file that follows the format _<databasename><timestamp>.dump_.
7978
* `neo4j-admin database copy` –- used for copying an offline database or backup.
8079
This command can be used for cleaning up database inconsistencies and reclaiming unused space.
8180

@@ -84,23 +83,9 @@ This command can be used for cleaning up database inconsistencies and reclaiming
8483
File system copy-and-paste of databases is not supported and may result in unwanted behavior, such as corrupt stores.
8584
====
8685

87-
=== Considerations for backing up and restoring databases in a cluster
88-
89-
Backing up a database in a clustered environment is not essentially different from a standalone backup, apart from the fact that you must know which server in a cluster to connect to.
90-
Use `SHOW DATABASE <database>` to learn which servers are hosting the database you want to back up.
91-
See xref:clustering/monitoring/show-databases-monitoring.adoc#show-databases-monitoring-listing-single[Listing a single database] for more information.
92-
93-
However, _restoring_ a database in a cluster is different since it is not known in advance how a database is going to be allocated to the servers in a cluster.
94-
This method relies on the seed already existing on one of the servers.
95-
The recommended way to restore a database in a cluster is to xref::database-administration/standard-databases/seed-from-uri.adoc[seed from URI].
86+
The following table summarizes the commands' capabilities and usage.
9687

97-
[NOTE]
98-
====
99-
The Neo4j Admin commands `backup`, `restore`, `dump`, `load`, `copy`, and `check-consistency` are not supported for use on xref:database-administration/composite-databases/concepts.adoc[Composite databases].
100-
They must be run directly on the databases that are associated with that Composite database.
101-
====
102-
103-
.The following table describes the commands' capabilities and usage.
88+
.`neo4j-admin` commands for backing up and restoring databases
10489
[cols="<,^,^,^",frame="topbot",options="header"]
10590
|===
10691
| Capability/ Usage
@@ -184,18 +169,45 @@ They must be run directly on the databases that are associated with that Composi
184169
| {check-mark}
185170
|===
186171

172+
173+
[NOTE]
174+
====
175+
The Neo4j Admin commands `backup`, `restore`, `dump`, `load`, `copy`, and `check-consistency` are not supported for use on xref:database-administration/composite-databases/concepts.adoc[Composite databases].
176+
They must be run directly on the databases that are associated with that Composite database.
177+
====
178+
179+
180+
== Considerations for backing up and restoring databases in a cluster
181+
182+
Backing up a database in a clustered environment is not essentially different from a standalone backup, apart from the fact that you must know which server in a cluster to connect to.
183+
Use `SHOW DATABASE <database>` to learn which servers are hosting the database you want to back up.
184+
See xref:clustering/monitoring/show-databases-monitoring.adoc#show-databases-monitoring-listing-single[Listing a single database] for more information.
185+
186+
Restoring from the command line involves putting a copy of the database on disk on each server that will need it.
187+
That can be awkward to achieve.
188+
The recommended way to restore a database in a cluster is to xref::database-administration/standard-databases/seed-from-uri.adoc[seed from URI].
189+
190+
[IMPORTANT]
191+
====
192+
By default, a database backup includes only the database contents.
193+
If you choose to include metadata, the backup also stores the role-based access control (RBAC) settings associated with the database.
194+
195+
When restoring, you have the flexibility to define the target topology (how many primaries and secondaries are desired for the database), which may differ from the topology at backup time.
196+
The database will then be allocated across the available servers according to that topology.
197+
====
198+
187199
[[backup-planning-databases]]
188-
== Databases to backup
200+
== Databases to back up
189201

190202
A Neo4j DBMS can host multiple databases.
191-
Both Neo4j Community and Enterprise Editions have a default user database, called `neo4j`, and a `system` database, which contains configurations, e.g., operational states of databases, security configuration, schema definitions, login credentials, and roles.
192-
In the Enterprise Edition, you can also create additional user databases.
203+
Both Neo4j Community and Enterprise Editions have a default user database named `neo4j` and a `system` database.
204+
The `system` database contains configurations, e.g., operational states of databases, security configuration, schema definitions, login credentials, and roles.
205+
206+
In the Enterprise Edition, you can also create multiple user databases.
193207
Each of these databases is backed up independently of one another.
194208

195-
[NOTE]
196-
====
197209
It is very important to store a recent backup of your databases, including the `system` database, in a safe location.
198-
====
210+
199211

200212
[[backup-planning-additional]]
201213
== Additional files to back up
@@ -215,4 +227,4 @@ If you have a cluster, you should back up these files for each cluster member.
215227

216228
For any backup, it is important that you store your data separately from the production system, where there are no common dependencies, and preferably off-site.
217229
If you are running Neo4j in the cloud, you may use a different availability zone or even a separate cloud provider.
218-
Since backups are kept for a long time, the longevity of archival storage should be considered as part of backup planning.
230+
Since backups are kept for a long time, the longevity of archival storage should be considered as part of backup planning.

modules/ROOT/pages/changes-deprecations-removals.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ Replaced by xref:procedures.adoc#procedure_dbms_unquarantineDatabase[`dbms.unqua
408408
| label:deprecated[Deprecated in 5.26] +
409409
label:removed[Removed in Cypher 25] +
410410
Replaced by the Cypher command `CREATE VECTOR INDEX`.
411-
For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/semantic-indexes/vector-indexes/#create-vector-index/[Cypher Manual → Create a vector index].
411+
For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/semantic-indexes/vector-indexes/#create-vector-index[Cypher Manual → Create a vector index].
412412
413413
414414
| xref:procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`]

modules/ROOT/pages/clustering/servers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Once dropped, a server cannot rejoin a cluster.
120120

121121
[NOTE]
122122
====
123-
The same physical hardware can rejoin the cluster, provided the Neo4j installation has been "reset" (either re-installing, or running `neo4j-admin unbind`), causing it to receive a new generated server ID on next startup.
123+
The same physical hardware can rejoin the cluster, provided the Neo4j installation has been "reset" (either re-installing, or running `neo4j-admin server unbind`), causing it to receive a new generated server ID on next startup.
124124
====
125125

126126
== Listing servers

modules/ROOT/pages/configuration/neo4j-conf.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The _neo4j.conf_ file is the main source of configuration settings in Neo4j and
66
The location of the _neo4j.conf_ file in the different configurations of Neo4j is listed in xref:configuration/file-locations.adoc[Default file locations].
77

88
Most of the configuration settings in the _neo4j.conf_ file apply directly to Neo4j itself, but there are also other settings related to the Java Runtime (the JVM) on which Neo4j runs.
9-
For more information, see the xref:configuration/neo4j-conf.adoc#neo4j-conf-JVM[JVM specific configuration settings].
9+
For more information, see the <<neo4j-conf-JVM, JVM specific configuration settings>>.
1010
Many of the configuration settings are also used by `neo4j` launcher scripts.
1111

1212

modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Replaced by `existingDataSeedServer`.
137137
| URI to a backup or a dump from an existing database.
138138
|
139139
Defines an identical seed from an external source which will be used to seed all servers.
140-
For more information, see xref::database-administration/standard-databases/seed-from-uri.adoc[Seed from a URI].
140+
For more information, see xref:database-administration/standard-databases/seed-from-uri.adoc[Create a database from a URI].
141141

142142
| `seedConfig`
143143
| Comma-separated list of configuration values.
@@ -198,14 +198,14 @@ Defines a seed from an external source, which will be used to seed all servers.
198198
| `seedConfig`
199199
| Comma-separated list of configuration values.
200200
|
201-
For more information see xref::clustering/databases.adoc#cluster-seed-uri[Seed from URI].
201+
For more information see xref:database-administration/standard-databases/seed-from-uri.adoc[Create a database from a URI].
202202

203-
| `txLogEnrichment`
203+
| `txLogEnrichment`§
204204
| `FULL` \| `DIFF` \| `OFF`
205205
|
206206
Defines the level of enrichment applied to transaction logs for Change Data Capture (CDC) purposes.
207207

208-
For details about enrichment mode, see link:{neo4j-docs-base-uri}/cdc/current/get-started/self-managed/#set-enrichment-mode/[Change Data Capture Manual -> Enable CDC on self-managed instances -> Set the enrichment mode].
208+
For details about enrichment mode, see link:{neo4j-docs-base-uri}/cdc/current/get-started/self-managed/#tweak-mode[Change Data Capture Manual -> Enable CDC on self-managed instances -> Toggle CDC mode].
209209

210210
| `storeFormat`
211211
| `aligned` \| `standard` \| `high_limit` \| `block`

modules/ROOT/pages/introduction.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ a| APOC 450+ link:https://neo4j.com/docs/apoc/5/[Core Procedures and Functions]
160160

161161
3+^s| Indexes and constraints
162162

163-
| link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/search-performance-indexes/overview/[Fast writes via native label indexes]
163+
| link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/[Fast writes via native label indexes]
164164
| {check-mark}
165165
| {check-mark}
166166

modules/ROOT/pages/kubernetes/operations/backup-restore.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,7 +1053,7 @@ To restore the `system` database, follow the steps described in xref:kubernetes/
10531053
To migrate from persistent volume-based backups to cloud-native backups, you need to follow these steps:
10541054

10551055
. Perform a final traditional backup to ensure you have the latest data.
1056-
For more information, see <<kubernetes-neo4j-backup-on-prem, Prepare to back up a database(s) to on-premises storage>> and <<kubernetes-neo4j-backup, Back up your databases>>.
1056+
For more information, see <<kubernetes-neo4j-backup-on-prem, Prepare to back up a database(s) to on-premises storage>> and <<#_back_up_your_databases, Back up your databases>>.
10571057
. Upload existing backups to the cloud storage bucket if needed.
10581058
You can use cloud provider CLI tools to transfer your backup files:
10591059
** For AWS S3: `aws s3 cp /path/to/backups s3://your-bucket/backups --recursive`
@@ -1062,5 +1062,5 @@ You can use cloud provider CLI tools to transfer your backup files:
10621062
. Update the _backup-values.yaml_ file to configure the cloud provider, bucket name, and credentials.
10631063
See <<kubernetes-neo4j-backup-cloud, Prepare to back up a database(s) to a cloud provider (AWS, GCP, and Azure) bucket>> for details.
10641064
. Install the _neo4j-admin_ Helm chart with the updated _backup-values.yaml_ file to back up your databases to the cloud provider bucket.
1065-
See <<_back_up_your_databases, Back up your databases>> for details.
1065+
See <<#_back_up_your_databases, Back up your databases>> for details.
10661066

0 commit comments

Comments
 (0)