Driver (Neo4j Java Driver 5.0.0-alpha01 API)

All Superinterfaces:: AutoCloseable

public interface Driver
extends AutoCloseable

Accessor for a specific Neo4j graph database.

Driver implementations are typically thread-safe, act as a template for session creation and host a connection pool. All configuration and authentication settings are held immutably by the Driver. Should different settings be required, a new Driver instance should be created.

A driver maintains a connection pool for each remote Neo4j server. Therefore the most efficient way to make use of a Driver is to use the same instance across the application.

To construct a new Driver, use one of the GraphDatabase.driver methods. The URI passed to this method determines the type of Driver created.

Available schemes and drivers
URI Scheme	Driver
`bolt`	Direct driver: connects directly to the host and port specified in the URI.
`neo4j`	Routing driver: can automatically discover members of a Causal Cluster and route `sessions` based on `AccessMode`.

Since:: 1.0 (Modified and Added AsyncSession and RxSession since 2.0)

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`AsyncSession`	`asyncSession()` Create a new general purpose `AsyncSession` with default `session configuration`.
`AsyncSession`	`asyncSession(SessionConfig sessionConfig)` Create a new `AsyncSession` with a specified `session configuration`.
`void`	`close()` Close all the resources assigned to this driver, including open connections and IO threads.
`CompletionStage<Void>`	`closeAsync()` Close all the resources assigned to this driver, including open connections and IO threads.
`TypeSystem`	`defaultTypeSystem()` This will return the type system supported by the driver.
`boolean`	`isEncrypted()` Return a flag to indicate whether or not encryption is used for this driver.
`boolean`	`isMetricsEnabled()` Returns true if the driver metrics reporting is enabled via `Config.ConfigBuilder.withDriverMetrics()`, otherwise false.
`Metrics`	`metrics()` Returns the driver metrics if metrics reporting is enabled via `Config.ConfigBuilder.withDriverMetrics()`.
`default ReactiveSession`	`reactiveSession()` Create a new general purpose `ReactiveSession` with default `session configuration`.
`ReactiveSession`	`reactiveSession(SessionConfig sessionConfig)` Create a new `ReactiveSession` with a specified `session configuration`.
`default RxSession`	`rxSession()` Deprecated. superseded by `reactiveSession()`.
`RxSession`	`rxSession(SessionConfig sessionConfig)` Deprecated. superseded by `reactiveSession(SessionConfig)`.
`Session`	`session()` Create a new general purpose `Session` with default `session configuration`.
`Session`	`session(SessionConfig sessionConfig)` Create a new `Session` with a specified `session configuration`.
`boolean`	`supportsMultiDb()` Returns true if the server or cluster the driver connects to supports multi-databases, otherwise false.
`CompletionStage<Boolean>`	`supportsMultiDbAsync()` Asynchronous check if the server or cluster the driver connects to supports multi-databases.
`void`	`verifyConnectivity()` This verifies if the driver can connect to a remote server or a cluster by establishing a network connection with the remote and possibly exchanging a few data before closing the connection.
`CompletionStage<Void>`	`verifyConnectivityAsync()` This verifies if the driver can connect to a remote server or cluster by establishing a network connection with the remote and possibly exchanging a few data before closing the connection.

- Method Detail
  - isEncrypted
```
boolean isEncrypted()
```
    Return a flag to indicate whether or not encryption is used for this driver.
    
    Returns:
    
    true if the driver requires encryption, false otherwise
  - session
```
Session session()
```
    Create a new general purpose Session with default session configuration.
    Alias to session(SessionConfig)}.
    
    Returns:
    
    a new Session object.
  - session
```
Session session(SessionConfig sessionConfig)
```
    Create a new Session with a specified session configuration. Use SessionConfig.forDatabase(String) to obtain a general purpose session configuration for the specified database.
    
    Parameters:
    
    sessionConfig - specifies session configurations for this session.
    
    Returns:
    
    a new Session object.
    
    See Also:
    
    SessionConfig
  - rxSession
```
@Deprecated
default RxSession rxSession()
```
    Deprecated. superseded by reactiveSession().
    
    Create a new general purpose RxSession with default session configuration. The RxSession provides a reactive way to run queries and process results.
    Alias to rxSession(SessionConfig)}.
    
    Returns:
    
    a new RxSession object.
  - rxSession
```
@Deprecated
RxSession rxSession(SessionConfig sessionConfig)
```
    Deprecated. superseded by reactiveSession(SessionConfig).
    
    Create a new RxSession with a specified session configuration. Use SessionConfig.forDatabase(String) to obtain a general purpose session configuration for the specified database. The RxSession provides a reactive way to run queries and process results.
    
    Parameters:
    
    sessionConfig - used to customize the session.
    
    Returns:
    
    a new RxSession object.
  - reactiveSession
