Skip to content

Remove SeedProvider #232

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
NataliaIvakina merged 1 commit into from
Dec 12, 2024
Merged

Remove SeedProvider #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 0 additions & 42 deletions modules/ROOT/pages/extending-neo4j/project-setup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,11 +156,8 @@ Include this dependency to build against the Neo4j-provided API:

=== Implement Java class

[role=label--new-5.26]
==== `DatabaseSeedProvider`

In Neo4j 5.26, the `DatabaseSeedProvider` was introduced to replace the now-deprecated `SeedProvider`.

[source, java]
----
import com.neo4j.dbms.seeding.DatabaseSeedProvider;
Expand Down Expand Up @@ -212,45 +209,6 @@ The stream method should implement a scheme-specific way to obtain an input stre

Implementation-specific seed configuration can be passed through from options specified in the `CREATE DATABASE` command using `seedConfig`.

[role=label--deprecated-5.26]
==== `SeedProvider`

[source, java]
----
import com.neo4j.dbms.seeding.ParsedSeedProviderConfig;
import com.neo4j.dbms.seeding.SeedProvider;

public class CustomSeedProvider extends SeedProvider {

public boolean matches(String uri) {
// return true if uri is supported by this
// provider
}

public Path download(
String uri,
Optional<String> credentials,
Optional<String> config,
Path destinationFolder ) throws Exception {
// This method should obtain the downloaded in an
// implementation specific way and copy it to a
// file within the destinationFolder directory.
}
}
----

To implement the custom seed provider, you must implement two methods.
One method to match the URIs it can manage and one to download backups or dumps from the given URI.

Typically, the match method uses the URI scheme (the part specified before the first colon) to determine whether it can support the given URI or not.
For example, `file`, `http`, `https` etc.

The download method should implement a scheme-specific way to obtain the backup or dump and place it into a file in the supplied destination folder.
It should then return the path of the created file.

Both credentials and configurations are passed through from options specified in the `CREATE DATABASE` command.
`ParsedSeedProviderConfig` provides a convenient way to parse and access the comma-separated configuration string.

=== Deploy

Build a jar file from Maven and place this onto the Neo4j classpath.
Expand Down
Loading