Skip to content

Commit f24db61

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

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
@@ -1,5 +1,5 @@
11
:page-role: enterprise-edition
2-
:description: How to create a database using a seed from URI.
2+
:description: How to create a database using a seed from URI.
33

44
[[database-seed-uri]]
55
= Create a database from a URI
@@ -32,9 +32,13 @@ To determine the cause of the problem, it is recommended to look at the `debug.l
3232
[[neo4j-seed-providers]]
3333
== Seed providers in Neo4j
3434

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

39+
Backups have a `.backup` extension, while the dump file can have whatever extension the user chooses.
40+
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.
41+
3842
The mechanism is pluggable, allowing new sources of seeds to be supported (see link:https://www.neo4j.com/docs/java-reference/5/extending-neo4j/project-setup/#extending-neo4j-plugin-seed-provider[Java Reference -> Implement custom seed providers] for more information).
3943

4044
The product has built-in support for seed from a mounted file system (file), FTP server, HTTP/HTTPS server, Amazon S3, Google Cloud Storage (from Neo4j 5.25), and Azure Cloud Storage (from Neo4j 5.25).
@@ -88,6 +92,7 @@ include::partial$/aws-s3-overrides.adoc[]
8892
include::partial$/aws-s3-credentials.adoc[]
8993

9094
. Create database from `myBackup.backup`.
95+
This backup can be a full backup, a differential backup, or a dump file.
9196
+
9297
[source,shell, role="nocopy"]
9398
----
@@ -101,6 +106,7 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBac
101106
include::partial$/gcs-credentials.adoc[]
102107

103108
. Create database from `myBackup.backup`.
109+
This backup can be a full backup, a differential backup, or a dump file.
104110
+
105111
[source,shell]
106112
----
@@ -113,6 +119,7 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'gs://myBucket/myBac
113119
include::partial$/azb-credentials.adoc[]
114120

115121
. Create database from `myBackup.backup`.
122+
This backup can be a full backup, a differential backup, or a dump file.
116123
+
117124
[source,shell]
118125
----
@@ -171,30 +178,40 @@ Where `accessKey` and `secretKey` are provided by AWS.
171178
| `URLConnectionSeedProvider` label:deprecated[Deprecated in 5.26], +
172179
`FileSeedProvider` label:new[Introduced in 5.26]
173180
| `file:/tmp/backup1.backup`
181+
`file:/tmp/backup1.dump`
174182

175183
| `ftp:`
176184
| `URLConnectionSeedProvider`
177185
| `\ftp://myftp.com/backups/backup1.backup`
186+
`\ftp://myftp.com/backups/backup1.dump`
178187

179188
| `http:`
180189
| `URLConnectionSeedProvider`
181190
| `\http://myhttp.com/backups/backup1.backup`
191+
`\http://myhttp.com/backups/backup1.dump`
182192

183193
| `https:`
184194
| `URLConnectionSeedProvider`
185195
| `\https://myhttp.com/backups/backup1.backup`
196+
`\https://myhttp.com/backups/backup1.dump`
186197

187198
| `s3:`
188199
| `S3SeedProvider` label:deprecated[Deprecated in 5.26], +
189200
`CloudSeedProvider` label:new[Introduced in 5.25]
190201
| `s3://mybucket/backups/backup1.backup`
202+
`s3://mybucket/backups/backup1.dump`
203+
`s3://mybucket/backups/` (folder containing a backup chain, only used by `CloudSeedProvider`)
191204

192205
| `gs:`
193206
| `CloudSeedProvider` label:new[Introduced in 5.25]
194207
| `gs://mybucket/backups/backup1.backup`
208+
`gs://mybucket/backups/backup1.dump`
209+
`gs://mybucket/backups/` (folder containing a backup chain)
195210

196211
| `azb:`
197212
| `CloudSeedProvider` label:new[Introduced in 5.25]
198213
| `azb://mystorageaccount.blob/backupscontainer/backup1.backup`
214+
`azb://mystorageaccount.blob/backupscontainer/backup1.dump`
215+
`azb://mystorageaccount.blob/backupscontainer/` (folder containing a backup chain)
199216
|===
200217

0 commit comments

Comments
 (0)