```
default ReactiveSession reactiveSession()
```
    Create a new general purpose ReactiveSession with default session configuration. The ReactiveSession provides a reactive way to run queries and process results.
    Alias to rxSession(SessionConfig)}.
    
    Returns:
    
    a new ReactiveSession object.
  - reactiveSession
```
ReactiveSession reactiveSession(SessionConfig sessionConfig)
```
    Create a new ReactiveSession with a specified session configuration. Use SessionConfig.forDatabase(String) to obtain a general purpose session configuration for the specified database. The ReactiveSession provides a reactive way to run queries and process results.
    
    Parameters:
    
    sessionConfig - used to customize the session.
    
    Returns:
    
    a new ReactiveSession object.
  - asyncSession
```
AsyncSession asyncSession()
```
    Create a new general purpose AsyncSession with default session configuration. The AsyncSession provides an asynchronous way to run queries and process results.
    Alias to asyncSession(SessionConfig)}.
    
    Returns:
    
    a new AsyncSession object.
  - asyncSession
```
AsyncSession asyncSession(SessionConfig sessionConfig)
```
    Create a new AsyncSession with a specified session configuration. Use SessionConfig.forDatabase(String) to obtain a general purpose session configuration for the specified database. The AsyncSession provides an asynchronous way to run queries and process results.
    
    Parameters:
    
    sessionConfig - used to customize the session.
    
    Returns:
    
    a new AsyncSession object.
  - close
```
void close()
```
    Close all the resources assigned to this driver, including open connections and IO threads.
    This operation works the same way as closeAsync() but blocks until all resources are closed.
    
    Specified by:
    
    close in interface AutoCloseable
  - closeAsync
```
CompletionStage<Void> closeAsync()
```
    Close all the resources assigned to this driver, including open connections and IO threads.
    This operation is asynchronous and returns a CompletionStage. This stage is completed with null when all resources are closed. It is completed exceptionally if termination fails.
    
    Returns:
    
    a completion stage that represents the asynchronous close.
  - metrics
```
Metrics metrics()
```
    Returns the driver metrics if metrics reporting is enabled via Config.ConfigBuilder.withDriverMetrics(). Otherwise, a ClientException will be thrown.
    
    Returns:
    
    the driver metrics if enabled.
    
    Throws:
    
    ClientException - if the driver metrics reporting is not enabled.
  - isMetricsEnabled
```
boolean isMetricsEnabled()
```
    Returns true if the driver metrics reporting is enabled via Config.ConfigBuilder.withDriverMetrics(), otherwise false.
    
    Returns:
    
    true if the metrics reporting is enabled.
  - defaultTypeSystem
```
@Experimental
TypeSystem defaultTypeSystem()
```
    This will return the type system supported by the driver. The types supported on a particular server a session is connected against might not contain all of the types defined here.
    
    Returns:
    
    type system used by this query runner for classifying values
  - verifyConnectivity
```
void verifyConnectivity()
```
    This verifies if the driver can connect to a remote server or a cluster by establishing a network connection with the remote and possibly exchanging a few data before closing the connection. It throws exception if fails to connect. Use the exception to further understand the cause of the connectivity problem. Note: Even if this method throws an exception, the driver still need to be closed via close() to free up all resources.
  - verifyConnectivityAsync
```
CompletionStage<Void> verifyConnectivityAsync()
```
    This verifies if the driver can connect to a remote server or cluster by establishing a network connection with the remote and possibly exchanging a few data before closing the connection. This operation is asynchronous and returns a CompletionStage. This stage is completed with null when the driver connects to the remote server or cluster successfully. It is completed exceptionally if the driver failed to connect the remote server or cluster. This exception can be used to further understand the cause of the connectivity problem. Note: Even if this method complete exceptionally, the driver still need to be closed via closeAsync() to free up all resources.
    
    Returns:
    
    a completion stage that represents the asynchronous verification.
  - supportsMultiDb
```
boolean supportsMultiDb()
```
    Returns true if the server or cluster the driver connects to supports multi-databases, otherwise false.
    
    Returns:
    
    true if the server or cluster the driver connects to supports multi-databases, otherwise false.
  - supportsMultiDbAsync
```
CompletionStage<Boolean> supportsMultiDbAsync()
```
    Asynchronous check if the server or cluster the driver connects to supports multi-databases.
    
    Returns:
    
    a completion stage that returns true if the server or cluster the driver connects to supports multi-databases, otherwise false.

Interface Driver

Method Summary

Method Detail

isEncrypted

session

session

rxSession

rxSession

reactiveSession

reactiveSession

asyncSession

asyncSession

close

closeAsync

metrics

isMetricsEnabled

defaultTypeSystem

verifyConnectivity

verifyConnectivityAsync

supportsMultiDb

supportsMultiDbAsync