Skip to content

Release 5.26 #237

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.

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 22 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
38ac262
bump dev to 5.21 (#205)
AlexicaWright May 27, 2024
175f8f4
Replacing underscores with hyphens for crawlability (#206)
lidiazuin Jun 10, 2024
2fb4d8d
Bump Neo4j version to 5.22 and driver v to 5.23 (#208)
NataliaIvakina Jun 28, 2024
be4952b
Update `dev` to 5.23 (#213)
NataliaIvakina Jul 23, 2024
c8d6fb5
Bump version number to 5.24 (#215)
NataliaIvakina Aug 22, 2024
936bfd4
Update preview version to 5.25 (#220)
renetapopova Sep 26, 2024
0394a3c
Add documentation for user procedure memory resource tracking
loveleif Oct 31, 2024
7c2a7bb
Bump the Neo4j v.n. to 5.25 and the Java driver to 5.26.1 (#227)
NataliaIvakina Oct 31, 2024
4c1c204
Bump express in the dev-dependencies group across 1 directory (#224)
dependabot[bot] Oct 31, 2024
b2b8156
Fix the code example (#228)
NataliaIvakina Nov 5, 2024
3ff4731
Update setup.adoc (#222) (#230)
renetapopova Nov 6, 2024
9b43a10
Introduce DatabaseSeedProvider and deprecated SeedProvider
jackwaudby Nov 11, 2024
bd78e32
Update modules/ROOT/pages/extending-neo4j/project-setup.adoc
jackwaudby Nov 13, 2024
ba31564
Update modules/ROOT/pages/extending-neo4j/project-setup.adoc
jackwaudby Nov 13, 2024
e989cd2
Update modules/ROOT/pages/extending-neo4j/project-setup.adoc
jackwaudby Nov 13, 2024
e0c55a4
Update modules/ROOT/pages/extending-neo4j/project-setup.adoc
jackwaudby Nov 13, 2024
1c1f7da
Update modules/ROOT/pages/extending-neo4j/project-setup.adoc
jackwaudby Nov 13, 2024
c471558
Update modules/ROOT/pages/extending-neo4j/project-setup.adoc
jackwaudby Nov 13, 2024
87a9691
Update modules/ROOT/pages/extending-neo4j/project-setup.adoc
jackwaudby Nov 13, 2024
f7acfc5
Merge pull request #231 from neo4j/5-database-seed-provider
jackwaudby Nov 13, 2024
72a66e7
Update driver version (#234)
NataliaIvakina Nov 22, 2024
a9d8168
Merge branch 'dev' into 5.x-release-5.26
NataliaIvakina Dec 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
8 changes: 4 additions & 4 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ nav:
- modules/ROOT/content-nav.adoc
asciidoc:
attributes:
neo4j-version: '5.25'
neo4j-version-exact: '5.25.1'
neo4j-buildnumber: '5.25'
java-driver-version: '5.26.3'
neo4j-version: '5.26'
neo4j-version-exact: '5.26.0'
neo4j-buildnumber: '5.26'
java-driver-version: '5.27.0'
neo4j-documentation-branch: 'dev'
page-origin-private: false
neo4j-javadocs-base-uri: "https://neo4j.com/docs/java-reference/5/javadocs"
59 changes: 59 additions & 0 deletions modules/ROOT/pages/extending-neo4j/project-setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,65 @@ 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;

public class CustomDatabaseSeedProvider implements DatabaseSeedProvider {

@Override
public boolean matches(String uri) {
// Return true if uri is supported by this
// provider.
}

@Override
public InputStream stream(
String uri,
Map<String, Object> options) throws IOException {
// This method should obtain an input stream in an
// implementation specific way.
}

@Override
public void inject(Dependencies dependencies) {
// This method should provide implementation
// specific dependencies to the provider.
}

public static class CustomDependencies implements Dependencies {
@Override
public <T> T resolveDependency(Class<T> type) {
// This method should resolve dependencies
// required by the provider.
}
}
}
----

To implement the custom database seed provider, you must define three methods on the top-level `DatabaseSeedProvider` interface:

* A method to match the URIs that the provider can manage.
* A method to stream backups or dumps from a specified URI.
* A method to inject dependencies in the provider.

Additionally, you must implement a method on the nested `Dependencies` interface to resolve any dependencies required by your seed provider implementation.

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 stream method should implement a scheme-specific way to obtain an input stream for the backup or dump.

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;
Expand Down
Loading
Loading