org.springframework.data.neo4j.core

Interface ReactiveNeo4jClient

@API(status=STABLE,
     since="6.0")
public interface ReactiveNeo4jClient

Reactive Neo4j client. The main difference to the imperative Neo4j client is the fact that all operations will only be executed once something subscribes to the reactive sequence defined.

Since:

6.0

Author:

Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ReactiveNeo4jClient.MappingSpec<T>
static interface	ReactiveNeo4jClient.OngoingDelegation<T> A contract for an ongoing delegation in the selected database.
static interface	ReactiveNeo4jClient.RecordFetchSpec<T>
static interface	ReactiveNeo4jClient.RunnableDelegation<T> A runnable delegation.
static interface	ReactiveNeo4jClient.RunnableSpec Contract for a runnable query that can be either run returning its result, run without results or be parameterized.
static interface	ReactiveNeo4jClient.RunnableSpecTightToDatabase Contract for a runnable query inside a dedicated database.

Field Summary

Fields

Modifier and Type	Field and Description
static LogAccessor	cypherLog

Method Summary

Modifier and Type	Method and Description
static ReactiveNeo4jClient	create(org.neo4j.driver.Driver driver)
static ReactiveNeo4jClient	create(org.neo4j.driver.Driver driver, ReactiveDatabaseSelectionProvider databaseSelectionProvider)
<T> ReactiveNeo4jClient.OngoingDelegation<T>	delegateTo(Function<org.neo4j.driver.reactive.RxQueryRunner,reactor.core.publisher.Mono<T>> callback) Delegates interaction with the default database to the given callback.
ReactiveDatabaseSelectionProvider	getDatabaseSelectionProvider() Returns the assigned database selection provider.
ReactiveNeo4jClient.RunnableSpec	query(String cypher) Entrypoint for creating a new Cypher query.
ReactiveNeo4jClient.RunnableSpec	query(Supplier<String> cypherSupplier) Entrypoint for creating a new Cypher query based on a supplier.

Field Detail

cypherLog

static final LogAccessor cypherLog

Method Detail

create

static ReactiveNeo4jClient create(org.neo4j.driver.Driver driver)

create

static ReactiveNeo4jClient create(org.neo4j.driver.Driver driver,
                                  ReactiveDatabaseSelectionProvider databaseSelectionProvider)

query

ReactiveNeo4jClient.RunnableSpec query(String cypher)

Entrypoint for creating a new Cypher query. Doesn't matter at this point whether it's a match, merge, create or removal of things.

Parameters:

cypher - The cypher code that shall be executed

Returns:

A new CypherSpec

query

ReactiveNeo4jClient.RunnableSpec query(Supplier<String> cypherSupplier)

Entrypoint for creating a new Cypher query based on a supplier. Doesn't matter at this point whether it's a match, merge, create or removal of things. The supplier can be an arbitrary Supplier that may provide a DSL for generating the Cypher statement.

Parameters:

cypherSupplier - A supplier of arbitrary Cypher code

Returns:

A runnable query specification.

delegateTo

<T> ReactiveNeo4jClient.OngoingDelegation<T> delegateTo(Function<org.neo4j.driver.reactive.RxQueryRunner,reactor.core.publisher.Mono<T>> callback)

Delegates interaction with the default database to the given callback.

Type Parameters:

T - The type of the result being produced

Parameters:

callback - A function receiving a reactive statement runner for database interaction that can optionally return a publisher with none or exactly one element

Returns:

A single publisher containing none or exactly one element that will be produced by the callback

getDatabaseSelectionProvider

ReactiveDatabaseSelectionProvider getDatabaseSelectionProvider()

Returns the assigned database selection provider.

Returns:

The database selection provider - can be null