Skip to content

Commit 6aad247

Browse files
Remove useExisting option; polish examples & page (neo4j#2319)
Spinoff of neo4j#2287 , on the `cypher-25` base branch as the option is deprecated then.
1 parent ccba2ee commit 6aad247

File tree

1 file changed

+55
-34
lines changed

1 file changed

+55
-34
lines changed

modules/ROOT/pages/database-administration/standard-databases/seed-from-uri.adoc

Lines changed: 55 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,36 @@
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

4-
[[database-seed-uri]]
54
= Create a database from a URI
65

76
This method seeds all databases with an identical seed from an external source, specified by a URI.
87

98
You specify the seed URI as an argument of the `CREATE DATABASE` command:
109

11-
[source, cypher, role="noplay"]
10+
[source, cypher]
1211
----
13-
CREATE DATABASE foo OPTIONS {existingData: 'use', seedURI:'s3://myBucket/myBackup.backup'}
12+
CREATE DATABASE foo OPTIONS { seedURI:'s3://myBucket/myBackup.backup' }
1413
----
1514

1615
Download and validation of the seed is only performed as the new database is started.
1716
If it fails, the database is not available and it has the `statusMessage`: `Unable to start database` of the `SHOW DATABASES` command.
1817

19-
[source, cypher, role="noplay"]
18+
.Example failure output for `SHOW DATABASES`
19+
[source, role="queryresult"]
2020
----
21-
neo4j@neo4j> SHOW DATABASES;
22-
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2321
| name | type | aliases | access | address | role | writer | requestedStatus | currentStatus | statusMessage | default | home | constituents |
2422
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2523
| "seed3" | "standard" | [] | "read-write" | "localhost:7682" | "unknown" | FALSE | "online" | "offline" | "Unable to start database `DatabaseId{3fe1a59b[seed3]}`" | FALSE | FALSE | [] |
26-
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2724
----
2825

29-
To determine the cause of the problem, it is recommended to look at the `debug.log`.
26+
To determine the cause of the problem, check the `debug.log` file.
3027

3128
[NOTE]
3229
====
3330
Starting from Neo4j 2025.01, seed from URI can also be used in combination with xref:database-administration/standard-databases/create-databases.adoc[`CREATE OR REPLACE DATABASE`].
3431
====
3532

33+
3634
[[neo4j-seed-providers]]
3735
== Seed providers in Neo4j
3836

@@ -48,13 +46,20 @@ The product has built-in support for seed from a mounted file system (file), FTP
4846
Amazon S3, Google Cloud Storage, and Azure Cloud Storage are supported by default, but the other providers require configuration of xref:configuration/configuration-settings.adoc#config_dbms.databases.seed_from_uri_providers[`dbms.databases.seed_from_uri_providers`].
4947
====
5048

49+
5150
[[file-seed-provider]]
5251
=== FileSeedProvider
5352

5453
The `FileSeedProvider` supports:
5554

5655
** `file:`
5756

57+
[NOTE]
58+
====
59+
Local file paths must be absolute paths.
60+
====
61+
62+
5863
[[url-connection-seed-provider]]
5964
=== URLConnectionSeedProvider
6065

@@ -67,6 +72,7 @@ The `URLConnectionSeedProvider` supports the following:
6772
Starting from Neo4j 2025.01, the `URLConnectionSeedProvider` does not support `file`.
6873
// This is true for both Cypher 5 and Cypher 25.
6974

75+
7076
[[cloud-seed-provider]]
7177
=== CloudSeedProvider
7278

@@ -90,9 +96,9 @@ include::partial$/aws-s3-credentials.adoc[]
9096

9197
. Create database from `myBackup.backup`.
9298
+
93-
[source,shell, role="nocopy"]
99+
[source,cypher]
94100
----
95-
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup' }
101+
CREATE DATABASE foo OPTIONS { seedURI: 's3://myBucket/myBackup.backup' }
96102
----
97103

98104
======
@@ -103,9 +109,9 @@ include::partial$/gcs-credentials.adoc[]
103109

104110
. Create database from `myBackup.backup`.
105111
+
106-
[source,shell]
112+
[source,cypher]
107113
----
108-
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'gs://myBucket/myBackup.backup' }
114+
CREATE DATABASE foo OPTIONS { seedURI: 'gs://myBucket/myBackup.backup' }
109115
----
110116
======
111117
[role=include-with-Azure-cloud-storage]
@@ -115,40 +121,48 @@ include::partial$/azb-credentials.adoc[]
115121

