Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:page-role: enterprise-edition
:description: How to create a database using a seed from URI.
:description: How to create a database using a seed from URI.

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

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.
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.
When using `CloudSeedProvider`, the URI can point also to a folder which contains a backup chain.
The sources of seeds are called _seed providers_.

Backups have a `.backup` extension, while the dump file can have whatever extension the user chooses.
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.

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).

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).
Expand Down Expand Up @@ -88,6 +92,7 @@ include::partial$/aws-s3-overrides.adoc[]
include::partial$/aws-s3-credentials.adoc[]

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

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

. Create database from `myBackup.backup`.
This backup can be a full backup, a differential backup, or a dump file.
+
[source,shell]
----
Expand Down Expand Up @@ -171,30 +178,40 @@ Where `accessKey` and `secretKey` are provided by AWS.
| `URLConnectionSeedProvider` label:deprecated[Deprecated in 5.26], +
`FileSeedProvider` label:new[Introduced in 5.26]
| `file:/tmp/backup1.backup`
`file:/tmp/backup1.dump`

| `ftp:`
| `URLConnectionSeedProvider`
| `\ftp://myftp.com/backups/backup1.backup`
`\ftp://myftp.com/backups/backup1.dump`

| `http:`
| `URLConnectionSeedProvider`
| `\http://myhttp.com/backups/backup1.backup`
`\http://myhttp.com/backups/backup1.dump`

| `https:`
| `URLConnectionSeedProvider`
| `\https://myhttp.com/backups/backup1.backup`
`\https://myhttp.com/backups/backup1.dump`

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

| `gs:`
| `CloudSeedProvider` label:new[Introduced in 5.25]
| `gs://mybucket/backups/backup1.backup`
`gs://mybucket/backups/backup1.dump`
`gs://mybucket/backups/` (folder containing a backup chain)

| `azb:`
| `CloudSeedProvider` label:new[Introduced in 5.25]
| `azb://mystorageaccount.blob/backupscontainer/backup1.backup`
`azb://mystorageaccount.blob/backupscontainer/backup1.dump`
`azb://mystorageaccount.blob/backupscontainer/` (folder containing a backup chain)
|===