diff --git a/modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc b/modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc index 793763352..843c53eca 100644 --- a/modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc +++ b/modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc @@ -92,17 +92,19 @@ Replaced by `existingDataSeedServer`. | Defines an identical seed from an external source which will be used to seed all servers. +For examples, see xref::clustering/databases.adoc#cluster-seed-uri[Seed from URI]. + | `seedConfig` | Comma-separated list of configuration values. | -For more information see xref::clustering/databases.adoc#cluster-seed-uri[Seed from URI]. + | `seedCredentials` label:deprecated[Deprecated in 5.26] | credentials | Defines credentials that need to be passed into certain seed providers. It is recommended to use the `CloudSeedProvider` seed provider, which does not require this configuration when seeding from cloud storage. -For more information see xref::clustering/databases.adoc#cloud-seed-provider[CloudSeedProvider]. +For more information, see xref::clustering/databases.adoc#cloud-seed-provider[CloudSeedProvider]. | `txLogEnrichment` | `FULL` \| `DIFF` \| `OFF` @@ -214,6 +216,56 @@ The `IF NOT EXISTS` and `OR REPLACE` parts of these commands cannot be used toge ==== +==== Create a database using seeding options + +In Neo4j, you can create a database using the URI of the seed. +The following example shows how to seed the database `customers` from Amazon S3. + +[source, cypher] +---- +CREATE DATABASE customers OPTIONS {existingData: 'use', seedURI:'s3://myBucket/myBackup.backup'} +---- + +Neo4j has built-in support for a seed from a mounted file system (file), FTP server, HTTP/HTTPS server, Amazon S3, Google Cloud Storage, and Azure Cloud Storage. +The seed provider is determined by the xref:configuration/configuration-settings.adoc#config_dbms.databases.seed_from_uri_providers[dbms.databases.seed_from_uri_providers] setting, which defaults to `CloudSeedProvider`. +To use other providers, you must configure `dbms.databases.seed_from_uri_providers` accordingly. + +.Seed providers supported in Neo4j +[cols="2,1,3",options="header"] +|=== +| Seed provider +| URL scheme +| URI example + +| `FileSeedProvider` +| `file:` +| `file:/tmp/backup1.backup` + +| `URLConnectionSeedProvider`footnote:[From 2025.01, `URLConnectionSeedProvider` does not support `file`.] +| `ftp:` + +`http:` + +`https:` +| `ftp://myftp.com/backups/backup1.backup` + +`/http://myhttp.com/backups/backup1.backup` + +`/https://myhttps.com/backups/backup1.backup` + +| `S3SeedProvider` label:deprecated[Deprecated in 5.26] +| `s3:` +| `s3://mybucket/backups/backup1.backup` + +| `CloudSeedProvider` +| `s3:` + +`gs:` + +`azb:` +| `s3://mybucket/backups/backup1.backup` + +`gs://mybucket/backups/backup1.backup` + +`azb://mystorageaccount.blob/backupscontainer/backup1.backup` +|=== + +Starting from Neo4j 2025.01, seed from URI can also be used in combination with `CREATE OR REPLACE DATABASE`. + +For more information about the seeding from URI functionality, refer to the xref::clustering/databases.adoc#cluster-seed-uri[Manage databases in a cluster -> Seed from URI] page. + [[manage-databases-start]] == Start databases