org.neo4j.ogm.driver

Interface Driver

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractConfigurableDriver

public interface Driver
extends AutoCloseable

Author:

Vince Bickers, Mark Angrish, Michael J. Simons

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure(Configuration config)
Configuration	getConfiguration()
default Function<String,String>	getCypherModification()
default Function<TransactionManager,BiFunction<Transaction.Type,Iterable<String>,Transaction>>	getTransactionFactorySupplier()
default Transaction	newTransaction(Transaction.Type type, Iterable<String> bookmarks) Deprecated. Since 3.1.8 as it was faulty. Will be removed in 3.2
default Request	request() Deprecated. Since 3.1.8 as it was faulty. Will be removed in 3.2
Request	request(Transaction transaction)
default boolean	requiresTransaction() Indicates if the driver requires an explicit transaction to run queries.
default void	setTransactionManager(TransactionManager tx) Deprecated. Since 3.1.8 as it was faulty. Will be removed in 3.2

Method Detail

configure

void configure(Configuration config)

newTransaction

@Deprecated
default Transaction newTransaction(Transaction.Type type,
                                               Iterable<String> bookmarks)

Deprecated. Since 3.1.8 as it was faulty. Will be removed in 3.2

Begins new transaction

Parameters:

type - type of the transaction, see Transaction.Type

bookmarks - bookmarks to pass to the driver when transaction is started, NOTE: currently supported only by bolt driver

Returns:

new transaction

getTransactionFactorySupplier

default Function<TransactionManager,BiFunction<Transaction.Type,Iterable<String>,Transaction>> getTransactionFactorySupplier()

Returns:

A factory method for creating suppliers of transactions for a given transaction manager

close

void close()

Specified by:

close in interface AutoCloseable

request

@Deprecated
default Request request()

Deprecated. Since 3.1.8 as it was faulty. Will be removed in 3.2

Returns:

A new request handler

request

Request request(Transaction transaction)

Parameters:

transaction - Current transaction, may be null, depending on the driver

Returns:

A new request handler

setTransactionManager

@Deprecated
default void setTransactionManager(TransactionManager tx)

Deprecated. Since 3.1.8 as it was faulty. Will be removed in 3.2

Parameters:

tx - new transaction manager

getConfiguration

Configuration getConfiguration()

getCypherModification

default Function<String,String> getCypherModification()

requiresTransaction

default boolean requiresTransaction()

Indicates if the driver requires an explicit transaction to run queries. Used to know if transactions has to be explicitly triggered by OGM before accessing DB.

Returns:

true if client code has to setup a transaction, false if the driver can auto-commit.