From 66e62a7341b67cac87a6938609adf3bde6c7299f Mon Sep 17 00:00:00 2001 From: Natalia Ivakina Date: Mon, 21 Oct 2024 15:22:50 +0200 Subject: [PATCH 1/3] Add info about the `--temp-path` option --- modules/ROOT/pages/backup-restore/aggregate.adoc | 9 +++++++-- modules/ROOT/pages/backup-restore/copy-database.adoc | 6 +++--- modules/ROOT/pages/backup-restore/online-backup.adoc | 11 +++++++++-- modules/ROOT/pages/backup-restore/restore-backup.adoc | 9 +++++++-- 4 files changed, 26 insertions(+), 9 deletions(-) diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc index 695bbea23..d42359b59 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,12 @@ 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 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..28df36d0b 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,12 @@ 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 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]] From 6818286ab5fa648ec3ef67681cc410443d03d92a Mon Sep 17 00:00:00 2001 From: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Tue, 22 Oct 2024 14:15:07 +0200 Subject: [PATCH 2/3] Add info about the `from-path` option --- modules/ROOT/pages/backup-restore/aggregate.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc index d42359b59..fc9303ff5 100644 --- a/modules/ROOT/pages/backup-restore/aggregate.adoc +++ b/modules/ROOT/pages/backup-restore/aggregate.adoc @@ -108,7 +108,9 @@ For more information, see <>. ==== 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 current working directory for Neo4j. +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. From ed0ad37c91fb505effdbdebf03e796084cdc282a Mon Sep 17 00:00:00 2001 From: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Tue, 22 Oct 2024 14:17:08 +0200 Subject: [PATCH 3/3] Add info about the `from-path` option --- modules/ROOT/pages/backup-restore/restore-backup.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/backup-restore/restore-backup.adoc b/modules/ROOT/pages/backup-restore/restore-backup.adoc index 28df36d0b..45317342f 100644 --- a/modules/ROOT/pages/backup-restore/restore-backup.adoc +++ b/modules/ROOT/pages/backup-restore/restore-backup.adoc @@ -133,7 +133,9 @@ For more information, see <>. ==== 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 current working directory for Neo4j. +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.