116122
. Create database from `myBackup.backup`.
117123
+
118-
[source,shell]
124+
[source,cypher]
119125
----
120-
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAccount/myContainer/myBackup.backup' }
126+
CREATE DATABASE foo OPTIONS { seedURI: 'azb://myStorageAccount/myContainer/myBackup.backup' }
121127
----
122128
======
123129
=====
124130

131+
125132
==== Support for seeding up to a date or a transaction ID
126133

127134
Starting from Neo4j 2025.01, the `CloudSeedProvider` supports seeding up to a specific date or transaction ID using the `seedRestoreUntil` option.
128135

129136
[role=label--new-2025.01]
130137
Seed up to a specific date::
131138

132-
To seed up to a specific date, you need to pass the differential backup, which contains the data up to that date.
139+
To seed up to a specific date, provide the differential backup containing the data up to that date.
133140
+
134-
[source,shell]
141+
[source,cypher]
135142
----
136-
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup', seedRestoreUntil: datetime("2019-06-01T18:40:32.142+0100") }
143+
CREATE DATABASE foo OPTIONS {
144+
seedURI: 's3://myBucket/myBackup.backup',
145+
seedRestoreUntil: datetime('2019-06-01T18:40:32.142+0100')
146+
}
137147
----
138148
+
139149
This will seed the database with transactions committed before the provided timestamp.
140150

141151
[role=label--new-2025.01]
142152
Seed up to a specific transaction ID::
143153

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.
154+
To seed up to a specific transaction ID, provide the differential backup containing the data up to that transaction ID.
145155
+
146-
[source,shell]
156+
[source,cypher]
147157
----
148-
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup', seedRestoreUntil: 123 }
158+
CREATE DATABASE foo OPTIONS {
159+
seedURI: 's3://myBucket/myBackup.backup',
160+
seedRestoreUntil: 123
161+
}
149162
----
150163
+
151-
This will seed the database with transactions up to, but not including transaction 123.
164+
This will seed the database with transactions up to (but not including) transaction 123.
165+
152166

153167
[role=label--deprecated]
154168
[[s3-seed-provider]]
@@ -164,31 +178,38 @@ The `S3SeedProvider` supports:
164178
[NOTE]
165179
====
166180
Neo4j 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`.
181+
Therefore, if you use `S3SeedProvider`, `aws cli` is not required (as it instead is with `CloudSeedProvider`).
168182
====
169183

170184
The `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:
185+
This is specified with the `seedConfig` option, which expects a comma-separated list of configurations.
186+
Each configuration entry is specified in the format `key=value`, as such:
174187

175-
[source, cypher, role="noplay"]
188+
[source, cypher]
176189
----
177-
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup', seedConfig: 'region=eu-west-1' }
190+
CREATE DATABASE foo OPTIONS {
191+
seedURI: 's3://myBucket/myBackup.backup',
192+
seedConfig: 'region=eu-west-1'
193+
}
178194
----
179195

180196
`S3SeedProvider` also requires passing in credentials.
181197
These are specified with the `seedCredentials` option.
182198
Seed credentials are securely passed from the Cypher command to each server hosting the database.
183199
For this to work, Neo4j on each server in the cluster must be configured with identical keystores.
184200
This 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.
201+
Without this configuration, the `seedCredentials` option fails.
186202

187-
[source, cypher, role="noplay"]
203+
[source, cypher]
188204
----
189-
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3://myBucket/myBackup.backup', seedConfig: 'region=eu-west-1', seedCredentials: [accessKey];[secretKey] }
205+
CREATE DATABASE foo OPTIONS {
206+
seedURI: 's3://myBucket/myBackup.backup',
207+
seedConfig: 'region=eu-west-1',
208+
seedCredentials: <accessKey>;<secretKey>
209+
}
190210
----
191-
Where `accessKey` and `secretKey` are provided by AWS.
211+
Where `<accessKey>` and `<secretKey>` are provided by AWS.
212+
192213

193214
=== Seed provider reference
194215

@@ -200,7 +221,7 @@ Where `accessKey` and `secretKey` are provided by AWS.
200221

201222
| `file:`
202223
| `FileSeedProvider`
203-
| `\file://tmp/backup1.backup`
224+
| `file:/tmp/backup1.backup`
204225

205226
| `ftp:`
206227
| `URLConnectionSeedProvider`
@@ -226,4 +247,4 @@ Where `accessKey` and `secretKey` are provided by AWS.
226247
| `azb:`
227248
| `CloudSeedProvider`
228249
| `azb://mystorageaccount.blob/backupscontainer/backup1.backup`
229-
|===
250+
|===

0 commit comments

Comments
 (0)