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 class	ReactiveNeo4jClient.Builder A builder for reactive Neo4j clients.
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.RunnableSpecBoundToDatabase Contract for a runnable query inside a dedicated database.
static interface	ReactiveNeo4jClient.RunnableSpecBoundToDatabaseAndUser Combination of Neo4jClient.RunnableSpecBoundToDatabase and Neo4jClient.RunnableSpecBoundToUser, can't be bound any further.
static interface	ReactiveNeo4jClient.RunnableSpecBoundToUser Contract for a runnable query bound to a user to be impersonated.
static interface	ReactiveNeo4jClient.UnboundRunnableSpec Contract for a runnable query specification which still can be bound to a specific database and an impersonated user.

Field Summary

Fields

Modifier and Type	Field and Description
static LogAccessor	cypherLog
static LogAccessor	log

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.
default reactor.core.publisher.Mono<org.neo4j.driver.reactive.RxQueryRunner>	getQueryRunner()
default reactor.core.publisher.Mono<org.neo4j.driver.reactive.RxQueryRunner>	getQueryRunner(reactor.core.publisher.Mono<DatabaseSelection> databaseSelection)
reactor.core.publisher.Mono<org.neo4j.driver.reactive.RxQueryRunner>	getQueryRunner(reactor.core.publisher.Mono<DatabaseSelection> databaseSelection, reactor.core.publisher.Mono<UserSelection> userSelection) Retrieves a query runner that will participate in ongoing Spring transactions (either in declarative (implicit via @Transactional) or in programmatically (explicit via transaction template) ones).
ReactiveNeo4jClient.UnboundRunnableSpec	query(String cypher) Entrypoint for creating a new Cypher query.
ReactiveNeo4jClient.UnboundRunnableSpec	query(Supplier<String> cypherSupplier) Entrypoint for creating a new Cypher query based on a supplier.
static ReactiveNeo4jClient.Builder	with(org.neo4j.driver.Driver driver)

Field Detail

cypherLog

static final LogAccessor cypherLog

log

static final LogAccessor log

Method Detail

create

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

create

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

with

static ReactiveNeo4jClient.Builder with(org.neo4j.driver.Driver driver)

getQueryRunner

default reactor.core.publisher.Mono<org.neo4j.driver.reactive.RxQueryRunner> getQueryRunner()

Returns:

A managed query runner

Since:

6.2

See Also:

getQueryRunner(Mono)

getQueryRunner

default reactor.core.publisher.Mono<org.neo4j.driver.reactive.RxQueryRunner> getQueryRunner(reactor.core.publisher.Mono<DatabaseSelection> databaseSelection)

Returns:

A managed query runner

Since:

6.2

See Also:

getQueryRunner(Mono, Mono)

getQueryRunner

reactor.core.publisher.Mono<org.neo4j.driver.reactive.RxQueryRunner> getQueryRunner(reactor.core.publisher.Mono<DatabaseSelection> databaseSelection,
                                                                                    reactor.core.publisher.Mono<UserSelection> userSelection)

Retrieves a query runner that will participate in ongoing Spring transactions (either in declarative (implicit via @Transactional) or in programmatically (explicit via transaction template) ones). This runner can be used with the Cypher-DSL for example. If the client cannot retrieve an ongoing Spring transaction, this runner will use auto-commit semantics.

Parameters:

databaseSelection - The target database.

userSelection - The user selection

Returns:

A managed query runner

Since:

6.2

query

ReactiveNeo4jClient.UnboundRunnableSpec 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.UnboundRunnableSpec 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

@Nullable
ReactiveDatabaseSelectionProvider getDatabaseSelectionProvider()

Returns the assigned database selection provider.

Returns:

The database selection provider - can be null