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
@@ -8,15 +8,15 @@ This method seeds all databases with an identical seed from an external source,
88
99You specify the seed URI as an argument of the `CREATE DATABASE` command:
1010
11- [source, cypher, role="noplay" ]
11+ [source, cypher]
1212----
13- CREATE DATABASE foo OPTIONS {existingData: 'use', seedURI:'s3://myBucket/myBackup.backup'}
13+ CREATE DATABASE foo OPTIONS { seedURI:'s3://myBucket/myBackup.backup' }
1414----
1515
1616Download and validation of the seed is only performed as the new database is started.
1717If it fails, the database is not available and it has the `statusMessage`: `Unable to start database` of the `SHOW DATABASES` command.
1818
19- [source, cypher, role="noplay" ]
19+ [source, cypher]
2020----
2121neo4j@neo4j> SHOW DATABASES;
2222+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -26,7 +26,7 @@ neo4j@neo4j> SHOW DATABASES;
2626+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2727----
2828
29- To determine the cause of the problem, it is recommended to look at the `debug.log`.
29+ To determine the cause of the problem, check the `debug.log` file .
3030
3131[NOTE]
3232====
@@ -90,9 +90,9 @@ include::partial$/aws-s3-credentials.adoc[]
9090
9191. Create database from `myBackup.backup`.
9292+
93- [source,shell, role="nocopy" ]
93+ [source,cypher ]
9494----
95- CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup' }
95+ CREATE DATABASE foo OPTIONS { seedURI: 's3://myBucket/myBackup.backup' }
9696----
9797
9898======
@@ -103,9 +103,9 @@ include::partial$/gcs-credentials.adoc[]
103103
104104. Create database from `myBackup.backup`.
105105+
106- [source,shell ]
106+ [source,cypher ]
107107----
108- CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'gs://myBucket/myBackup.backup' }
108+ CREATE DATABASE foo OPTIONS { seedURI: 'gs://myBucket/myBackup.backup' }
109109----
110110======
111111[role=include-with-Azure-cloud-storage]
@@ -115,9 +115,9 @@ include::partial$/azb-credentials.adoc[]
115115
116116. Create database from `myBackup.backup`.
117117+
118- [source,shell ]
118+ [source,cypher ]
119119----
120- CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAccount/myContainer/myBackup.backup' }
120+ CREATE DATABASE foo OPTIONS { seedURI: 'azb://myStorageAccount/myContainer/myBackup.backup' }
121121----
122122======
123123=====
@@ -129,26 +129,32 @@ Starting from Neo4j 2025.01, the `CloudSeedProvider` supports seeding up to a sp
129129[role=label--new-2025.01]
130130Seed up to a specific date::
131131
132- To seed up to a specific date, you need to pass the differential backup, which contains the data up to that date.
132+ To seed up to a specific date, provide the differential backup containing the data up to that date.
133133+
134- [source,shell ]
134+ [source,cypher ]
135135----
136- CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup', seedRestoreUntil: datetime("2019-06-01T18:40:32.142+0100") }
136+ CREATE DATABASE foo OPTIONS {
137+ seedURI: 's3://myBucket/myBackup.backup',
138+ seedRestoreUntil: datetime('2019-06-01T18:40:32.142+0100')
139+ }
137140----
138141+
139142This will seed the database with transactions committed before the provided timestamp.
140143
141144[role=label--new-2025.01]
142145Seed up to a specific transaction ID::
143146
144- To seed up to a specific transaction ID, you need to pass the differential backup that contains the data up to that transaction ID.
147+ To seed up to a specific transaction ID, pass the differential backup containing the data up to that transaction ID.
145148+
146- [source,shell ]
149+ [source,cypher ]
147150----
148- CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup', seedRestoreUntil: 123 }
151+ CREATE DATABASE foo OPTIONS {
152+ seedURI: 's3://myBucket/myBackup.backup',
153+ seedRestoreUntil: 123
154+ }
149155----
150156+
151- This will seed the database with transactions up to, but not including transaction 123.
157+ This will seed the database with transactions up to ( but not including) transaction 123.
152158
153159[role=label--deprecated]
154160[[s3-seed-provider]]
@@ -164,31 +170,37 @@ The `S3SeedProvider` supports:
164170[NOTE]
165171====
166172Neo4j comes bundled with necessary libraries for AWS S3 connectivity.
167- Therefore, if you use `S3SeedProvider`,`aws cli` is not required but can be used with the `CloudSeedProvider`.
173+ Therefore, if you use `S3SeedProvider`, `aws cli` is not required (as it instead is with `CloudSeedProvider`) .
168174====
169175
170176The `S3SeedProvider` requires additional configuration.
171- This is specified with the `seedConfig` option.
172- This option expects a comma-separated list of configurations.
173- Each configuration value is specified as a name followed by `=` and the value, as such:
177+ This is specified with the `seedConfig` option, which expects a comma-separated list of configurations.
178+ Each configuration entry is specified in the format `key=value`, as such:
174179
175- [source, cypher, role="noplay" ]
180+ [source, cypher]
176181----
177- CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup', seedConfig: 'region=eu-west-1' }
182+ CREATE DATABASE foo OPTIONS {
183+ seedURI: 's3://myBucket/myBackup.backup',
184+ seedConfig: 'region=eu-west-1'
185+ }
178186----
179187
180188`S3SeedProvider` also requires passing in credentials.
181189These are specified with the `seedCredentials` option.
182190Seed credentials are securely passed from the Cypher command to each server hosting the database.
183191For this to work, Neo4j on each server in the cluster must be configured with identical keystores.
184192This is identical to the configuration required by remote aliases, see xref:database-administration/aliases/remote-database-alias-configuration.adoc#remote-alias-config-DBMS_admin-A[Configuration of DBMS with remote database alias].
185- If this configuration is not performed , the `seedCredentials` option fails.
193+ Without this configuration, the `seedCredentials` option fails.
186194
187- [source, cypher, role="noplay" ]
195+ [source, cypher]
188196----
189- CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup', seedConfig: 'region=eu-west-1', seedCredentials: [accessKey];[secretKey] }
197+ CREATE DATABASE foo OPTIONS {
198+ seedURI: 's3://myBucket/myBackup.backup',
199+ seedConfig: 'region=eu-west-1',
200+ seedCredentials: <accessKey>;<secretKey>
201+ }
190202----
191- Where `accessKey` and `secretKey` are provided by AWS.
203+ Where `< accessKey> ` and `< secretKey> ` are provided by AWS.
192204
193205=== Seed provider reference
194206
@@ -226,4 +238,4 @@ Where `accessKey` and `secretKey` are provided by AWS.
226238| `azb:`
227239| `CloudSeedProvider`
228240| `azb://mystorageaccount.blob/backupscontainer/backup1.backup`
229- |===
241+ |===
0 commit comments