Skip to content

Commit c520c93

Browse files
Add docs related to public --temp-path option in backup related commands (#1768)
This PR is related to adding a new `--temp-path` option that was merged in https://github.com/neo-technology/neo4j/pull/26359 --------- Co-authored-by: NataliaIvakina <[email protected]>
1 parent c9cc829 commit c520c93

File tree

3 files changed

+20
-9
lines changed

3 files changed

+20
-9
lines changed

modules/ROOT/pages/backup-restore/aggregate.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ This operation is called _recovery_ and can be costly.
2727
neo4j-admin database aggregate-backup [-h] [--expand-commands]
2828
[--verbose] [--keep-old-backup[=true|false]]
2929
[--parallel-recovery[=true|false]]
30-
[--additional-config=<file>]
31-
--from-path=<path> [<database>]
30+
[--additional-config=<file>] --from-path=<path>
31+
[--temp-path=<path>] [<database>]
3232
----
3333

3434
=== Description
@@ -89,6 +89,10 @@ Note: this is an EXPERIMENTAL option.
8989
Consult Neo4j support before use.
9090
|false
9191

92+
|--temp-path=<path>
93+
|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.
94+
|
95+
9296
|--verbose
9397
|Enable verbose output.
9498
|

modules/ROOT/pages/backup-restore/online-backup.adoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,9 @@ neo4j-admin database backup [-h] [--expand-commands] [--verbose]
7676
[--parallel-recovery[=true|false]]
7777
[--additional-config=<file>]
7878
[--include-metadata=none|all|users|roles]
79-
[--inspect-path=<path>] [--pagecache=<size>]
80-
[--to-path=<path>] [--type=<type>]
81-
[--from=<host:port>[,<host:port>...]]...
82-
[<database>...]
79+
[--inspect-path=<path>] [--pagecache=<size>] [--temp-path=<path>]
80+
[--to-path=<path>] [--type=<type>] [--from=<host:port>[,<host:
81+
port>...]]... [<database>...]
8382
----
8483

8584
=== Description
@@ -171,6 +170,10 @@ It is recommended to use `SHOW USERS`, `SHOW ROLES`, and `SHOW ROLE $role PRIVIL
171170
Note: this is an EXPERIMENTAL option. Consult Neo4j support before use.
172171
|false
173172

173+
|--temp-path=<path>
174+
|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.
175+
|
176+
174177
|--to-path=<path>
175178
|Directory to place backup in (required unless `--inspect-path` is used).
176179
|
@@ -414,4 +417,4 @@ include::partial$/gcs-credentials.adoc[]
414417
bin/neo4j-admin database backup --to-path=gs://myBucket/myDirectory/ mydatabase
415418
----
416419
======
417-
=====
420+
=====

modules/ROOT/pages/backup-restore/restore-backup.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ neo4j-admin database restore [-h] [--expand-commands]
4040
[--verbose] [--overwrite-destination[=true|false]]
4141
[--additional-config=<file>]
4242
--from-path=<path>[,<path>...]
43-
[--restore-until=<recovery-criteria>]
43+
[--restore-until=<recovery-criteria>] [--temp-path=<path>]
4444
[--to-path-data=<path>] [--to-path-txn=<path>]
45-
[<database>]
45+
[<database>]
4646
----
4747

4848
=== Parameters
@@ -113,6 +113,10 @@ Usage of this option is only allowed if the `--from-path` parameter points to ex
113113
Usage of this option is only allowed if the `--from-path` parameter points to exactly one directory.
114114
|
115115

116+
|--temp-path=<path>
117+
|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.
118+
|
119+
116120
|--verbose
117121
|Enable verbose output.
118122
|

0 commit comments

Comments
 (0)