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
`<to-path>` should be a directory (in which case a file called _<database>.dump_ will be created), or `--to-stdout` can be supplied to use standard output.
47
+
If neither `--to-path` or `--to-stdout` is supplied `server.directories.dumps.root` setting will be used as a destination.
48
+
It is not possible to dump a database that is mounted in a running Neo4j server.
49
+
50
+
=== Parameters
51
+
52
+
.`neo4j-admin database dump` parameters
53
+
[options="header", cols="1m,3a"]
54
+
|===
55
+
| Parameter
56
+
| Description
57
+
58
+
|<database>
59
+
|Name of the database to dump. Can contain `\*` and `?` for globbing.
60
+
Note that `*` and `?` have special meaning in some shells and might need to be escaped or used with quotes.
61
+
|===
44
62
45
63
[[offline-backup-command-options]]
46
64
=== Options
47
65
48
-
[options="header",cols="m,m,a"]
66
+
The `neo4j-admin database dump` command has the following options:
67
+
68
+
.`neo4j-admin database dump` options
69
+
[options="header", cols="5m,6a,4m"]
49
70
|===
50
71
| Option
51
-
| Default
52
72
| Description
73
+
| Default
74
+
75
+
|--additional-config=<file>
76
+
|Configuration file with additional configuration.
77
+
|
53
78
54
-
| --verbose
79
+
|--expand-commands
80
+
|Allow command expansion in config value evaluation.
55
81
|
56
-
| Enable verbose output.
57
82
58
-
| --expand-commands
83
+
| -h, --help
84
+
|Show this help message and exit.
59
85
|
60
-
| Allow command expansion in config value evaluation.
61
86
62
-
| --overwrite-destination
63
-
| false
64
-
| Overwrite any existing dump file in the destination folder.
87
+
| --overwrite-destination[=true\|false]
88
+
|Overwrite any existing dump file in the destination folder.
89
+
|false
65
90
66
-
| --to-path
91
+
|--to-path=<path>
92
+
|Destination folder of a database dump.
67
93
|
68
-
| Destination for the database dump.
69
-
It must point to an existing directory.
70
94
71
-
| --to-stdout
95
+
|--to-stdout
96
+
|Use standard output as the destination for the database dump.
97
+
|
98
+
99
+
|--verbose
100
+
|Enable verbose output.
72
101
|
73
-
| Use standard output as the destination for the database dump.
74
102
|===
75
103
76
104
@@ -80,11 +108,13 @@ It must point to an existing directory.
80
108
The following is an example of how to create a dump of the default database `neo4j` using the `neo4j-admin database dump` command.
81
109
The target directory _/dumps/neo4j_ must exist before running the command and the database must be offline.
0 commit comments