Skip to content

Commit b67d0aa

Browse files
Clarify seed from a URI that dumps can also be used as seeds (#2509) (#2520)
Co-authored-by: Natalia Ivakina <[email protected]>
1 parent 45b3db7 commit b67d0aa

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

modules/ROOT/pages/database-administration/standard-databases/seed-from-uri.adoc

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,13 @@ Starting from Neo4j 2025.01, seed from URI can also be used in combination with
5454
[[neo4j-seed-providers]]
5555
== Seed providers in Neo4j
5656

57-
The seed can either be a full backup, a differential backup (see <<cloud-seed-provider, `CloudSeedProvider`>>), or a dump from an existing database.
57+
The seed can be a full backup, a differential backup (see <<cloud-seed-provider, `CloudSeedProvider`>>), or a dump from an existing database.
58+
When using `CloudSeedProvider`, the URI can point also to a folder which contains a backup chain.
5859
The sources of seeds are called _seed providers_.
5960

61+
Backups have a `.backup` extension, while the dump file can have whatever extension the user chooses.
62+
For example, the backup file can be called `myBackup.backup`, while the dump can be called `myDump.dump` or also `myBackup.backup`, or any other name.
63+
6064
The mechanism is pluggable, allowing new sources of seeds to be supported (see link:https://www.neo4j.com/docs/java-reference/current/extending-neo4j/project-setup/#extending-neo4j-plugin-seed-provider[Java Reference -> Implement custom seed providers] for more information).
6165

6266
The product has built-in support for seed from a mounted file system (file), FTP server, HTTP/HTTPS server, Amazon S3, Google Cloud Storage, and Azure Cloud Storage.
@@ -114,6 +118,7 @@ include::partial$/aws-s3-overrides.adoc[]
114118
include::partial$/aws-s3-credentials.adoc[]
115119

116120
. Create database from `myBackup.backup`.
121+
This backup can be a full backup, a differential backup, or a dump file.
117122
+
118123
Using Cypher 5:
119124
+
@@ -136,6 +141,7 @@ CREATE DATABASE foo OPTIONS { seedURI: 's3://myBucket/myBackup.backup' }
136141
include::partial$/gcs-credentials.adoc[]
137142

138143
. Create database from `myBackup.backup`.
144+
This backup can be a full backup, a differential backup, or a dump file.
139145
+
140146
Using Cypher 5:
141147
+
@@ -158,6 +164,7 @@ CREATE DATABASE foo OPTIONS { seedURI: 'gs://myBucket/myBackup.backup' }
158164
include::partial$/azb-credentials.adoc[]
159165

160166
. Create database from `myBackup.backup`.
167+
This backup can be a full backup, a differential backup, or a dump file.
161168
+
162169
Using Cypher 5:
163170
+
@@ -190,7 +197,7 @@ The `S3SeedProvider` supports:
190197
[NOTE]
191198
====
192199
Neo4j comes bundled with necessary libraries for AWS S3 connectivity.
193-
Therefore, if you use `S3SeedProvider`, `aws cli` is not required (as it instead is with `CloudSeedProvider`).
200+
Therefore, if you use `S3SeedProvider`, `aws cli` is not required as it is for `CloudSeedProvider`.
194201
====
195202

196203
The `S3SeedProvider` requires additional configuration.
@@ -236,31 +243,41 @@ Where `<accessKey>` and `<secretKey>` are provided by AWS.
236243
| `file:`
237244
| `FileSeedProvider`
238245
| `file:/tmp/backup1.backup`
246+
`file:/tmp/backup1.dump`
239247

240248
| `ftp:`
241249
| `URLConnectionSeedProvider`
242250
| `\ftp://myftp.com/backups/backup1.backup`
251+
`\ftp://myftp.com/backups/backup1.dump`
243252

244253
| `http:`
245254
| `URLConnectionSeedProvider`
246255
| `\http://myhttp.com/backups/backup1.backup`
256+
`\http://myhttp.com/backups/backup1.dump`
247257

248258
| `https:`
249259
| `URLConnectionSeedProvider`
250260
| `\https://myhttp.com/backups/backup1.backup`
261+
`\https://myhttp.com/backups/backup1.dump`
251262

252263
| `s3:`
253264
| `S3SeedProvider` label:deprecated[Deprecated in 5.26], +
254265
`CloudSeedProvider`
255266
| `s3://mybucket/backups/backup1.backup`
267+
`s3://mybucket/backups/backup1.dump`
268+
`s3://mybucket/backups/` (folder containing a backup chain, only used by `CloudSeedProvider`)
256269

257270
| `gs:`
258271
| `CloudSeedProvider`
259272
| `gs://mybucket/backups/backup1.backup`
273+
`gs://mybucket/backups/backup1.dump`
274+
`gs://mybucket/backups/` (folder containing a backup chain)
260275

261276
| `azb:`
262277
| `CloudSeedProvider`
263278
| `azb://mystorageaccount.blob/backupscontainer/backup1.backup`
279+
`azb://mystorageaccount.blob/backupscontainer/backup1.dump`
280+
`azb://mystorageaccount.blob/backupscontainer/` (folder containing a backup chain)
264281
|===
265282

266283

0 commit comments

Comments
 (0)