Skip to content
Merged
Changes from all commits
Commits
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
41 changes: 35 additions & 6 deletions modules/ROOT/pages/clustering/databases.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ SHOW DATABASE foo;
=== Seed from URI

This method seeds all servers with an identical seed from an external source, specified by the URI.
The seed can either be a full backup, a differential backup (xref:clustering/databases.adoc#cloud-seed-provider[`CloudSeedProvider`] or a dump from an existing database.
The seed can either be a full backup, a differential backup (see xref:clustering/databases.adoc#cloud-seed-provider[`CloudSeedProvider`]), or a dump from an existing database.
The sources of seeds are called _seed providers_.

The mechanism is pluggable, allowing new sources of seeds to be supported (see link:https://www.neo4j.com/docs/java-reference/current/extending-neo4j/project-setup/#extending-neo4j-plugin-seed-provider[Java Reference -> Implement custom seed providers] for more information).
Expand Down Expand Up @@ -514,11 +514,13 @@ The `FileSeedProvider` supports:

The `URLConnectionSeedProvider` supports the following:

** `file:` label:deprecated[Deprecated in 5.26]
** `ftp:`
** `http:`
** `https:`

Starting from Neo4j 2025.01, the `URLConnectionSeedProvider` does not support `file`.
// This is true for both Cypher 5 and Cypher 25.

[[cloud-seed-provider]]
==== CloudSeedProvider

Expand Down Expand Up @@ -574,9 +576,39 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco
======
=====

Starting from Neo4j 2025.01, the `CloudSeedProvider` supports seeding up to a specific date or transaction ID using the `seedRestoreUntil` option.

[role=label--new-2025.01]
===== Seed up to a specific date

To seed up to a specific date, you need to pass the differential backup, which contains the data up to that date.


[source,shell]
----
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedRestoreUntil: datetime("2019-06-01T18:40:32.142+0100") }
----

This will seed the database with transactions committed before the provided timestamp.

[role=label--new-2025.01]
===== Seed up to a specific transaction ID

To seed up to a specific transaction ID, you need to pass the differential backup that contains the data up to that transaction ID.

[source,shell]
----
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedRestoreUntil: 123 }
----

This will seed the database with transactions up to, but not including transaction 123.

[role=label--deprecated]
[[s3-seed-provider]]
==== S3SeedProvider

// When Cypher 25 is released, we have to label this section 'Cypher 5' as this functionality is only available in Cypher 5.

The `S3SeedProvider` supports:

** `s3:` label:deprecated[Deprecated in 5.26]
Expand Down Expand Up @@ -610,8 +642,6 @@ If this configuration is not performed, the `seedCredentials` option fails.
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1', seedCredentials: [accessKey];[secretKey] }
----
Where `accessKey` and `secretKey` are provided by AWS.


==== Seed provider reference

[cols="1,2,2",options="header"]
Expand All @@ -621,8 +651,7 @@ Where `accessKey` and `secretKey` are provided by AWS.
| URI example

| `file:`
| `URLConnectionSeedProvider` label:deprecated[Deprecated in 5.26], +
`FileSeedProvider`
| `FileSeedProvider`
| `file:/tmp/backup1.backup`

| `ftp:`
Expand Down
Loading