From 9d6c127393920c145ebcf04fcba2604d0c7246c5 Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Fri, 28 Jul 2023 16:21:21 +0200 Subject: [PATCH 1/3] Add info on skipping consistency check in 4.x --- modules/ROOT/pages/backup-restore/planning.adoc | 9 +++++++++ .../pages/tools/neo4j-admin/consistency-checker.adoc | 4 ++++ 2 files changed, 13 insertions(+) diff --git a/modules/ROOT/pages/backup-restore/planning.adoc b/modules/ROOT/pages/backup-restore/planning.adoc index d62bac939..5c8a25441 100644 --- a/modules/ROOT/pages/backup-restore/planning.adoc +++ b/modules/ROOT/pages/backup-restore/planning.adoc @@ -249,3 +249,12 @@ If you have a cluster, you should back up these files for each cluster member. For any backup, it is important that you store your data separately from the production system, where there are no common dependencies, and preferably off-site. If you are running Neo4j in the cloud, you may use a different availability zone or even a separate cloud provider. Since backups are kept for a long time, the longevity of archival storage should be considered as part of backup planning. + +[[performance-improvement]] +== Performance improvement + +Backups in Neo4j automatically run a consistency check against the backed-up store. +The backup itself does not take overly long, but the xref:tools/neo4j-admin/consistency-checker.adoc[consistency check] can take much more time to complete, depending on the store. + +In case you want to skip the check, with the option to run it manually at some other time, refer to the xref:backup-restore/online-backup.adoc#online-backup-resources[ +Back up an online database] page. diff --git a/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc b/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc index 7b7c0bde5..62f2d035a 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc +++ b/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc @@ -9,6 +9,10 @@ The consistency of a database or a backup can be checked using the `check-consis The `neo4j-admin` tool is located in the `bin` directory. If checking the consistency of a database, note that it has to be stopped first or else the consistency check will result in an error. +This check is performed automatically. +In case you want to skip the check, with the option to run it manually at some other time, refer to the xref:backup-restore/online-backup.adoc#online-backup-resources[ +Back up an online database] page. + [NOTE] It is not recommended to use an NFS to check the consistency of a database or a backup as this slows the process down significantly. From 64b443503c56a7bd7ccf1210ccc76cddb723cd8f Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Fri, 28 Jul 2023 16:23:16 +0200 Subject: [PATCH 2/3] fix ui bundle link --- preview.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/preview.yml b/preview.yml index 7bf0c64ed..74a6d63bc 100644 --- a/preview.yml +++ b/preview.yml @@ -14,7 +14,7 @@ content: ui: bundle: - url: https://s3-eu-west-1.amazonaws.com/static-content.neo4j.com/build/ui-bundle-latest.zip + url: https://d12wh7zj8x3amw.cloudfront.net/build/ui-bundle-latest.zip snapshot: true output_dir: /assets From d264f172a50e2c17105fc9b09556da58c1cc0db6 Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Mon, 31 Jul 2023 12:45:31 +0200 Subject: [PATCH 3/3] Changes after review --- modules/ROOT/pages/backup-restore/online-backup.adoc | 1 + modules/ROOT/pages/backup-restore/planning.adoc | 11 +---------- .../pages/tools/neo4j-admin/consistency-checker.adoc | 4 ---- 3 files changed, 2 insertions(+), 14 deletions(-) diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc index ad7c76664..ee653a9d7 100644 --- a/modules/ROOT/pages/backup-restore/online-backup.adoc +++ b/modules/ROOT/pages/backup-restore/online-backup.adoc @@ -279,6 +279,7 @@ Therefore, it is highly recommended to perform the backup and consistency check + Alternatively, you can decouple the backup operation from the consistency check (using the `neo4j-admin backup` option `--check-consistency=false`) and schedule that part of the workflow to happen at a later point in time, on a dedicated machine. Consistency checking a backup is vital for safeguarding and ensuring the quality of the data, and should not be underestimated. +For more information, see xref:tools/neo4j-admin/consistency-checker.adoc[Consistency checker]. + [TIP] ==== diff --git a/modules/ROOT/pages/backup-restore/planning.adoc b/modules/ROOT/pages/backup-restore/planning.adoc index 5c8a25441..4b565a068 100644 --- a/modules/ROOT/pages/backup-restore/planning.adoc +++ b/modules/ROOT/pages/backup-restore/planning.adoc @@ -248,13 +248,4 @@ If you have a cluster, you should back up these files for each cluster member. For any backup, it is important that you store your data separately from the production system, where there are no common dependencies, and preferably off-site. If you are running Neo4j in the cloud, you may use a different availability zone or even a separate cloud provider. -Since backups are kept for a long time, the longevity of archival storage should be considered as part of backup planning. - -[[performance-improvement]] -== Performance improvement - -Backups in Neo4j automatically run a consistency check against the backed-up store. -The backup itself does not take overly long, but the xref:tools/neo4j-admin/consistency-checker.adoc[consistency check] can take much more time to complete, depending on the store. - -In case you want to skip the check, with the option to run it manually at some other time, refer to the xref:backup-restore/online-backup.adoc#online-backup-resources[ -Back up an online database] page. +Since backups are kept for a long time, the longevity of archival storage should be considered as part of backup planning. \ No newline at end of file diff --git a/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc b/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc index 62f2d035a..7b7c0bde5 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc +++ b/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc @@ -9,10 +9,6 @@ The consistency of a database or a backup can be checked using the `check-consis The `neo4j-admin` tool is located in the `bin` directory. If checking the consistency of a database, note that it has to be stopped first or else the consistency check will result in an error. -This check is performed automatically. -In case you want to skip the check, with the option to run it manually at some other time, refer to the xref:backup-restore/online-backup.adoc#online-backup-resources[ -Back up an online database] page. - [NOTE] It is not recommended to use an NFS to check the consistency of a database or a backup as this slows the process down significantly.