Skip to content

Commit 88891d2

Browse files
Add info about the --temp-path option (#1891)
1 parent a087d26 commit 88891d2

File tree

4 files changed

+30
-9
lines changed

4 files changed

+30
-9
lines changed

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Consult Neo4j support before use.
9090
|false
9191

9292
|--temp-path=<path>
93-
|Provide a path to a temporary empty directory for storing backup files until the command is completed. The files will be deleted once the command is finished.
93+
|label:new[Introduced in 5.24] Provide a path to a temporary empty directory for storing backup files until the command is completed. The files will be deleted once the command is finished.
9494
|
9595

9696
|--verbose
@@ -106,7 +106,14 @@ For more information, see <<aggregate-backup-cloud-storage>>.
106106

107107
[NOTE]
108108
====
109-
The `--temp-path` option is available starting from Neo4j 5.24.
109+
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
110+
111+
If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--from-path` option.
112+
113+
If you don't provide the `--from-path` option or if your provided path points to a cloud storage bucket, a temporary folder is created inside the current working directory for Neo4j.
114+
This fallback option can cause issues because the local filesystem (or the partition where Neo4j is installed) may not have enough free disk to accommodate the intermediate computation.
115+
116+
Therefore, it is strongly recommended to provide a `--temp-path` option.
110117
====
111118

112119

modules/ROOT/pages/backup-restore/copy-database.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Cannot be combined with `--ignore-relationships-with-types`.
111111
|
112112

113113
|--copy-schema
114-
|Copy the schema instead of generating schema statements, meaning index and constraint definitions.
114+
|label:new[Introduced in 5.20] Copy the schema instead of generating schema statements, meaning index and constraint definitions.
115115
The indexes will be built the first time the database is started.
116116
|
117117

@@ -175,7 +175,7 @@ Cannot be combined with `--skip-properties` or `--copy-only-relationship-propert
175175
|
176176

177177
|--temp-path=<path>
178-
|Path to a directory to be used as a staging area when the source and target databases are the same. Default is the current directory.
178+
|label:new[Introduced in 5.24] Path to a directory to be used as a staging area when the source and target databases are the same. Default is the current directory.
179179
|
180180

181181
|--to-format=<format>
@@ -323,7 +323,7 @@ bin/neo4j-admin database copy neo4j neo4j --compact-node-store --temp-path=<my-p
323323
+
324324
[TIP]
325325
====
326-
`--temp-path` can be used to specify a different directory to use as a temporary staging area.
326+
`--temp-path`, introduced in Neo4j 5.24, can be used to specify a different directory to use as a temporary staging area.
327327
If omitted, the current working directory will be used.
328328
329329
From Neo4j 5.20 onwards, you can use the `--copy-schema` option to automatically copy the schema.

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Note: this is an EXPERIMENTAL option. Consult Neo4j support before use.
170170
|false
171171

172172
|--temp-path=<path>
173-
|Provide a path to a temporary empty directory for storing backup files until the command is completed. The files will be deleted once the command is finished.
173+
|label:new[Introduced in 5.24] Provide a path to a temporary empty directory for storing backup files until the command is completed. The files will be deleted once the command is finished.
174174
|
175175

176176
|--to-path=<path>
@@ -196,7 +196,14 @@ For more information, see <<online-backup-cloud-storage>>.
196196

197197
[NOTE]
198198
====
199-
The `--temp-path` option is available starting from Neo4j 5.24.
199+
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
200+
201+
If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--path` option.
202+
203+
If you don't provide the `--path` option or if your provided path points to a cloud storage bucket, a temporary folder is created inside the current working directory for Neo4j.
204+
This fallback option can cause issues because the local filesystem (or the partition where Neo4j is installed) may not have enough free disk to accommodate the intermediate computation.
205+
206+
Therefore, it is strongly recommended to provide a `--temp-path` option when executing a backup-related command, especially if the folder provided in the `--path` option points to a cloud storage bucket.
200207
====
201208

202209
[[backup-command-exit-codes]]

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Usage of this option is only allowed if the `--from-path` parameter points to ex
115115
|
116116

117117
|--temp-path=<path>
118-
|Provide a path to a temporary empty directory for storing backup files until the command is completed. The files will be deleted once the command is finished.
118+
|label:new[Introduced in 5.24] Provide a path to a temporary empty directory for storing backup files until the command is completed. The files will be deleted once the command is finished.
119119
|
120120

121121
|--verbose
@@ -131,7 +131,14 @@ For more information, see <<restore-cloud-storage>>.
131131

132132
[NOTE]
133133
====
134-
The `--temp-path` option is available starting from Neo4j 5.24.
134+
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
135+
136+
If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--from-path` option.
137+
138+
If you don't provide the `--from-path` option or if your provided path points to a cloud storage bucket, a temporary folder is created inside the current working directory for Neo4j.
139+
This fallback option can cause issues because the local filesystem (or the partition where Neo4j is installed) may not have enough free disk to accommodate the intermediate computation.
140+
141+
Therefore, it is strongly recommended to provide a `--temp-path` option.
135142
====
136143

137144
[[restore-backup-example]]

0 commit comments

Comments
 (0)