Skip to content

Commit bcd8121

Browse files
authored
Fix mismatches in the backup and restore section (#1535)
Depends on neo-technology/neo4j#24995, neo-technology/neo4j#24993, and neo-technology/neo4j#24992.
1 parent 6a373d2 commit bcd8121

File tree

3 files changed

+23
-24
lines changed

3 files changed

+23
-24
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Aggregates a chain of backup artifacts into a single artifact.
4444
| Parameter
4545
| Description
4646

47-
|<database>
47+
|[<database>]
4848
|Name of the database for which to aggregate the artifacts. Can contain `*` and `?` for globbing.
4949
|===
5050

@@ -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 in Neo4j 5.2 and later.
74+
The option to supply a file is only available from Neo4j 5.2 onwards.
7575
|
7676

7777
|-h, --help
@@ -97,8 +97,8 @@ Consult Neo4j support before use.
9797
[NOTE]
9898
====
9999
As of Neo4j 5.19, the `--from-path=<path>` option can also load backup artifacts from AWS S3 URIs.
100-
Neo4j uses link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html[default AWS credentials] to access AWS S3 URIs.
101-
====
100+
Neo4j uses link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html[default AWS credentials] to access AWS S3 URIs.
101+
====
102102

103103

104104
[[aggregate-backup-example]]

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -90,23 +90,23 @@ The `neo4j-admin database copy` command has the following options:
9090
|false
9191

9292
|--copy-only-node-properties=<label.property>[,<label.property>...]
93-
|A comma separated list of property keys to include in the copy for nodes with the specified label.
93+
|A comma-separated list of property keys to include in the copy for nodes with the specified label.
9494
Any labels not explicitly mentioned will have all their properties included in the copy.
9595
Cannot be combined with `--skip-properties` or `--skip-node-properties`.
9696
|
9797

9898
|--copy-only-nodes-with-labels=<label>[,<label>...]
99-
|A comma separated list of labels. All nodes that have ANY of the specified labels will be included in the copy.
99+
|A comma-separated list of labels. All nodes that have ANY of the specified labels will be included in the copy.
100100
Cannot be combined with `--ignore-nodes-with-labels`.
101101
|
102102

103103
|--copy-only-relationship-properties=<relationship.property>[,<relationship.property>...]
104-
|A comma separated list of property keys to include in the copy for relationships with the specified type.
105-
Any relationship types not explicitly mentioned will have all their properties included in the copy. Can not be combined with `--skip-properties` or `--skip-relationship-properties`.
104+
|A comma-separated list of property keys to include in the copy for relationships with the specified type.
105+
Any relationship types not explicitly mentioned will have all their properties included in the copy.Cannot be combined with `--skip-properties` or `--skip-relationship-properties`.
106106
|
107107

108108
|--copy-only-relationships-with-types=<type>[,<type>...]
109-
|A comma separated list of relationship types.
109+
|A comma-separated list of relationship types.
110110
All relationships with any of the specified types will be included in the copy.
111111
Cannot be combined with `--ignore-relationships-with-types`.
112112
|
@@ -116,7 +116,7 @@ Cannot be combined with `--ignore-relationships-with-types`.
116116
|
117117

118118
|--force
119-
|Force the command to run even if the integrity of the database can not be verified.
119+
|--temp-path=<path>he integrity of the database cannot be verified.
120120
|
121121

122122
|--from-pagecache=<size>
@@ -140,39 +140,39 @@ It can be used to target databases outside of the installation.
140140
|
141141

142142
|--ignore-nodes-with-labels=<label>[,<label>...]
143-
|A comma separated list of labels.
143+
|A comma-separated list of labels.
144144
Nodes that have ANY of the specified labels will not be included in the copy.
145145
Cannot be combined with `--copy-only-nodes-with-labels`.
146146
|
147147

148148
|--ignore-relationships-with-types=<type>[,<type>...]
149-
|A comma separated list of relationship types. Relationships with any of the specified
149+
|A comma-separated list of relationship types. Relationships with any of the specified
150150
relationship types will not be included in the copy.
151151
Cannot be combined with `--copy-only-relationships-with-types`.
152152
|
153153

154154
|--skip-labels=<label>[,<label>...]
155-
|A comma separated list of labels to ignore.
155+
|A comma-separated list of labels to ignore.
156156
|
157157

158158
|--skip-node-properties=<label.property>[,<label.property>...]
159-
|A comma separated list of property keys to ignore for nodes with the specified label. Cannot be combined with `--skip-properties` or `--copy-only-node-properties`.
159+
|A comma-separated list of property keys to ignore for nodes with the specified label. Cannot be combined with `--skip-properties` or `--copy-only-node-properties`.
160160
|
161161

162162
|--skip-properties=<property>[,<property>...]
163-
|A comma separated list of property keys to ignore.
163+
|A comma-separated list of property keys to ignore.
164164
Cannot be combined with `--skip-node-properties`, `--copy-only-node-properties`, `--skip-relationship-properties` or `--copy-only-relationship-properties`.
165165
|
166166

167167
|--skip-relationship-properties=<relationship.property>[,<relationship.property>...]
168-
|A comma separated list of property keys to ignore for relationships with the specified
168+
|A comma-separated list of property keys to ignore for relationships with the specified
169169
type.
170170
Cannot be combined with `--skip-properties` or `--copy-only-relationship-properties`.
171171
|
172172

173173
|--temp-path=<path>
174-
|Path to a directory to be used as a staging area when the source and target databases are the same.
175-
|The current directory.
174+
|Path to a directory to be used as a staging area when the source and target databases are the same. Default is the current directory.
175+
|
176176

177177
|--to-format=<format>
178178
|Set the format for the new database.
@@ -183,15 +183,15 @@ If you go from `high_limit` to `standard` or `aligned`, there is no validation t
183183
|same
184184

185185
|--to-path-data=<path>
186-
|Path to the databases directory, containing the database directory to target to.
186+
|Path to the databases directory, containing the database directory to targe from.
187187
|server.directories.data/databases
188188

189189
|--to-path-schema=<path>
190-
|Path to a directory to create the schema commands file in.
191-
|The current directory.
190+
|Path to a directory to create the schema commands file in. Default is the current directory.
191+
|
192192

193193
|--to-path-txn=<path>
194-
|Path to the transactions directory containing the transaction directory for the database to target to.
194+
|Path to the transactions directory containing the transaction directory for the database to target from.
195195
|server.directories.transaction.logs.root
196196

197197
|--verbose

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ If `--info` is specified, then the database is not loaded, but information (i.e.
5252
| Description
5353
| Default
5454
|<database>
55-
|Name of the database to load.
56-
Can contain `*` and `?` for globbing.
55+
|Name of the database to load. Can contain `*` and `?` for globbing. Note that `*` and `?` have special meaning in some shells and might need to be escaped or used with quotes.
5756
|neo4j
5857
|===
5958

0 commit comments

Comments
 (0)