Skip to content

Commit 8692482

Browse files
Add deprecations and FileSeedProvider (#1909)
* S3SeedProvider is deprecated as of 5.26 * FileSeedProvider added in 5.26 * file: is deprecated for URLConnectionProvider as of 5.26 * Reorder providers putting S3SeedProvider last --------- Co-authored-by: NataliaIvakina <[email protected]>
1 parent 446dd2e commit 8692482

File tree

1 file changed

+58
-41
lines changed

1 file changed

+58
-41
lines changed

modules/ROOT/pages/clustering/databases.adoc

Lines changed: 58 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -467,52 +467,30 @@ neo4j@neo4j> SHOW DATABASES;
467467

468468
To determine the cause of the problem, it is recommended to look at the `debug.log`.
469469

470-
==== Seed providers
470+
[[file-seed-provider]]
471+
==== FileSeedProvider
472+
473+
label:new[Introduced in 5.26], the `FileSeedProvider` supports:
474+
475+
** `file:`
476+
477+
[[url-connection-seed-provider]]
478+
==== URLConnectionSeedProvider
471479

472480
The `URLConnectionSeedProvider` supports the following:
473481

474-
** `file:`
482+
** `file:` label:deprecated[Deprecated in 5.26]
475483
** `ftp:`
476484
** `http:`
477485
** `https:`
478486

479-
The `S3SeedProvider` supports:
480-
481-
** `s3:`
482-
483-
[NOTE]
484-
====
485-
Neo4j 5 comes bundled with necessary libraries for AWS S3 connectivity.
486-
Therefore, if you use `S3SeedProvider`,`aws cli` is not required but can be used with the `CloudSeedProvider`.
487-
====
487+
[[cloud-seed-provider]]
488+
==== CloudSeedProvider
488489

489-
The `S3SeedProvider` requires additional configuration.
490-
This is specified with the `seedConfig` option.
491-
This option expects a comma-separated list of configurations.
492-
Each configuration value is specified as a name followed by `=` and the value, as such:
490+
label:new[Introduced in 5.25], the `CloudSeedProvider` supports:
493491

494-
[source, cypher, role="noplay"]
495-
----
496-
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1' }
497-
----
498-
499-
`S3SeedProvider` also requires passing in credentials.
500-
These are specified with the `seedCredentials` option.
501-
Seed credentials are securely passed from the Cypher command to each server hosting the database.
502-
For this to work, Neo4j on each server in the cluster must be configured with identical keystores.
503-
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].
504-
If this configuration is not performed, the `seedCredentials` option fails.
505-
506-
[source, cypher, role="noplay"]
507-
----
508-
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1', seedCredentials: [accessKey];[secretKey] }
509-
----
510-
Where `accessKey` and `secretKey` are provided by AWS.
511-
512-
The `CloudSeedProvider` supports:
513-
514-
** `s3:`
515-
** `gs:`
492+
** `s3:`
493+
** `gs:`
516494
** `azb:`
517495

518496
[.tabbed-example]
@@ -558,6 +536,43 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco
558536
======
559537
=====
560538

539+
[[s3-seed-provider]]
540+
==== S3SeedProvider
541+
542+
The `S3SeedProvider` supports:
543+
544+
** `s3:` label:deprecated[Deprecated in 5.26]
545+
546+
547+
[NOTE]
548+
====
549+
Neo4j 5 comes bundled with necessary libraries for AWS S3 connectivity.
550+
Therefore, if you use `S3SeedProvider`,`aws cli` is not required but can be used with the `CloudSeedProvider`.
551+
====
552+
553+
The `S3SeedProvider` requires additional configuration.
554+
This is specified with the `seedConfig` option.
555+
This option expects a comma-separated list of configurations.
556+
Each configuration value is specified as a name followed by `=` and the value, as such:
557+
558+
[source, cypher, role="noplay"]
559+
----
560+
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1' }
561+
----
562+
563+
`S3SeedProvider` also requires passing in credentials.
564+
These are specified with the `seedCredentials` option.
565+
Seed credentials are securely passed from the Cypher command to each server hosting the database.
566+
For this to work, Neo4j on each server in the cluster must be configured with identical keystores.
567+
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].
568+
If this configuration is not performed, the `seedCredentials` option fails.
569+
570+
[source, cypher, role="noplay"]
571+
----
572+
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1', seedCredentials: [accessKey];[secretKey] }
573+
----
574+
Where `accessKey` and `secretKey` are provided by AWS.
575+
561576

562577
==== Seed provider reference
563578

@@ -568,7 +583,8 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco
568583
| URI example
569584

570585
| `file:`
571-
| `URLConnectionSeedProvider`
586+
| `URLConnectionSeedProvider` label:deprecated[Deprecated in 5.26], +
587+
`FileSeedProvider` label:new[Introduced in 5.26]
572588
| `file:/tmp/backup1.backup`
573589

574590
| `ftp:`
@@ -584,15 +600,16 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco
584600
| `\https://myhttp.com/backups/backup1.backup`
585601

586602
| `s3:`
587-
| `S3SeedProvider`, `CloudSeedProvider`
603+
| `S3SeedProvider` label:deprecated[Deprecated in 5.26], +
604+
`CloudSeedProvider` label:new[Introduced in 5.25]
588605
| `s3://mybucket/backups/backup1.backup`
589606

590607
| `gs:`
591-
| `CloudSeedProvider`
608+
| `CloudSeedProvider` label:new[Introduced in 5.25]
592609
| `gs://mybucket/backups/backup1.backup`
593610

594611
| `azb:`
595-
| `CloudSeedProvider`
612+
| `CloudSeedProvider` label:new[Introduced in 5.25]
596613
| `azb://mystorageaccount.blob/backupscontainer/backup1.backup`
597614
|===
598615

0 commit comments

Comments
 (0)