diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc index 6d2f01223..6ac8af696 100644 --- a/modules/ROOT/pages/backup-restore/aggregate.adoc +++ b/modules/ROOT/pages/backup-restore/aggregate.adoc @@ -31,6 +31,9 @@ neo4j-admin database aggregate-backup [-h] [--expand-commands] --from-path= [] ---- +=== Description + +Aggregates a chain of backup artifacts into a single artifact. [[aggregate-backup-command-parameters]] === Parameters @@ -57,7 +60,7 @@ neo4j-admin database aggregate-backup [-h] [--expand-commands] | Default |--additional-config= -|Configuration file with additional configuration or override the existing configuration settings in the _neo4j.conf_ file. +|Configuration file with additional configuration. | | --expand-commands @@ -65,7 +68,7 @@ neo4j-admin database aggregate-backup [-h] [--expand-commands] | |--from-path= -|Accepts either a path to a single artifact file or a folder containing backup artifacts. +|Accepts either a path to a single artifact file or, a folder containing backup artifacts. When a file is supplied, the __ parameter should be omitted. The option to supply a file is only available in Neo4j 5.2 and later. diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc index ea28ee45d..125ee56ff 100644 --- a/modules/ROOT/pages/backup-restore/online-backup.adoc +++ b/modules/ROOT/pages/backup-restore/online-backup.adoc @@ -74,9 +74,14 @@ neo4j-admin database backup [-h] [--expand-commands] [--verbose] [--inspect-path=] [--pagecache=] [--to-path=] [--type=] [--from=[,...]]... - [] + [...] ---- +=== Description + +Perform an online backup from a running Neo4j enterprise server. +Neo4j's backup service must have been configured on the server beforehand. + [[backup-backup-command-parameters]] === Parameters @@ -87,8 +92,8 @@ neo4j-admin database backup [-h] [--expand-commands] [--verbose] | Description | Default -| -|Name of the remote database to backup. Supports globbing inside of double quotes, for example, "data*". ( is required unless `--inspect-path` is used). +|[] +|Name(s) of the remote database(s) to backup. Supports globbing inside of double quotes, for example, "data*". ( is required unless `--inspect-path` is used). |neo4j |=== @@ -108,11 +113,12 @@ If is "*", `neo4j-admin` will attempt to back up all databases of the | Default |--additional-config= -|Configuration file with additional configuration or override the existing configuration settings in the _neo4j.conf_ file. +|Configuration file with additional configuration. | |--compress[=true\|false] -|Request backup artifact to be compressed. If disabled, backup artifact creation is faster but the size of the produced artifact will be approximately equal to the size of backed-up database. +|Request backup artifact to be compressed. If disabled, backup artifact creation is faster but +the size of the produced artifact will be approximately equal to the size of backed-up database. |true | --expand-commands @@ -160,10 +166,10 @@ Note: this is an EXPERIMENTAL option. Consult Neo4j support before use. | |--type= -|Type of backup to perform. Possible values are: `full`, `diff`, and `auto`. +|Type of backup to perform. Possible values are: `FULL`, `DIFF`, `AUTO`. If none is specified, the type is automatically determined based on the existing backups. -If you want to force a full backup, use `full`. -|auto +If you want to force a full backup, use `FULL`. +|AUTO |--verbose |Enable verbose output. diff --git a/modules/ROOT/pages/backup-restore/restore-backup.adoc b/modules/ROOT/pages/backup-restore/restore-backup.adoc index 2c65c3d4f..689e6f367 100644 --- a/modules/ROOT/pages/backup-restore/restore-backup.adoc +++ b/modules/ROOT/pages/backup-restore/restore-backup.adoc @@ -61,7 +61,7 @@ neo4j-admin database restore [-h] [--expand-commands] | Default |--additional-config= -|Configuration file with additional configuration or override the existing configuration settings in the _neo4j.conf_ file. +|Configuration file with additional configuration. | |--expand-commands @@ -79,7 +79,8 @@ An artifact file can be 1) a full backup, in which case it is restored directly |--overwrite-destination[=true\|false] |If an existing database should be replaced. -This option is not safe on a cluster since clusters have additional state that would be inconsistent with restored database. +[NOTE] +This option is not safe on a cluster since clusters have an additional state that would be inconsistent with the restored database. In a cluster, restore to a new database to avoid this problem. |false