Skip to content

Deprecate existingDataSeedInstance option to CREATE DATABASE #1821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 9, 2024
Merged

Deprecate existingDataSeedInstance option to CREATE DATABASE #1821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d2bfc7
Deprecate `existingDataSeedInstance` option to CREATE DATABASE
mnd999 Sep 19, 2024
0bf64ac
Review comment
mnd999 Sep 20, 2024
48ed22f
Update modules/ROOT/pages/database-administration/standard-databases/…
renetapopova Oct 9, 2024
0f66518
Update modules/ROOT/pages/database-administration/standard-databases/…
renetapopova Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/ROOT/pages/clustering/databases.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ See <<#_create_database, `CREATE DATABASE`>> for more information.
----
CREATE DATABASE foo
TOPOLOGY [desired number of primaries] PRIMARIES [desired number of secondaries] SECONDARIES
OPTIONS {existingData: 'use', existingDataSeedInstance: '8512c9b9-d9e8-48e6-b037-b15b0004ca18'};
OPTIONS {existingData: 'use', existingDataSeedServer: '8512c9b9-d9e8-48e6-b037-b15b0004ca18'};
----
. Verify that the `foo` database is online on the desired number of servers, in the desired roles.
If the `foo` database is of considerable size, the execution of the command can take some time.
Expand Down
16 changes: 10 additions & 6 deletions ...les/ROOT/pages/database-administration/standard-databases/create-databases.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ In versions previous to Neo4j 5.22, the default store format for all new databas
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. +
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. +
Alternatively, you can set the store format of new databases using the `CREATE DATABASE databasename OPTIONS {storeFormat: 'the-new-format'}` command.
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.
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.

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

Expand Down Expand Up @@ -76,13 +76,17 @@ The `CREATE DATABASE` command can have a map of options, e.g. `OPTIONS {key: 'va
| `use`
|
Controls how the system handles existing data on disk when creating the database.
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.
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can not make a comment above. But we should mention existingDataSeedServer on row 34 as well.


| `existingDataSeedInstance`

|`existingDataSeedServer` label:new[new in 5.25]

`existingDataSeedInstance` label:deprecated[deprecated in 5.25]
| ID of the cluster server
|
Defines which server is used for seeding the data of the created database.
The server ID can be found in the `serverId` column after running `SHOW SERVERS`.
The server ID can be found in the `serverId` column after running `SHOW SERVERS`.
`existingDataSeedInstance` is replaced by `existingDataSeedServer` in Neo4j 5.25.

| `seedURI`
| URI to a backup or a dump from an existing database.
Expand Down Expand Up @@ -110,12 +114,12 @@ For details about enrichment mode, see link:{neo4j-docs-base-uri}/cdc/current/ge
| `aligned` \| `standard` \| `high_limit` \| `block`
|
Defines the store format if the database created is new.
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.
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.
|===

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

Expand Down