Skip to content

Commit 6c22c13

Browse files
mnd999renetapopova
andauthored
Deprecate existingDataSeedInstance option to CREATE DATABASE (#1821)
Replace with new option `existingDataSeedServer` Documenting neo-technology/neo4j#27123 --------- Co-authored-by: Reneta Popova <[email protected]>
1 parent 8da3572 commit 6c22c13

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

modules/ROOT/pages/clustering/databases.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ See <<#_create_database, `CREATE DATABASE`>> for more information.
407407
----
408408
CREATE DATABASE foo
409409
TOPOLOGY [desired number of primaries] PRIMARIES [desired number of secondaries] SECONDARIES
410-
OPTIONS {existingData: 'use', existingDataSeedInstance: '8512c9b9-d9e8-48e6-b037-b15b0004ca18'};
410+
OPTIONS {existingData: 'use', existingDataSeedServer: '8512c9b9-d9e8-48e6-b037-b15b0004ca18'};
411411
----
412412
. Verify that the `foo` database is online on the desired number of servers, in the desired roles.
413413
If the `foo` database is of considerable size, the execution of the command can take some time.

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In versions previous to Neo4j 5.22, the default store format for all new databas
3131
From Neo4j 5.22, `block` is the default format for all newly-created databases as long as they do not have the xref:configuration/configuration-settings.adoc#config_db.format[`db.format`] setting specified. +
3232
If you want to change it, you can set a new value for the xref:configuration/configuration-settings.adoc#config_db.format[`db.format`] configuration in the _neo4j.conf_ file. +
3333
Alternatively, you can set the store format of new databases using the `CREATE DATABASE databasename OPTIONS {storeFormat: 'the-new-format'}` command.
34-
However, if the store is seeded with `seedURI` or `existingDataSeedInstance`, or if the command is being used to mount pre-existing store files already present on the disk, they will use their current store format without any alterations.
34+
However, if the store is seeded with `seedURI`, `existingDataSeedServer` or `existingDataSeedInstance`, or if the command is being used to mount pre-existing store files already present on the disk, they will use their current store format without any alterations.
3535

3636
See xref:database-internals/store-formats.adoc[Store formats], for more details about available database store formats in Neo4j.
3737

@@ -76,13 +76,17 @@ The `CREATE DATABASE` command can have a map of options, e.g. `OPTIONS {key: 'va
7676
| `use`
7777
|
7878
Controls how the system handles existing data on disk when creating the database.
79-
Currently, this is only supported with `existingDataSeedInstance` and `seedURI`, and must be set to `use`, which indicates the existing data files should be used for the new database.
79+
Currently, this is only supported with `existingDataSeedInstance`, `existingDataSeedServer` and `seedURI`, and must be set to `use`, which indicates the existing data files should be used for the new database.
8080

81-
| `existingDataSeedInstance`
81+
82+
|`existingDataSeedServer` label:new[new in 5.25]
83+
84+
`existingDataSeedInstance` label:deprecated[deprecated in 5.25]
8285
| ID of the cluster server
8386
|
8487
Defines which server is used for seeding the data of the created database.
85-
The server ID can be found in the `serverId` column after running `SHOW SERVERS`.
88+
The server ID can be found in the `serverId` column after running `SHOW SERVERS`.
89+
`existingDataSeedInstance` is replaced by `existingDataSeedServer` in Neo4j 5.25.
8690

8791
| `seedURI`
8892
| URI to a backup or a dump from an existing database.
@@ -110,12 +114,12 @@ For details about enrichment mode, see link:{neo4j-docs-base-uri}/cdc/current/ge
110114
| `aligned` \| `standard` \| `high_limit` \| `block`
111115
|
112116
Defines the store format if the database created is new.
113-
If the store is seeded with `seedURI` or `existingDataSeedInstance`, or if the command is being used to mount pre-existing store files already present on the disk, they will use their current store format without any alterations.
117+
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.
114118
|===
115119

116120
[NOTE]
117121
====
118-
The `existingData`, `existingDataSeedInstance`, `seedURI`, `seedConfig`, and `seedCredentials` options cannot be combined with the `OR REPLACE` part of this command.
122+
The `existingData`, `existingDataSeedInstance`, `existingDataSeedServer`, `seedURI`, `seedConfig`, and `seedCredentials` options cannot be combined with the `OR REPLACE` part of this command.
119123
More details about seeding options can be found in xref::clustering/databases.adoc#cluster-seed[Seed a cluster].
120124
====
121125

0 commit comments

Comments
 (0)