Skip to content

Commit

Permalink
update the backup and restore commands (#1354)
Browse files Browse the repository at this point in the history
  • Loading branch information
renetapopova authored Jan 23, 2024
1 parent 4c72505 commit 43eb2b4
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 12 deletions.
7 changes: 5 additions & 2 deletions modules/ROOT/pages/backup-restore/aggregate.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ neo4j-admin database aggregate-backup [-h] [--expand-commands]
--from-path=<path> [<database>]
----

=== Description

Aggregates a chain of backup artifacts into a single artifact.

[[aggregate-backup-command-parameters]]
=== Parameters
Expand All @@ -57,15 +60,15 @@ neo4j-admin database aggregate-backup [-h] [--expand-commands]
| Default

|--additional-config=<file>
|Configuration file with additional configuration or override the existing configuration settings in the _neo4j.conf_ file.
|Configuration file with additional configuration.
|

| --expand-commands
| Allow command expansion in config value evaluation.
|

|--from-path=<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 _<database>_ parameter should be omitted.
The option to supply a file is only available in Neo4j 5.2 and later.
Expand Down
22 changes: 14 additions & 8 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,14 @@ neo4j-admin database backup [-h] [--expand-commands] [--verbose]
[--inspect-path=<path>] [--pagecache=<size>]
[--to-path=<path>] [--type=<type>]
[--from=<host:port>[,<host:port>...]]...
[<database>]
[<database>...]
----

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

Expand All @@ -87,8 +92,8 @@ neo4j-admin database backup [-h] [--expand-commands] [--verbose]
| Description
| Default

|<database>
|Name of the remote database to backup. Supports globbing inside of double quotes, for example, "data*". (<database> is required unless `--inspect-path` is used).
|[<database...>]
|Name(s) of the remote database(s) to backup. Supports globbing inside of double quotes, for example, "data*". (<database> is required unless `--inspect-path` is used).
|neo4j
|===

Expand All @@ -108,11 +113,12 @@ If <database> is "*", `neo4j-admin` will attempt to back up all databases of the
| Default

|--additional-config=<file>
|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
Expand Down Expand Up @@ -160,10 +166,10 @@ Note: this is an EXPERIMENTAL option. Consult Neo4j support before use.
|

|--type=<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.
Expand Down
5 changes: 3 additions & 2 deletions modules/ROOT/pages/backup-restore/restore-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ neo4j-admin database restore [-h] [--expand-commands]
| Default

|--additional-config=<file>
|Configuration file with additional configuration or override the existing configuration settings in the _neo4j.conf_ file.
|Configuration file with additional configuration.
|

|--expand-commands
Expand All @@ -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

Expand Down

0 comments on commit 43eb2b4

Please sign in to comment.