Skip to content

Commit e53b42d

Browse files
authored
Update the create databases options (#3148)
1 parent 3e73a87 commit e53b42d

2 files changed

Lines changed: 49 additions & 33 deletions

File tree

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

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Currently, this is only supported with `existingDataSeedInstance`, `existingData
127127

128128
|`existingDataSeedServer`
129129

130-
`existingDataSeedInstance` label:deprecated[deprecated in 5.25]
130+
`existingDataSeedInstance` label:deprecated[Deprecated in 5.25]
131131
| ID of the cluster server
132132
|
133133
Defines which server is used for seeding the data of the created database.
@@ -144,7 +144,7 @@ For more information, see xref:database-administration/standard-databases/seed-f
144144
| Comma-separated list of configuration values.
145145
|
146146

147-
| `seedCredentials` label:deprecated[Deprecated in 5.26] label:removed[Removed in Cypher 25, Neo4j 2025.06]
147+
| `seedCredentials` label:deprecated[Deprecated in 5.26]
148148
| credentials
149149
|
150150
Defines credentials that need to be passed into certain seed providers.
@@ -156,7 +156,7 @@ For more information see xref::database-administration/standard-databases/seed-f
156156
|
157157
Defines the level of enrichment applied to transaction logs for Change Data Capture (CDC) purposes.
158158

159-
For details about enrichment mode, see link:https://neo4j.com/docs/cdc/current/get-started/self-managed/#_modify_a_databases_cdc_mode[Change Data Capture Manual -> Enable CDC on self-managed instances -> Modify a database’s CDC mode].
159+
For details about enrichment mode, see link:{neo4j-docs-base-uri}/cdc/current/get-started/self-managed/#tweak-mode[Change Data Capture Manual -> Enable CDC on self-managed instances -> Toggle CDC mode].
160160

161161
| `storeFormat`
162162
| `aligned` \| `standard` \| `high_limit` \| `block`
@@ -165,43 +165,60 @@ Defines the store format if the database created is new.
165165
`high_limit` and `standard` formats are deprecated from 5.23.
166166
For more information on store formats, see xref::database-internals/store-formats.adoc[Store formats].
167167

168-
If the store is seeded with `seedURI`, `existingDataSeedInstance` (removed in Cypher 25), or `existingDataSeedServer`, or if the command is used to mount pre-existing store files already present on the disk, they will retain their current store format without any modifications.
169-
|===
168+
If the store is seeded with `seedURI`, `existingDataSeedInstance`, or `existingDataSeedServer`, or if the command is used to mount pre-existing store files already present on the disk, they will retain their current store format without any modifications.
170169

171-
[NOTE]
172-
====
173-
Starting from Neo4j 2025.01, you can use `existingData`, `seedURI`, `seedConfig`, and `seedCredentials` options together with the `CREATE OR REPLACE DATABASE` command.
170+
| `seedRestoreUntil` label:new[Introduced in 2025.01]
171+
| Datetime or transaction id. E.g. `datetime("2025-01-01T12:15:00.000+0100")` or `123456`
172+
|
173+
If you are passing a `seedURI` that leads to a backup chain, including differential backups, you can choose to not apply all the transactions in the differential backups.
174+
To seed up to a specific date, specify a `datetime`.
175+
This will seed the database with transactions committed before the provided timestamp.
176+
To seed up to a specific transaction ID, specify a transaction ID.
177+
This will seed the database with transactions up to, but not including the specified transaction.
178+
|===
174179

175-
The `existingDataSeedInstance` (removed in Cypher 25) and `existingDataSeedServer` are not supported with the `CREATE OR REPLACE DATABASE` command.
176-
More details about seeding options can be found in xref::clustering/databases.adoc#cluster-seed[Seed a cluster].
177-
====
178180
======
179181
[role=include-with-cypher-25]
180182
======
181183
The `CREATE DATABASE [OR REPLACE]` command can have a map of options, e.g., `OPTIONS {key: 'value'}`.
182184

183-
[options="header"]
185+
[options="header", width="100%", cols="2m,2a,3a"]
184186
|===
185187

186188
| Key | Value | Description
187189

190+
| `existingData` label:deprecated[Deprecated in 2025.06]
191+
| `use`
192+
|
193+
Included for backward compatibility only, has no effect and will be removed in a future version.
194+
188195
|`existingDataSeedServer`
196+
197+
`existingDataSeedInstance` label:removed[Removed in 2025.06]
189198
| ID of the cluster server
190199
|
191200
Defines which server is used for seeding the data of the created database.
192201
The server ID can be found in the `serverId` column after running `SHOW SERVERS`.
202+
Replaced by `existingDataSeedServer`.
193203

194-
| `seedURI`
195-
| URI to a backup, a folder that contains backup artifacts or a dump from an existing database.
204+
| `seedURI` label:changed[Changed in 2025.06]
205+
| URI to a backup, a folder that contains backup artifacts, or a dump from an existing database.
196206
|
197207
Defines a seed from an external source, which will be used to seed all servers.
208+
For more information, see xref:database-administration/standard-databases/seed-from-uri.adoc[Create a database from a URI].
198209

199210
| `seedConfig`
200211
| Comma-separated list of configuration values.
201212
|
202-
For more information see xref:database-administration/standard-databases/seed-from-uri.adoc[Create a database from a URI].
203213

204-
| `txLogEnrichment`§
214+
| `seedCredentials` label:removed[Removed in 2025.06]
215+
| credentials
216+
|
217+
Defines credentials that need to be passed into certain seed providers.
218+
It is recommended to use the `CloudSeedProvider` seed provider, which does not require this configuration when seeding from cloud storage.
219+
For more information see xref::database-administration/standard-databases/seed-from-uri.adoc#cloud-seed-provider[CloudSeedProvider].
220+
221+
| `txLogEnrichment`
205222
| `FULL` \| `DIFF` \| `OFF`
206223
|
207224
Defines the level of enrichment applied to transaction logs for Change Data Capture (CDC) purposes.
@@ -231,21 +248,20 @@ This will seed the database with transactions up to, but not including the speci
231248
|
232249
If the `seedURI` points to a folder containing backups for multiple databases, you can specify the database name to filter the artifacts.
233250

234-
| `existingData` label:deprecated[Deprecated in 2025.06]
235-
| `use`
236-
|
237-
Included for backward compatibility only, has no effect and will be removed in a future version.
238-
239251
|===
252+
======
253+
=====
240254

241255
[NOTE]
242256
====
243-
In Cypher 25, the options `seedCredentials` and `existingDataSeedInstance` have been removed, while the `existingData` option is deprecated and has no effect.
257+
Starting with Neo4j 2025.01 for Cypher 5 and 2025.06 for Cypher 25, you can use `seedURI`, `seedConfig`, `existingData` (removed in Cypher 25), and `seedCredentials` (removed in Cypher 25) options together with the `CREATE OR REPLACE DATABASE` command.
258+
259+
The `existingDataSeedInstance` (removed in Cypher 25) and `existingDataSeedServer` are not supported with the `CREATE OR REPLACE DATABASE` command.
260+
More details about seeding options can be found in xref::clustering/databases.adoc#cluster-seed[Seed a cluster].
244261
====
245-
======
246-
=====
247262

248263
The following examples show how to create a database using the `CREATE DATABASE` command with various options.
264+
For examples on seeding a database from a URI, see xref:database-administration/standard-databases/seed-from-uri.adoc[Create a database from a URI].
249265

250266
== Create a database
251267

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Amazon S3, Google Cloud Storage, and Azure Cloud Storage are supported by defaul
7777

7878
The `ServerSeedProvider` supports:
7979

80-
** `server:`
80+
** `server:`
8181

8282
The `server://` scheme allows you to seed a database from a backup artifact located on a server in the cluster's file system.
8383
This can be either a directory or a specific artifact within this directory.
@@ -126,7 +126,7 @@ OPTIONS { existingData: 'use', seedURI: 'server://server-id/foo.backup' };
126126
----
127127

128128
======
129-
[role=include-with-Cypher-25]
129+
[role=include-with-Cypher-25 label--new-2025.06]
130130
======
131131

132132
[source,cypher25]
@@ -159,7 +159,7 @@ OPTIONS { existingData: 'use', seedURI: 'server://server-id/' };
159159
----
160160

161161
======
162-
[role=include-with-Cypher-25]
162+
[role=include-with-Cypher-25 label--new-2025.06]
163163
======
164164

165165
[source,cypher25]
@@ -173,20 +173,20 @@ OPTIONS { seedURI: 'server://server-id/' };
173173
Fails if no valid backup chain can be found for `foo`.
174174
+
175175
Note that if a directory is specified, only backup chains are used.
176-
To use a `.dump` file, you must reference it explicitly.
176+
To use a `.dump` file, you must reference it explicitly.
177177

178178

179-
[role=label--Cypher-25]
179+
[role=label--Cypher-25 label--new-2025.06]
180180
[[example-directory-seedSourceDatabase]]
181181
Example 3: Using a directory and `seedSourceDatabase`::
182182
Create database `foo` from the most recent backup chain found for database `bar` in the seed directory on the server `server-id`:
183183
+
184184

185185
[source,cypher25]
186186
----
187-
CREATE DATABASE foo OPTIONS {
187+
CREATE DATABASE foo OPTIONS {
188188
seedURI: 'server://server-id/',
189-
seedSourceDatabase: 'bar'
189+
seedSourceDatabase: 'bar'
190190
};
191191
----
192192

@@ -405,11 +405,11 @@ Where `<accessKey>` and `<secretKey>` are provided by AWS.
405405
`azb://mystorageaccount.blob/backupscontainer/` (folder containing a backup chain)
406406
|===
407407

408-
408+
[role=label--new-2025.01]
409409
[[seed-restore-until-option]]
410410
== Support for seeding up to a date or a transaction ID
411411

412-
Starting from Neo4j 2025.01, when creating a database you can seed up to a specific date or transaction ID via the `seedRestoreUntil` option.
412+
When creating a database you can seed up to a specific date or transaction ID via the `seedRestoreUntil` option.
413413

414414
The `seedRestoreUntil` option is supported by the `CloudSeedProvider` and the `FileSeedProvider`.
415415

0 commit comments

Comments
 (0)