diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc index 695bbea23..fc9303ff5 100644 --- a/modules/ROOT/pages/backup-restore/aggregate.adoc +++ b/modules/ROOT/pages/backup-restore/aggregate.adoc @@ -90,7 +90,7 @@ Consult Neo4j support before use. |false |--temp-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 @@ -106,7 +106,14 @@ For more information, see <>. [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. ==== diff --git a/modules/ROOT/pages/backup-restore/copy-database.adoc b/modules/ROOT/pages/backup-restore/copy-database.adoc index 96405e837..04c25383a 100644 --- a/modules/ROOT/pages/backup-restore/copy-database.adoc +++ b/modules/ROOT/pages/backup-restore/copy-database.adoc @@ -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. | @@ -175,7 +175,7 @@ Cannot be combined with `--skip-properties` or `--copy-only-relationship-propert | |--temp-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= @@ -323,7 +323,7 @@ bin/neo4j-admin database copy neo4j neo4j --compact-node-store --temp-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= @@ -196,7 +196,14 @@ For more information, see <>. [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]] diff --git a/modules/ROOT/pages/backup-restore/restore-backup.adoc b/modules/ROOT/pages/backup-restore/restore-backup.adoc index b96599484..45317342f 100644 --- a/modules/ROOT/pages/backup-restore/restore-backup.adoc +++ b/modules/ROOT/pages/backup-restore/restore-backup.adoc @@ -115,7 +115,7 @@ Usage of this option is only allowed if the `--from-path` parameter points to ex | |--temp-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 @@ -131,7 +131,14 @@ For more information, see <>. [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]]