All Classes and Interfaces
Class
Description
Used by Routing Driver to decide if a transaction should be routed to a write server or a read server in a cluster.
Asynchronous interface for components that can execute Neo4j queries.
Used by Bolt V1, V2, V3
Provides a context of work for database interactions.
Logical container for an atomic unit of work.
Callback that executes operations against a given
AsyncTransactionContext.A context for running queries within transaction.
Deprecated.
Failed to authenticate the driver to the server due to bad credentials provided.
The authorization info maintained on the server has expired.
Listener for authorization info state maintained on the server side.
Token for holding authentication details, such as user name and password.
A container used by the expiration based
AuthTokenManager implementation provided by the driver, it contains an
AuthToken and its UTC expiration timestamp.A manager of
AuthToken instances used by the driver.The
AuthTokenManager execution has lead to an unexpected result.Implementations of
AuthTokenManager.This is a listing of the various methods of authentication supported by this
driver.
Built on top of
BasicPullResponseHandler to be able to pull in batches.A base interface for sessions, used by
Driver.session(Class) and Driver.session(Class, SessionConfig).Provides basic handling of pull responses from sever.
Bolt V4.2 is identical to V4.1
Definition of the Bolt Protocol 4.3
Definition of the Bolt Protocol 4.4
Causal chaining is carried out by passing bookmarks between transactions.
Keeps track of bookmarks and is used by the driver to ensure causal consistency between sessions and query executions.
Bookmark configuration used to configure bookmark manager supplied by
BookmarkManagers.defaultManager(BookmarkManagerConfig).Builder used to configure
BookmarkManagerConfig which will be used to create a bookmark manager.Setups new instances of
BookmarkManager.A tool used to save, load certs, etc.
Dedicated logger for channel error logging.
An opaque container for client certificate used for mTLS.
A manager of
ClientCertificate instances used by the driver for mTLS.Implementations of
ClientCertificateManager.Creates new instances of
ClientCertificate.A ClientException indicates that the client has carried out an operation incorrectly.
A configuration class to config driver properties.
Used to build new config instances
Control how the driver determines if it can trust the encryption certificates provided by the Neo4j instance it is connected to.
The trust strategy that the driver supports
Describes what kind of connection to return by
ConnectionProviderProvides connection pool metrics such as connection created, current in use etc.
Interface defines a layer used by the driver to obtain connections.
Indicates that read timed out due to it taking longer than the server-supplied timeout value via the
connection.recv_timeout_seconds configuration
hint.Handler needed to limit amount of time connection performs TLS and Bolt handshakes.
Internal implementation of the console logging.
A DatabaseException indicates that there is a problem within the underlying database.
Provides basic information about where a
ResultSummary is obtained from.This is a connection used by
DirectConnectionProvider to connect to a remote database.An error has happened while getting routing table with a remote server.
Accessor for a specific Neo4j graph database.
An in-memory result of executing a Cypher query that has been consumed in full.
A uniquely identifiable property container that can form part of a Neo4j graph.
Manages creation of Netty
EventLoopGroups, which are basically Executors that perform IO operations.An executable query that executes a query in a managed transaction with automatic retries on retryable errors.
A function accepting the
Result.keys(), collected result and ResultSummary values to produce a
final result value.Annotated elements are experimental and may change without deprecation across driver releases.
Utility class for extracting data.
FAILURE response message
This error indicate a fatal problem to obtain routing tables such as the routing table for a specified database does not exist.
The GQL-status object as defined by the GQL standard.
Creates
drivers, optionally letting you GraphDatabase.driver(URI, Config) to configure them.IGNORED response message
Indicates that instances of the annotated class or of its subclasses are immutable, i.e.
A
Connection shall fulfil this ImmutableConnectionContext when acquired from a connection provider.An input position refers to a specific character in a query.
A simple common token for authentication schemes that easily convert to
an auth token map
An input position refers to a specific point in a query string.
Deprecated.
Deprecated.
Deprecated.
Utility class for determining and working with the Cypher types of values
Represents temporal amount containing months, days, seconds and nanoseconds of the second.
Internal implementation of the JUL.
Load balancing strategy that finds server with the least amount of active (checked out of the pool) connections from given readers or writers.
This is the Pull All response handler that handles pull all messages in Bolt v3 and previous protocol versions.
A facility to select most appropriate reader or writer among the given addresses for request processing.
Logs messages for driver activity.
Accessor for
Logger instances.A LossyCoercion exception indicates that the conversion cannot be achieved without losing precision.
Access the keys, properties and values of an underlying unordered map by key
Provides methods to access the value of an underlying unordered map by key.
Base class for all protocol messages.
Bolt message format v4.3
Bolt message format v4.4
Bolt message writer v4.3
Bolt message writer v4.4
Provides driver internal metrics.
Defines which metrics consumer to use: Should metrics be consumed and exposed via driver's default consumer or provided with one of the external facades.
An adapter that collects driver metrics via
MetricsListener and publishes them via Metrics instance.An adapter to bridge between driver metrics and Micrometer
meter registry.This implementation of the
RoutingProcedureRunner works with multi database versions of Neo4j calling
the procedure `dbms.routing.getRoutingTable`This is the base class for Neo4j exceptions.
This is the logging factory to delegate netty's logging to our logging system
This connection represents a simple network connection to a remote server.
The Node interface describes the characteristics of a node from a Neo4j graph.
Thrown whenever a client expected to read a record that was not available (i.e.
Representation for notifications found when executing a query.
Notification category.
Notification classification.
A notification configuration defining what notifications should be supplied by the server.
Notification severity level.
A NotMultiValued exception indicates that the value does not consist of multiple values, a.k.a.
This is what
PackStream uses to ingest data, implement this on top of any data source of your choice to
deserialize the stream with PackStream.This is where
PackStream writes its output to.PackStream is a messaging serialisation format heavily inspired by MessagePack.
Immutable pair of a key and a value
A Path is a directed sequence of relationships between two nodes.
A segment combines a relationship in a path with a start and end node that describe the traversal direction
for that relationship.
Parse a public or private key.
This describes the plan that the database planner produced and used (or will use) to execute your query.
Represents a single point in a particular coordinate reference system.
A marker annotation indicating that the annotated target belongs to a preview feature.
This is the same as a regular
Plan - except this plan has been executed, meaning it also contains detailed information about how much work each
step of the plan incurred on the database.A signal that the contract for client-server communication has broken down.
PULL_ALL request message
PULL request message
The components of a Cypher query, containing the query text and parameter map.
Query configuration used by
Driver.executableQuery(String) and its variants.Builder used to configure
QueryConfig which will be used to execute a query.An
AutoCloseable extension of the SimpleQueryRunner.The type of query executed.
Common interface for components that can execute Neo4j queries using Reactive API.
Common interface for components that can execute Neo4j queries using Reactive API.
A reactive result provides a reactive way to execute query on the server and receives records back.
A reactive result provides a reactive way to execute query on the server and receives records back.
A reactive session is the same as
Session except it provides a reactive API.A reactive session is the same as
Session except it provides a reactive API.Same as
Transaction except this reactive transaction exposes a reactive API.Same as
Transaction except this reactive transaction exposes a reactive API.Callback that executes operations against a given
ReactiveTransactionContext.Callback that executes operations against a given
ReactiveTransactionContext.A context for running queries within transaction.
A context for running queries within transaction.
Container for Cypher result values.
Static utility methods for retaining records
Provides cluster composition lookup capabilities and initial router address resolution.
The Relationship interface describes the characteristics of a relationship from a Neo4j graph.
RESET request message
A Resource is an
AutoCloseable that allows introspecting if it
already has been closed through its Resource.isOpen() method.The result of running a Cypher query, conceptually a stream of
records.A user is trying to access resources that are no longer valid due to
the resources have already been consumed or
the
QueryRunner where the resources are created has already been closed.The result of asynchronous execution of a Cypher query, conceptually an asynchronous stream of
records.Bolt V4
The result summary of running a query.
A marker interface for retryable exceptions.
Defines strategy for revocation checks.
A
ClientCertificateManager that supports rotating its ClientCertificate.From the application point of view it is not interesting to know about the role a member plays in the cluster.
Encodes the ROUTE message to the stream
Handles the RouteMessage response getting the success response
and return its routing table property as the response.
This implementation of the
RoutingProcedureRunner access the routing procedure
through the bolt's ROUTE message.Encodes the ROUTE message to the stream
A connection used by the routing driver.
Defines routing mode for query.
Interface which defines the standard way to get the routing table
A generic interface to access all routing tables as a whole.
Deprecated.
superseded by
ReactiveQueryRunner and ReactiveQueryRunnerDeprecated.
superseded by
ReactiveResult and ReactiveResultDeprecated.
superseded by
ReactiveSession and ReactiveSessionDeprecated.
superseded by
ReactiveTransaction and ReactiveTransactionDeprecated.
superseded by
ReactiveTransactionCallback and ReactiveTransactionCallbackFailed to communicate with the server due to security errors.
A SecurityPlan consists of encryption and trust details.
A SecurityPlan consists of encryption and trust details.
Indicates that the contained
SecurityException is a RetryableException, which is determined by the
AuthTokenManager.handleSecurityException(AuthToken, SecurityException) method.Represents a host and port.
A resolver function used by the routing driver to resolve the initial address used to create the driver.
Provides some basic information of the server where the result is obtained from.
An ServiceUnavailableException indicates that the driver cannot communicate with the cluster.
Provides a context of work for database interactions.
The session configurations used to configure a session.
Builder used to configure
SessionConfig which will be used to create a session.A SessionExpiredException indicates that the session can no longer satisfy the criteria under which it was acquired, e.g.
Common interface for components that can execute Neo4j queries.
This implementation of the
RoutingProcedureRunner works with single database versions of Neo4j calling
the procedure `dbms.cluster.routing.getRoutingTable`Internal implementation of the SLF4J logging.
SUCCESS response message
Contains counters for various operations that a query triggered.
An enum of valid telemetry metrics.
TELEMETRY message
Sent by the client to inform which API is used.
Handles
TelemetryMessage responses.The provided token has expired.
Logical container for an atomic unit of work.
Callback that executes operations in a given
TransactionContext.Configuration object containing settings for transactions.
Builder used to construct
transaction configuration objects.A context for running queries within transaction.
This exception indicates a user is nesting new transaction with an on-going transaction (unmanaged and/or auto-commit).
Indicates that the transaction has been terminated.
Deprecated.
superseded by
TransactionCallback.A TransientException signals a temporary fault that may be worked around by retrying.
The type of
Value as defined by the Cypher languageA listing of all database types this driver can handle.
A Uncoercible exception indicates that the conversion cannot be achieved.
An Unsizable exception indicates that the value does not have a size.
A feature is not supported in a given setup.
Thrown if the remote server cannot be verified as Neo4j.
A unit of data that adheres to the Neo4j type system.
A ValueException indicates that the client has carried out an operation on values incorrectly.
Utility for wrapping regular Java types and exposing them as
Value
objects, and vice versa.
AsyncTransactionCallback.