Skip to content

Commit b435fac

Browse files
Add example on how to CREATE db from the seed URI
1 parent 9e6e076 commit b435fac

File tree

1 file changed

+52
-2
lines changed

1 file changed

+52
-2
lines changed

modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,17 +92,19 @@ Replaced by `existingDataSeedServer`.
9292
|
9393
Defines an identical seed from an external source which will be used to seed all servers.
9494

95+
For examples, see xref::clustering/databases.adoc#cluster-seed-uri[Seed from URI].
96+
9597
| `seedConfig`
9698
| Comma-separated list of configuration values.
9799
|
98-
For more information see xref::clustering/databases.adoc#cluster-seed-uri[Seed from URI].
100+
99101

100102
| `seedCredentials` label:deprecated[Deprecated in 5.26]
101103
| credentials
102104
|
103105
Defines credentials that need to be passed into certain seed providers.
104106
It is recommended to use the `CloudSeedProvider` seed provider, which does not require this configuration when seeding from cloud storage.
105-
For more information see xref::clustering/databases.adoc#cloud-seed-provider[CloudSeedProvider].
107+
For more information, see xref::clustering/databases.adoc#cloud-seed-provider[CloudSeedProvider].
106108

107109
| `txLogEnrichment`
108110
| `FULL` \| `DIFF` \| `OFF`
@@ -214,6 +216,54 @@ The `IF NOT EXISTS` and `OR REPLACE` parts of these commands cannot be used toge
214216
====
215217

216218

219+
==== Create databases using seeding options
220+
221+
Neo4j 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.
222+
223+
For more information on seeding from URI, refer to xref::clustering/databases.adoc#cluster-seed-uri[Manage databases in a cluster -> Seed from URI].
224+
225+
.Seed providers supported in Neo4j by default
226+
[cols="2,1,2",options="header"]
227+
|===
228+
| Seed provider
229+
| URL scheme
230+
| URI example
231+
232+
| `FileSeedProvider`
233+
| `file:`
234+
| `file:/tmp/backup1.backup`
235+
236+
| `URLConnectionSeedProvider`
237+
| `ftp:` +
238+
`http:` +
239+
`https:`
240+
| `ftp:://myftp.com/backups/backup1.backup` +
241+
`/http://myhttp.com/backups/backup1.backup` +
242+
`/https://myhttp.com/backups/backup1.backup`
243+
244+
| `S3SeedProvider` label:deprecated[Deprecated in 5.26]
245+
| `s3:`
246+
| `s3://mybucket/backups/backup1.backup`
247+
248+
| `CloudSeedProvider`
249+
| `s3:` +
250+
`gs:` +
251+
`azb:`
252+
| `s3://mybucket/backups/backup1.backup` +
253+
`gs://mybucket/backups/backup1.backup` +
254+
`azb://mystorageaccount.blob/backupscontainer/backup1.backup`
255+
|===
256+
257+
258+
The following example shows how to create a database using the URI of the seed:
259+
260+
[source, cypher]
261+
----
262+
CREATE DATABASE foo OPTIONS {existingData: 'use', seedURI:'s3://myBucket/myBackup.backup'}
263+
----
264+
265+
Starting from Neo4j 2025.01, seed from URI can also be used in combination with `CREATE OR REPLACE DATABASE`.
266+
217267
[[manage-databases-start]]
218268
== Start databases
219269

0 commit comments

Comments
 (0)