Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions modules/ROOT/pages/backup-restore/aggregate.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Consult Neo4j support before use.
|false

|--temp-path=<path>
|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.
|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.
|

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

[NOTE]
====
The `--temp-path` option is available starting from Neo4j 5.24.
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.

If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--from-path` option.

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.
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.

Therefore, it is strongly recommended to provide a `--temp-path` option.
====


Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/backup-restore/copy-database.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Cannot be combined with `--ignore-relationships-with-types`.
|

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

Expand Down Expand Up @@ -175,7 +175,7 @@ Cannot be combined with `--skip-properties` or `--copy-only-relationship-propert
|

|--temp-path=<path>
|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.
|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.
|

|--to-format=<format>
Expand Down Expand Up @@ -323,7 +323,7 @@ bin/neo4j-admin database copy neo4j neo4j --compact-node-store --temp-path=<my-p
+
[TIP]
====
`--temp-path` can be used to specify a different directory to use as a temporary staging area.
`--temp-path`, introduced in Neo4j 5.24, can be used to specify a different directory to use as a temporary staging area.
If omitted, the current working directory will be used.

From Neo4j 5.20 onwards, you can use the `--copy-schema` option to automatically copy the schema.
Expand Down
11 changes: 9 additions & 2 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Note: this is an EXPERIMENTAL option. Consult Neo4j support before use.
|false

|--temp-path=<path>
|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.
|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.
|

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

[NOTE]
====
The `--temp-path` option is available starting from Neo4j 5.24.
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.

If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--path` option.

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.
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.

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.
====

[[backup-command-exit-codes]]
Expand Down
11 changes: 9 additions & 2 deletions modules/ROOT/pages/backup-restore/restore-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Usage of this option is only allowed if the `--from-path` parameter points to ex
|

|--temp-path=<path>
|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.
|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.
|

|--verbose
Expand All @@ -130,7 +130,14 @@ For more information, see <<restore-cloud-storage>>.

[NOTE]
====
The `--temp-path` option is available starting from Neo4j 5.24.
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.

If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--from-path` option.

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.
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.

Therefore, it is strongly recommended to provide a `--temp-path` option.
====

[[restore-backup-example]]
Expand Down