You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/authentication-authorization/built-in-roles.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -827,7 +827,7 @@ These include the rights to perform the following classes of tasks:
827
827
828
828
* Manage xref:authentication-authorization/database-administration.adoc[database privileges] to control the rights to perform actions on specific databases:
829
829
** 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].
831
831
** Allow the creation of labels, relationship types, or property names.
832
832
** Manage transactions.
833
833
* Manage xref:authentication-authorization/dbms-administration.adoc[DBMS privileges] to control the rights to perform actions on the entire system:
* Manage <<access-control-dbms-administration-load-privileges, load data security>>.
100
+
* Manage xref:authentication-authorization/load-privileges.adoc[load data security].
101
101
102
102
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.
103
103
All privileges are also assignable using Cypher commands.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/authentication-authorization/limitations.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,10 +26,10 @@ Further to that, Neo4j's role-based access control has some limitations and impl
26
26
== Security and indexes
27
27
28
28
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.
30
30
31
31
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.
33
33
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],
34
34
the index will also return the same fewer results.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/backup-restore/planning.adoc
+46-34Lines changed: 46 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ If you have zero tolerance for downtime and data loss, you might want to conside
38
38
** use SSL/TLS for the backup network communication (online only).
39
39
** keep your databases as archive files (online or offline).
40
40
* 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.
42
42
+
43
43
[TIP]
44
44
====
@@ -51,15 +51,14 @@ This ensures that if for some reason your Neo4j DBMS crashes, you will be able t
51
51
== Backup and restore options
52
52
53
53
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.
55
55
All `neo4j-admin` commands must be invoked as the `neo4j` user to ensure the appropriate file permissions.
56
56
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`.
63
62
+
64
63
[NOTE]
65
64
====
@@ -73,9 +72,9 @@ For more information, refer to the xref:backup-restore/online-backup.adoc#backup
73
72
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.
74
73
====
75
74
* `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_.
79
78
* `neo4j-admin database copy` –- used for copying an offline database or backup.
80
79
This command can be used for cleaning up database inconsistencies and reclaiming unused space.
81
80
@@ -84,23 +83,9 @@ This command can be used for cleaning up database inconsistencies and reclaiming
84
83
File system copy-and-paste of databases is not supported and may result in unwanted behavior, such as corrupt stores.
85
84
====
86
85
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.
96
87
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
104
89
[cols="<,^,^,^",frame="topbot",options="header"]
105
90
|===
106
91
| Capability/ Usage
@@ -184,18 +169,45 @@ They must be run directly on the databases that are associated with that Composi
184
169
| {check-mark}
185
170
|===
186
171
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
+
187
199
[[backup-planning-databases]]
188
-
== Databases to backup
200
+
== Databases to back up
189
201
190
202
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.
193
207
Each of these databases is backed up independently of one another.
194
208
195
-
[NOTE]
196
-
====
197
209
It is very important to store a recent backup of your databases, including the `system` database, in a safe location.
198
-
====
210
+
199
211
200
212
[[backup-planning-additional]]
201
213
== Additional files to back up
@@ -215,4 +227,4 @@ If you have a cluster, you should back up these files for each cluster member.
215
227
216
228
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.
217
229
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.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/changes-deprecations-removals.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -408,7 +408,7 @@ Replaced by xref:procedures.adoc#procedure_dbms_unquarantineDatabase[`dbms.unqua
408
408
| label:deprecated[Deprecated in 5.26] +
409
409
label:removed[Removed in Cypher 25] +
410
410
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].
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/servers.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -120,7 +120,7 @@ Once dropped, a server cannot rejoin a cluster.
120
120
121
121
[NOTE]
122
122
====
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.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/configuration/neo4j-conf.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ The _neo4j.conf_ file is the main source of configuration settings in Neo4j and
6
6
The location of the _neo4j.conf_ file in the different configurations of Neo4j is listed in xref:configuration/file-locations.adoc[Default file locations].
7
7
8
8
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>>.
10
10
Many of the configuration settings are also used by `neo4j` launcher scripts.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -137,7 +137,7 @@ Replaced by `existingDataSeedServer`.
137
137
| URI to a backup or a dump from an existing database.
138
138
|
139
139
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].
141
141
142
142
| `seedConfig`
143
143
| 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.
198
198
| `seedConfig`
199
199
| Comma-separated list of configuration values.
200
200
|
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].
202
202
203
-
| `txLogEnrichment`
203
+
| `txLogEnrichment`§
204
204
| `FULL` \| `DIFF` \| `OFF`
205
205
|
206
206
Defines the level of enrichment applied to transaction logs for Change Data Capture (CDC) purposes.
207
207
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].
Copy file name to clipboardExpand all lines: modules/ROOT/pages/kubernetes/operations/backup-restore.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1053,7 +1053,7 @@ To restore the `system` database, follow the steps described in xref:kubernetes/
1053
1053
To migrate from persistent volume-based backups to cloud-native backups, you need to follow these steps:
1054
1054
1055
1055
. 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>>.
1057
1057
. Upload existing backups to the cloud storage bucket if needed.
1058
1058
You can use cloud provider CLI tools to transfer your backup files:
1059
1059
** 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:
1062
1062
. Update the _backup-values.yaml_ file to configure the cloud provider, bucket name, and credentials.
1063
1063
See <<kubernetes-neo4j-backup-cloud, Prepare to back up a database(s) to a cloud provider (AWS, GCP, and Azure) bucket>> for details.
1064
1064
. 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.
0 commit comments