Skip to content

Commit

Permalink
Deprecate seedConfig, and seedCredentials (#1925)
Browse files Browse the repository at this point in the history
Also add a note about deprecated store formats

We may need to add some more details about the deprecations once
clustering get to look at it.

Depends on: #1909

---------

Co-authored-by: Reneta Popova <[email protected]>
  • Loading branch information
mnd999 and renetapopova authored Nov 1, 2024
1 parent f07e88b commit 8dbf241
Showing 1 changed file with 9 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,19 @@ The server ID can be found in the `serverId` column after running `SHOW SERVERS`
|
Defines an identical seed from an external source which will be used to seed all servers.

| `seedConfig`
| `seedConfig` label:deprecated[Deprecated in 5.26]
| Comma-separated list of configuration values.
|
Defines additional configuration specified by comma-separated `name=value` pairs that might be required by certain seed providers.
From 5.26, it is recommended to use the `CloudSeedProvider` seed provider, which does not require this configuration when seeding from cloud storage.
For more information see xref::clustering/databases.adoc#cloud-seed-provider[CloudSeedProvider].

| `seedCredentials`
| `seedCredentials` label:deprecated[Deprecated in 5.26]
| credentials
|
Defines credentials that need to be passed into certain seed providers.
From 5.26, it is recommended to use the `CloudSeedProvider` seed provider, which does not require this configuration when seeding from cloud storage.
For more information see xref::clustering/databases.adoc#cloud-seed-provider[CloudSeedProvider].

| `txLogEnrichment`
| `FULL` \| `DIFF` \| `OFF`
Expand All @@ -114,6 +118,9 @@ 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.
`high_limit` and `standard` formats are deprecated from 5.23.
For more information on store formats, see xref::database-internals/store-formats.adoc[Store formats].

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.
|===

Expand Down

0 comments on commit 8dbf241

Please sign in to comment.