Skip to content

Commit 9ad1096

Browse files
Update the options' descriptions of the neo4j-admin commands according to the code (#1852)
see neo-technology/neo4j#27466, neo-technology/neo4j#27502, and neo-technology/neo4j#27550
1 parent 0df2dc1 commit 9ad1096

File tree

6 files changed

+14
-3
lines changed

6 files changed

+14
-3
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Aggregates a chain of backup artifacts into a single artifact.
7171
|Accepts either a path to a single artifact file or a folder containing backup artifacts.
7272

7373
When a file is supplied, the _<database>_ parameter should be omitted.
74-
The option to supply a file is only available from Neo4j 5.2 onwards.
74+
It is possible to aggregate backup artifacts from AWS S3 buckets, Google Cloud storage buckets, and Azure buckets using the appropriate URI as the path.
7575
|
7676

7777
|-h, --help

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ The `neo4j-admin database dump` command has the following options:
8282

8383
|--to-path=<path>
8484
|Destination folder of a database dump.
85+
It is possible to dump databases into AWS S3 buckets, Google Cloud storage buckets, and Azure buckets using the appropriate URI as the path.
8586
|
8687

8788
|--to-stdout

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Note: this is an EXPERIMENTAL option. Consult Neo4j support before use.
174174
|
175175

176176
|--to-path=<path>
177-
|Directory to place backup in (required unless `--inspect-path` is used).
177+
|Directory to place backup in (required unless `--inspect-path` is used). It is possible to back up databases into AWS S3 buckets, Google Cloud storage buckets, and Azure using the appropriate URI as the path.
178178
|
179179

180180
|--type=<type>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ neo4j-admin database restore [-h] [--expand-commands]
7979
|--from-path=<path>[,<path>...]
8080
|A single path or a comma-separated list of paths pointing to a backup artifact file.
8181
An artifact file can be 1) a full backup, in which case it is restored directly or, 2) a differential backup, in which case the command tries first to find in the folder a backup chain ending at that specific differential backup and then restores that chain.
82+
It is possible to restore backups from AWS S3 buckets, Google Cloud storage buckets, and Azure buckets using the appropriate URI as the path.
8283
|
8384

8485
|-h, --help

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ If `--info` is specified, then the database is not loaded, but information (i.e.
7777

7878
|--from-path=<path>
7979
|Path to directory containing archive(s).
80+
It is possible to load databases from AWS S3 buckets, Google Cloud storage buckets, and Azure bucket using the appropriate URI as the path.
8081
|
8182

8283
|--from-stdin

modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,8 @@ Therefore, use it with care, especially with large imports.
240240
* Multiple data sources like these can be specified in one import, where each data source has its own header.
241241
* Files can also be specified using regular expressions.
242242

243+
It is possible to import files from AWS S3 buckets, Google Cloud storage buckets, and Azure buckets using the appropriate URI as the path.
244+
243245
For an example, see <<import-tool-multiple-input-files-regex-example>>.
244246
|
245247

@@ -274,6 +276,8 @@ The value can be a plain number or a byte units string, e.g. `128k`, `1m`.
274276
* Multiple data sources like these can be specified in one import, where each data source has its own header.
275277
* Files can also be specified using regular expressions.
276278

279+
It is possible to import files from AWS S3 buckets, Google Cloud storage buckets, and Azure buckets using the appropriate URI as the path.
280+
277281
For an example, see <<import-tool-multiple-input-files-regex-example>>.
278282
|
279283

@@ -292,7 +296,7 @@ This is done by using the `--verbose` option.
292296
|import.report
293297

294298
|--schema=<path> label:new[Introduced in 5.24] label:enterprise[Enterprise edition]
295-
|File in which to store the Cypher schema commands to run as part of the data import.
299+
|Path to the file containing the Cypher commands for creating indexes and constraints during data import.
296300
|
297301

298302
|--skip-bad-entries-logging[=true\|false]
@@ -751,6 +755,8 @@ Therefore, use it with care, especially with large imports.
751755
* Multiple data sources like these can be specified in one import, where each data source has its own header.
752756
* Files can also be specified using regular expressions.
753757

758+
It is possible to import files from AWS S3 buckets, Google Cloud storage buckets, and Azure buckets using the appropriate URI as the path.
759+
754760
For an example, see <<import-tool-multiple-input-files-regex-example>>.
755761
|
756762

@@ -781,6 +787,8 @@ The value can be a plain number or a byte units string, e.g. `128k`, `1m`.
781787
* Multiple data sources like these can be specified in one import, where each data source has its own header.
782788
* Files can also be specified using regular expressions.
783789

790+
It is possible to import files from AWS S3 buckets, Google Cloud storage buckets, and Azure buckets using the appropriate URI as the path.
791+
784792
For an example, see <<import-tool-multiple-input-files-regex-example>>.
785793
|
786794

0 commit comments

Comments
 (0)