Skip to content

Commit 2a3127a

Browse files
committed
rewriting the into
1 parent 421c86a commit 2a3127a

File tree

1 file changed

+11
-25
lines changed

1 file changed

+11
-25
lines changed

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

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22
[[restore-dump]]
33
= Restore a database dump
44

5-
A database dump can be loaded to a Neo4j instance using the `load` command of `neo4j-admin`.
5+
The `neo4j-admin database load` command can be used to load a database from an archive created with the xref:backup-restore/offline-backup.adoc#offline-backup-command[`neo4j-admin database dump`] command. +
6+
Starting from Neo4j 5.20, the `neo4j-admin database load` command also supports loading a full backup artifact created by the xref:backup-restore/online-backup.adoc[`neo4j-admin database backup`] command from Neo4j Enterprise.
67

7-
From Neo4j 5.20, the `neo4j-admin database load` command also supports loading a database from xref:backup-restore/online-backup.adoc#backup-artifact[full database backup artifacts].
8+
If you are replacing an existing database, you have to shut it down before running the command and use the `--overwrite-destination` option. +
9+
label:enterprise-edition[] If you are not replacing an existing database, you must create the database (using `CREATE DATABASE` against the `system` database) after the load operation finishes.
10+
11+
The command can be run from either an online or offline Neo4j DBMS, and it must be executed as the `neo4j` user to ensure the appropriate file permissions.
812

913
[NOTE]
1014
====
@@ -13,35 +17,17 @@ See link:{neo4j-docs-base-uri}/cdc/current/get-started/self-managed/#non-tx-log-
1317
====
1418

1519

16-
[[restore-dump-command]]
17-
== Command
18-
19-
The `neo4j-admin database load` command loads a database from an archive created with the xref:backup-restore/offline-backup.adoc#offline-backup-command[`neo4j-admin database dump`] command or from xref:backup-restore/online-backup.adoc#online-backup-command[full Neo4j Enterprise backup] (available from Neo4j 5.20).
20-
21-
Alternatively, `neo4j-admin database load` can accept a dump from standard input, enabling it to accept input from `neo4j-admin database dump` or another source.
22-
23-
The command can be run from an online or an offline Neo4j DBMS.
24-
25-
[role=label--enterprise-edition]
26-
[NOTE]
27-
====
28-
If you are replacing an existing database, you have to shut it down before running the command.
29-
If you are not replacing an existing database, you must create the database (using `CREATE DATABASE` against the `system` database) after the load operation finishes.
30-
====
31-
32-
`neo4j-admin database load` must be invoked as the `neo4j` user to ensure the appropriate file permissions.
33-
3420

3521
[[restore-dump-syntax]]
36-
=== Syntax
22+
== Syntax
3723

3824
[source,role=noheader]
3925
----
4026
neo4j-admin database load [-h] [--expand-commands] [--info] [--verbose] [--overwrite-destination[=true|false]]
4127
[--additional-config=<file>] [--from-path=<path> | --from-stdin] <database>
4228
----
4329

44-
=== Description
30+
== Description
4531

4632
Load a database from an archive.
4733
_<archive-path>_ must be a directory containing an archive(s).
@@ -51,7 +37,7 @@ Existing databases can be replaced by specifying `--overwrite-destination`.
5137
It is not possible to replace a database that is mounted in a running Neo4j server.
5238
If `--info` is specified, then the database is not loaded, but information (i.e. file count, byte count, and format of load file) about the archive is printed instead.
5339

54-
=== Parameters
40+
== Parameters
5541

5642
.`neo4j-admin database load` parameters
5743
[options="header", cols="5m,10a"]
@@ -62,7 +48,7 @@ If `--info` is specified, then the database is not loaded, but information (i.e.
6248
|Name of the database to load. Can contain * and ? for globbing. Note that * and ? have special meaning in some shells and might need to be escaped or used with quotes.
6349
|===
6450

65-
=== Options
51+
== Options
6652

6753
.`neo4j-admin database load` options
6854
[options="header", cols="5m,10a,2m"]
@@ -112,7 +98,7 @@ For more information, see <<load-dump-cloud-storage>>.
11298
====
11399

114100
[[restore-dump-example]]
115-
== Example
101+
== Examples
116102

117103
The following are examples of how to load a dump of a database (_database.dump_) created in the section xref:backup-restore/offline-backup.adoc#offline-backup-example[Back up an offline database], using the `neo4j-admin database load` command.
118104
When replacing an existing database, you have to shut it down before running the command.

0 commit comments

Comments
 (0)