Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 

A

AccessMode - Enum in org.neo4j.driver
Used by Routing Driver to decide if a transaction should be routed to a write server or a read server in a cluster.
acquired() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
A counter to record how many connections have been acquired from the pool since the pool is created.
acquiring() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
The number of connection acquisition requests that are currently in progress.
address() - Method in interface org.neo4j.driver.summary.ServerInfo
Returns a string telling the address of the server the query was executed.
agent() - Method in interface org.neo4j.driver.summary.ServerInfo
Returns server agent string by which the remote server identifies itself.
ANY() - Method in interface org.neo4j.driver.types.TypeSystem
 
arguments() - Method in interface org.neo4j.driver.summary.Plan
Many operators have arguments defining their specific behavior.
asBoolean() - Method in interface org.neo4j.driver.Value
 
asBoolean(boolean) - Method in interface org.neo4j.driver.Value
 
asByteArray() - Method in interface org.neo4j.driver.Value
 
asByteArray(byte[]) - Method in interface org.neo4j.driver.Value
 
asDouble() - Method in interface org.neo4j.driver.Value
Returns a Java double if no precision is lost in the conversion.
asDouble(double) - Method in interface org.neo4j.driver.Value
Returns a Java double if no precision is lost in the conversion.
asEntity() - Method in interface org.neo4j.driver.Value
 
asFloat() - Method in interface org.neo4j.driver.Value
Returns a Java float if no precision is lost in the conversion.
asFloat(float) - Method in interface org.neo4j.driver.Value
Returns a Java float if no precision is lost in the conversion.
asInt() - Method in interface org.neo4j.driver.Value
Returns a Java int if no precision is lost in the conversion.
asInt(int) - Method in interface org.neo4j.driver.Value
Returns a Java int if no precision is lost in the conversion.
asIsoDuration() - Method in interface org.neo4j.driver.Value
 
asIsoDuration(IsoDuration) - Method in interface org.neo4j.driver.Value
 
asList() - Method in interface org.neo4j.driver.Value
If the underlying type can be viewed as a list, returns a java list of values, where each value has been converted using Value.asObject().
asList(List<Object>) - Method in interface org.neo4j.driver.Value
If the underlying type can be viewed as a list, returns a java list of values, where each value has been converted using Value.asObject().
asList(Function<Value, T>) - Method in interface org.neo4j.driver.Value
 
asList(Function<Value, T>, List<T>) - Method in interface org.neo4j.driver.Value
 
asLocalDate() - Method in interface org.neo4j.driver.Value
 
asLocalDate(LocalDate) - Method in interface org.neo4j.driver.Value
 
asLocalDateTime() - Method in interface org.neo4j.driver.Value
 
asLocalDateTime(LocalDateTime) - Method in interface org.neo4j.driver.Value
 
asLocalTime() - Method in interface org.neo4j.driver.Value
 
asLocalTime(LocalTime) - Method in interface org.neo4j.driver.Value
 
asLong() - Method in interface org.neo4j.driver.Value
Returns a Java long if no precision is lost in the conversion.
asLong(long) - Method in interface org.neo4j.driver.Value
Returns a Java long if no precision is lost in the conversion.
asMap() - Method in interface org.neo4j.driver.types.MapAccessor
Return the underlying map as a map of string keys and values converted using Value.asObject().
asMap(Function<Value, T>) - Method in interface org.neo4j.driver.types.MapAccessor
 
asMap(Map<String, Object>) - Method in interface org.neo4j.driver.Value
Return as a map of string keys and values converted using Value.asObject().
asMap(Function<Value, T>, Map<String, T>) - Method in interface org.neo4j.driver.Value
 
asNode() - Method in interface org.neo4j.driver.Value
 
asNumber() - Method in interface org.neo4j.driver.Value
 
asObject() - Method in interface org.neo4j.driver.Value
This returns a java standard library representation of the underlying value, using a java type that is "sensible" given the underlying type.
asOffsetDateTime() - Method in interface org.neo4j.driver.Value
 
asOffsetDateTime(OffsetDateTime) - Method in interface org.neo4j.driver.Value
 
asOffsetTime() - Method in interface org.neo4j.driver.Value
 
asOffsetTime(OffsetTime) - Method in interface org.neo4j.driver.Value
 
asPath() - Method in interface org.neo4j.driver.Value
 
asPoint() - Method in interface org.neo4j.driver.Value
 
asPoint(Point) - Method in interface org.neo4j.driver.Value
 
asRelationship() - Method in interface org.neo4j.driver.Value
 
asString() - Method in interface org.neo4j.driver.Value
 
asString(String) - Method in interface org.neo4j.driver.Value
 
AsyncQueryRunner - Interface in org.neo4j.driver.async
Asynchronous interface for components that can execute Neo4j queries.
AsyncSession - Interface in org.neo4j.driver.async
Provides a context of work for database interactions.
asyncSession() - Method in interface org.neo4j.driver.Driver
Create a new general purpose AsyncSession with default session configuration.
asyncSession(SessionConfig) - Method in interface org.neo4j.driver.Driver
Create a new AsyncSession with a specified session configuration.
AsyncTransaction - Interface in org.neo4j.driver.async
Logical container for an atomic unit of work.
AsyncTransactionWork<T> - Interface in org.neo4j.driver.async
Callback that executes operations against a given AsyncTransaction.
asZonedDateTime() - Method in interface org.neo4j.driver.Value
 
asZonedDateTime(ZonedDateTime) - Method in interface org.neo4j.driver.Value
 
AuthenticationException - Exception in org.neo4j.driver.exceptions
Failed to authenticate the driver to the server due to bad credentials provided.
AuthenticationException(String, String) - Constructor for exception org.neo4j.driver.exceptions.AuthenticationException
 
AuthorizationExpiredException - Exception in org.neo4j.driver.exceptions
The authorization info maintained on the server has expired.
AuthorizationExpiredException(String, String) - Constructor for exception org.neo4j.driver.exceptions.AuthorizationExpiredException
 
AuthToken - Interface in org.neo4j.driver
Token for holding authentication details, such as user name and password.
AuthTokens - Class in org.neo4j.driver
This is a listing of the various methods of authentication supported by this driver.
AuthTokens() - Constructor for class org.neo4j.driver.AuthTokens
 

B

basic(String, String) - Static method in class org.neo4j.driver.AuthTokens
The basic authentication scheme, using a username and a password.
basic(String, String, String) - Static method in class org.neo4j.driver.AuthTokens
The basic authentication scheme, using a username and a password.
bearer(String) - Static method in class org.neo4j.driver.AuthTokens
The bearer authentication scheme, using a base64 encoded token.
beginTransaction() - Method in interface org.neo4j.driver.reactive.RxSession
Begin a new unmanaged transaction.
beginTransaction(TransactionConfig) - Method in interface org.neo4j.driver.reactive.RxSession
Begin a new unmanaged transaction with the specified configuration.
beginTransaction() - Method in interface org.neo4j.driver.Session
Begin a new unmanaged transaction.
beginTransaction(TransactionConfig) - Method in interface org.neo4j.driver.Session
Begin a new unmanaged transaction with the specified configuration.
beginTransactionAsync() - Method in interface org.neo4j.driver.async.AsyncSession
Begin a new unmanaged transaction.
beginTransactionAsync(TransactionConfig) - Method in interface org.neo4j.driver.async.AsyncSession
Begin a new unmanaged transaction with the specified configuration.
Bookmark - Interface in org.neo4j.driver
Causal chaining is carried out by passing bookmarks between transactions.
bookmarks() - Method in class org.neo4j.driver.SessionConfig
Returns the initial bookmarks.
BOOLEAN() - Method in interface org.neo4j.driver.types.TypeSystem
 
build() - Method in class org.neo4j.driver.Config.ConfigBuilder
Create a config instance from this builder.
build() - Method in class org.neo4j.driver.SessionConfig.Builder
 
build() - Method in class org.neo4j.driver.TransactionConfig.Builder
Build the transaction configuration object using the specified settings.
builder() - Static method in class org.neo4j.driver.Config
Start building a Config object using a newly created builder.
builder() - Static method in class org.neo4j.driver.SessionConfig
Creates a new SessionConfig.Builder used to construct a configuration object.
builder() - Static method in class org.neo4j.driver.TransactionConfig
Create new TransactionConfig.Builder used to construct a configuration object.
BYTES() - Method in interface org.neo4j.driver.types.TypeSystem
 

C

certFile() - Method in class org.neo4j.driver.Config.TrustStrategy
Deprecated.
certFiles() - Method in class org.neo4j.driver.Config.TrustStrategy
Return the configured certificate files.
children() - Method in interface org.neo4j.driver.summary.Plan
As noted in the class-level javadoc, a plan is a tree, where each child is another plan.
children() - Method in interface org.neo4j.driver.summary.ProfiledPlan
 
ClientException - Exception in org.neo4j.driver.exceptions
A ClientException indicates that the client has carried out an operation incorrectly.
ClientException(String) - Constructor for exception org.neo4j.driver.exceptions.ClientException
 
ClientException(String, Throwable) - Constructor for exception org.neo4j.driver.exceptions.ClientException
 
ClientException(String, String) - Constructor for exception org.neo4j.driver.exceptions.ClientException
 
close() - Method in interface org.neo4j.driver.Driver
Close all the resources assigned to this driver, including open connections and IO threads.
close() - Method in interface org.neo4j.driver.reactive.RxSession
Signal that you are done using this session.
close() - Method in interface org.neo4j.driver.reactive.RxTransaction
Close the transaction.
close() - Method in interface org.neo4j.driver.Session
Signal that you are done using this session.
close() - Method in interface org.neo4j.driver.Transaction
Close the transaction.
closeAsync() - Method in interface org.neo4j.driver.async.AsyncSession
Signal that you are done using this session.
closeAsync() - Method in interface org.neo4j.driver.async.AsyncTransaction
Close the transaction.
closeAsync() - Method in interface org.neo4j.driver.Driver
Close all the resources assigned to this driver, including open connections and IO threads.
closed() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
A counter to record how many connections have been closed by this pool.
code() - Method in exception org.neo4j.driver.exceptions.Neo4jException
Access the status code for this exception.
code() - Method in interface org.neo4j.driver.summary.Notification
Returns a notification code for the discovered issue.
column(int) - Static method in class org.neo4j.driver.Records
 
column(String) - Static method in class org.neo4j.driver.Records
 
column(int, Function<Value, T>) - Static method in class org.neo4j.driver.Records
 
column(String, Function<Value, T>) - Static method in class org.neo4j.driver.Records
 
column() - Method in interface org.neo4j.driver.summary.InputPosition
The column number referred to by the position; column numbers start at 1.
commit() - Method in interface org.neo4j.driver.reactive.RxTransaction
Commits the transaction.
commit() - Method in interface org.neo4j.driver.Transaction
Commit this current transaction.
commitAsync() - Method in interface org.neo4j.driver.async.AsyncTransaction
Commit this transaction in asynchronous fashion.
computeOrDefault(Function<Value, T>, T) - Method in interface org.neo4j.driver.Value
Apply the mapping function on the value if the value is not a NullValue, or the default value if the value is a NullValue.
Config - Class in org.neo4j.driver
A configuration class to config driver properties.
Config.ConfigBuilder - Class in org.neo4j.driver
Used to build new config instances
Config.TrustStrategy - Class in org.neo4j.driver
Control how the driver determines if it can trust the encryption certificates provided by the Neo4j instance it is connected to.
Config.TrustStrategy.Strategy - Enum in org.neo4j.driver
The trust strategy that the driver supports
connectionAcquisitionTimeoutMillis() - Method in class org.neo4j.driver.Config
 
ConnectionPoolMetrics - Interface in org.neo4j.driver
Provides connection pool metrics such as connection created, current in use etc.
connectionPoolMetrics() - Method in interface org.neo4j.driver.Metrics
Connection pool metrics records metrics of connection pools that are currently in use.
ConnectionReadTimeoutException - Exception in org.neo4j.driver.exceptions
Indicates that read timed out due to it taking longer than the server-supplied timeout value via the connection.recv_timeout_seconds configuration hint.
ConnectionReadTimeoutException(String) - Constructor for exception org.neo4j.driver.exceptions.ConnectionReadTimeoutException
 
connectionTimeoutMillis() - Method in class org.neo4j.driver.Config
 
console(Level) - Static method in interface org.neo4j.driver.Logging
Create logging implementation that uses java.util.logging to log to System.err.
constraintsAdded() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
constraintsRemoved() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
consume() - Method in interface org.neo4j.driver.reactive.RxResult
Returns a cold publisher of result summary which arrives after all records.
consume() - Method in interface org.neo4j.driver.Result
Return the result summary.
consumeAsync() - Method in interface org.neo4j.driver.async.ResultCursor
Asynchronously retrieve the result summary.
contains(Node) - Method in interface org.neo4j.driver.types.Path
 
contains(Relationship) - Method in interface org.neo4j.driver.types.Path
 
containsKey(String) - Method in interface org.neo4j.driver.types.MapAccessor
Check if the list of keys contains the given key
containsSystemUpdates() - Method in interface org.neo4j.driver.summary.SummaryCounters
If the query updated the system graph in any way, this method will return true,
containsUpdates() - Method in interface org.neo4j.driver.summary.SummaryCounters
Whether there were any updates at all, eg.
counters() - Method in interface org.neo4j.driver.summary.ResultSummary
 
created() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
A counter to record how many connections have been successfully created with this pool since the pool was created.
creating() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
The amount of connections that are currently in the process of being created.
custom(String, String, String, String) - Static method in class org.neo4j.driver.AuthTokens
A custom authentication token used for doing custom authentication on the server side.
custom(String, String, String, String, Map<String, Object>) - Static method in class org.neo4j.driver.AuthTokens
A custom authentication token used for doing custom authentication on the server side.

D

database() - Method in class org.neo4j.driver.SessionConfig
The database where the session is going to connect to.
database() - Method in interface org.neo4j.driver.summary.ResultSummary
The basic information of the database where the result is obtained from
DatabaseException - Exception in org.neo4j.driver.exceptions
A DatabaseException indicates that there is a problem within the underlying database.
DatabaseException(String, String) - Constructor for exception org.neo4j.driver.exceptions.DatabaseException
 
DatabaseInfo - Interface in org.neo4j.driver.summary
Provides basic information about where a ResultSummary is obtained from.
DATE() - Method in interface org.neo4j.driver.types.TypeSystem
 
DATE_TIME() - Method in interface org.neo4j.driver.types.TypeSystem
 
days() - Method in interface org.neo4j.driver.types.IsoDuration
Retrieve amount of days in this duration.
dbHits() - Method in interface org.neo4j.driver.summary.ProfiledPlan
 
debug(String, Object...) - Method in interface org.neo4j.driver.Logger
Logs bolt messages sent and received by this driver.
debug(String, Throwable) - Method in interface org.neo4j.driver.Logger
Logs debug message with throwable.
defaultAccessMode() - Method in class org.neo4j.driver.SessionConfig
The type of access required by units of work in this session, e.g.
defaultConfig() - Static method in class org.neo4j.driver.Config
 
defaultConfig() - Static method in class org.neo4j.driver.SessionConfig
Returns a static SessionConfig with default values for a general purpose session.
defaultTypeSystem() - Method in interface org.neo4j.driver.Driver
This will return the type system supported by the driver.
DESCRIPTION - Static variable in exception org.neo4j.driver.exceptions.AuthorizationExpiredException
 
description() - Method in interface org.neo4j.driver.summary.Notification
Returns a longer description of the notification.
DiscoveryException - Exception in org.neo4j.driver.exceptions
An error has happened while getting routing table with a remote server.
DiscoveryException(String, Throwable) - Constructor for exception org.neo4j.driver.exceptions.DiscoveryException
 
Driver - Interface in org.neo4j.driver
Accessor for a specific Neo4j graph database.
driver(String) - Static method in class org.neo4j.driver.GraphDatabase
Return a driver for a Neo4j instance with the default configuration settings
driver(URI) - Static method in class org.neo4j.driver.GraphDatabase
Return a driver for a Neo4j instance with the default configuration settings
driver(URI, Config) - Static method in class org.neo4j.driver.GraphDatabase
Return a driver for a Neo4j instance with custom configuration.
driver(String, Config) - Static method in class org.neo4j.driver.GraphDatabase
Return a driver for a Neo4j instance with custom configuration.
driver(String, AuthToken) - Static method in class org.neo4j.driver.GraphDatabase
Return a driver for a Neo4j instance with the default configuration settings
driver(URI, AuthToken) - Static method in class org.neo4j.driver.GraphDatabase
Return a driver for a Neo4j instance with the default configuration settings
driver(String, AuthToken, Config) - Static method in class org.neo4j.driver.GraphDatabase
Return a driver for a Neo4j instance with custom configuration.
driver(URI, AuthToken, Config) - Static method in class org.neo4j.driver.GraphDatabase
Return a driver for a Neo4j instance with custom configuration.
DURATION() - Method in interface org.neo4j.driver.types.TypeSystem
 

E

empty() - Static method in class org.neo4j.driver.TransactionConfig
Get a configuration object that does not have any values configures.
EmptyMap - Static variable in class org.neo4j.driver.Values
 
encrypted() - Method in class org.neo4j.driver.Config
 
end() - Method in interface org.neo4j.driver.types.Path
 
end() - Method in interface org.neo4j.driver.types.Path.Segment
The node that this segment ends at.
endNodeId() - Method in interface org.neo4j.driver.types.Relationship
Id of the node where this relationship ends.
Entity - Interface in org.neo4j.driver.types
A uniquely identifiable property container that can form part of a Neo4j graph.
equals(Object) - Method in class org.neo4j.driver.Query
 
equals(Object) - Method in class org.neo4j.driver.SessionConfig
 
equals(Object) - Method in class org.neo4j.driver.TransactionConfig
 
equals(Object) - Method in interface org.neo4j.driver.Value
 
error(String, Throwable) - Method in interface org.neo4j.driver.Logger
Logs errors from this driver.
eventLoopThreads() - Method in class org.neo4j.driver.Config
 
execute(AsyncTransaction) - Method in interface org.neo4j.driver.async.AsyncTransactionWork
Executes all given operations against the same transaction.
execute(RxTransaction) - Method in interface org.neo4j.driver.reactive.RxTransactionWork
Executes all given operations against the same transaction.
execute(Transaction) - Method in interface org.neo4j.driver.TransactionWork
Executes all given operations against the same transaction.
Experimental - Annotation Type in org.neo4j.driver.util
Annotated elements are experimental and may change without deprecation across driver releases.

F

failedToCreate() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
A counter to record how many connections that have failed to be created.
FatalDiscoveryException - Exception in org.neo4j.driver.exceptions
This error indicate a fatal problem to obtain routing tables such as the routing table for a specified database does not exist.
FatalDiscoveryException(String) - Constructor for exception org.neo4j.driver.exceptions.FatalDiscoveryException
 
FatalDiscoveryException(String, String) - Constructor for exception org.neo4j.driver.exceptions.FatalDiscoveryException
 
fetchSize() - Method in class org.neo4j.driver.Config
 
fetchSize() - Method in class org.neo4j.driver.SessionConfig
This value if set, overrides the default fetch size set on Config.fetchSize().
fields() - Method in interface org.neo4j.driver.Record
Retrieve all record fields
FLOAT() - Method in interface org.neo4j.driver.types.TypeSystem
 
forDatabase(String) - Static method in class org.neo4j.driver.SessionConfig
Returns a SessionConfig for the specified database
forEachAsync(Consumer<Record>) - Method in interface org.neo4j.driver.async.ResultCursor
Asynchronously apply the given action to every record in the result, yielding a summary of it.
from(Set<String>) - Static method in interface org.neo4j.driver.Bookmark
Reconstruct bookmark from \bookmarks string values.
fromCode(String) - Static method in enum org.neo4j.driver.summary.QueryType
 
fromCode(String, Function<String, ? extends Neo4jException>) - Static method in enum org.neo4j.driver.summary.QueryType
 

G

get(int) - Method in interface org.neo4j.driver.Record
Retrieve the value at the given field index
get(String) - Method in interface org.neo4j.driver.types.MapAccessor
Retrieve the value of the property with the given key
get(String, Value) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the value with the given key.
get(String, Object) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the object with the given key.
get(String, Number) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the number with the given key.
get(String, Entity) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the entity with the given key.
get(String, Node) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the node with the given key.
get(String, Path) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the path with the given key.
get(String, Relationship) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the value with the given key.
get(String, List<Object>) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the list of objects with the given key.
get(String, List<T>, Function<Value, T>) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the list with the given key.
get(String, Map<String, Object>) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the map with the given key.
get(String, Map<String, T>, Function<Value, T>) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the map with the given key.
get(String, int) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the java integer with the given key.
get(String, long) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the java long number with the given key.
get(String, boolean) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the java boolean with the given key.
get(String, String) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the java string with the given key.
get(String, float) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the java float number with the given key.
get(String, double) - Method in interface org.neo4j.driver.types.MapAccessorWithDefaultValue
Retrieve the java double number with the given key.
get(int) - Method in interface org.neo4j.driver.Value
Retrieve the value at the given index
getLog(Class<?>) - Method in interface org.neo4j.driver.Logging
Obtain a Logger instance by class, its name will be the fully qualified name of the class.
getLog(String) - Method in interface org.neo4j.driver.Logging
Obtain a Logger instance by name.
GraphDatabase - Class in org.neo4j.driver
Creates drivers, optionally letting you GraphDatabase.driver(URI, Config) to configure them.
GraphDatabase() - Constructor for class org.neo4j.driver.GraphDatabase
 

H

hashCode() - Method in class org.neo4j.driver.Query
 
hashCode() - Method in class org.neo4j.driver.SessionConfig
 
hashCode() - Method in class org.neo4j.driver.TransactionConfig
 
hashCode() - Method in interface org.neo4j.driver.Value
 
hasLabel(String) - Method in interface org.neo4j.driver.types.Node
Test if this node has a given label
hasNext() - Method in interface org.neo4j.driver.Result
Test if there is another record we can navigate to in this result.
hasPageCacheStats() - Method in interface org.neo4j.driver.summary.ProfiledPlan
 
hasPlan() - Method in interface org.neo4j.driver.summary.ResultSummary
 
hasProfile() - Method in interface org.neo4j.driver.summary.ResultSummary
 
hasType(String) - Method in interface org.neo4j.driver.types.Relationship
Test if this relationship has the given type
hasType(Type) - Method in interface org.neo4j.driver.Value
Test if this value is a value of the given type
host() - Method in interface org.neo4j.driver.net.ServerAddress
Retrieve the host portion of this ServerAddress.

I

id() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
A unique id that identifies this pool metrics.
id() - Method in interface org.neo4j.driver.types.Entity
A unique id for this Entity.
identifiers() - Method in interface org.neo4j.driver.summary.Plan
Identifiers used by this part of the plan.
idle() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
The amount of connections that are currently idle (buffered inside the pool).
idleTimeBeforeConnectionTest() - Method in class org.neo4j.driver.Config
Pooled connections that have been idle in the pool for longer than this timeout will be tested before they are used again, to ensure they are still live.
Immutable - Annotation Type in org.neo4j.driver.util
Indicates that instances of the annotated class or of its subclasses are immutable, i.e.
impersonatedUser() - Method in class org.neo4j.driver.SessionConfig
The impersonated user the session is going to use for query execution.
index(String) - Method in interface org.neo4j.driver.Record
Retrieve the index of the field with the given key
indexesAdded() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
indexesRemoved() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
info(String, Object...) - Method in interface org.neo4j.driver.Logger
Logs information from the driver.
InputPosition - Interface in org.neo4j.driver.summary
An input position refers to a specific character in a query.
INSTANCE - Static variable in exception org.neo4j.driver.exceptions.ConnectionReadTimeoutException
 
INTEGER() - Method in interface org.neo4j.driver.types.TypeSystem
 
inUse() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
The amount of connections that are currently in-use (borrowed out of the pool).
isDebugEnabled() - Method in interface org.neo4j.driver.Logger
Return true if the debug level is enabled.
isEmpty() - Method in interface org.neo4j.driver.Bookmark
Return true if the bookmark is empty.
isEmpty() - Method in class org.neo4j.driver.TransactionConfig
Check if this configuration object contains any values.
isEmpty() - Method in interface org.neo4j.driver.Value
If this value represents a list or map, test if the collection is empty.
isEncrypted() - Method in interface org.neo4j.driver.Driver
Return a flag to indicate whether or not encryption is used for this driver.
isFalse() - Method in interface org.neo4j.driver.Value
 
isHostnameVerificationEnabled() - Method in class org.neo4j.driver.Config.TrustStrategy
Check if hostname verification is enabled for this trust strategy.
isMetricsEnabled() - Method in class org.neo4j.driver.Config
 
isMetricsEnabled() - Method in interface org.neo4j.driver.Driver
Returns true if the driver metrics reporting is enabled via Config.ConfigBuilder.withDriverMetrics(), otherwise false.
isNull() - Method in interface org.neo4j.driver.Value
 
IsoDuration - Interface in org.neo4j.driver.types
Represents temporal amount containing months, days, seconds and nanoseconds of the second.
isoDuration(long, long, long, int) - Static method in class org.neo4j.driver.Values
 
isOpen() - Method in interface org.neo4j.driver.util.Resource
Detect whether this resource is still open
isTraceEnabled() - Method in interface org.neo4j.driver.Logger
Return true if the trace logging level is enabled.
isTrue() - Method in interface org.neo4j.driver.Value
 
isTypeOf(Value) - Method in interface org.neo4j.driver.types.Type
Test if the given value has this type

J

javaUtilLogging(Level) - Static method in interface org.neo4j.driver.Logging
Create logging implementation that uses java.util.logging.

K

kerberos(String) - Static method in class org.neo4j.driver.AuthTokens
The kerberos authentication scheme, using a base64 encoded ticket
key() - Method in interface org.neo4j.driver.util.Pair
 
keys() - Method in interface org.neo4j.driver.async.ResultCursor
Retrieve the keys of the records this result cursor contains.
keys() - Method in interface org.neo4j.driver.reactive.RxResult
Returns a cold publisher of keys.
keys() - Method in interface org.neo4j.driver.Record
Retrieve the keys of the underlying map
keys() - Method in interface org.neo4j.driver.Result
Retrieve the keys of the records this result contains.
keys() - Method in interface org.neo4j.driver.types.MapAccessor
Retrieve the keys of the underlying map
keys() - Method in interface org.neo4j.driver.Value
If the underlying value supports key-based indexing, return an iterable of the keys in the map, this applies to map, node and TypeSystem.RELATIONSHIP() relationship} values.

L

labels() - Method in interface org.neo4j.driver.types.Node
Return all labels.
labelsAdded() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
labelsRemoved() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
lastBookmark() - Method in interface org.neo4j.driver.async.AsyncSession
Return the bookmark received following the last completed transaction.
lastBookmark() - Method in interface org.neo4j.driver.reactive.RxSession
Return the bookmark received following the last completed query within this session.
lastBookmark() - Method in interface org.neo4j.driver.Session
Return the bookmark received following the last completed transaction.
length() - Method in interface org.neo4j.driver.types.Path
 
line() - Method in interface org.neo4j.driver.summary.InputPosition
The line number referred to by the position; line numbers start at 1.
list() - Method in interface org.neo4j.driver.Result
Retrieve and store the entire result stream.
list(Function<Record, T>) - Method in interface org.neo4j.driver.Result
Retrieve and store a projection of the entire result.
LIST() - Method in interface org.neo4j.driver.types.TypeSystem
 
listAsync() - Method in interface org.neo4j.driver.async.ResultCursor
Asynchronously retrieve and store the entire result stream.
listAsync(Function<Record, T>) - Method in interface org.neo4j.driver.async.ResultCursor
Asynchronously retrieve and store a projection of the entire result.
LOCAL_DATE_TIME() - Method in interface org.neo4j.driver.types.TypeSystem
 
LOCAL_TIME() - Method in interface org.neo4j.driver.types.TypeSystem
 
Logger - Interface in org.neo4j.driver
Logs messages for driver activity.
logging() - Method in class org.neo4j.driver.Config
Logging provider
Logging - Interface in org.neo4j.driver
Accessor for Logger instances.
logLeakedSessions() - Method in class org.neo4j.driver.Config
Check if leaked sessions logging is enabled.
LossyCoercion - Exception in org.neo4j.driver.exceptions.value
A LossyCoercion exception indicates that the conversion cannot be achieved without losing precision.
LossyCoercion(String, String) - Constructor for exception org.neo4j.driver.exceptions.value.LossyCoercion
 

M

MAP() - Method in interface org.neo4j.driver.types.TypeSystem
 
MapAccessor - Interface in org.neo4j.driver.types
Access the keys, properties and values of an underlying unordered map by key This provides only read methods.
MapAccessorWithDefaultValue - Interface in org.neo4j.driver.types
Provides methods to access the value of an underlying unordered map by key.
maxConnectionLifetimeMillis() - Method in class org.neo4j.driver.Config
Pooled connections older than this threshold will be closed and removed from the pool.
maxConnectionPoolSize() - Method in class org.neo4j.driver.Config
 
metadata() - Method in class org.neo4j.driver.TransactionConfig
Get the configured transaction metadata.
metrics() - Method in interface org.neo4j.driver.Driver
Returns the driver metrics if metrics reporting is enabled via Config.ConfigBuilder.withDriverMetrics().
Metrics - Interface in org.neo4j.driver
Provides driver internal metrics.
metricsAdapter() - Method in class org.neo4j.driver.Config
 
MetricsAdapter - Enum in org.neo4j.driver
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.
months() - Method in interface org.neo4j.driver.types.IsoDuration
Retrieve amount of months in this duration.

N

name() - Method in interface org.neo4j.driver.summary.DatabaseInfo
The name of the database where a ResultSummary is obtained from.
name() - Method in interface org.neo4j.driver.types.Type
 
nanoseconds() - Method in interface org.neo4j.driver.types.IsoDuration
Retrieve amount of nanoseconds of the second in this duration.
neo4jErrorCode() - Method in exception org.neo4j.driver.exceptions.Neo4jException
Deprecated.
Neo4jException - Exception in org.neo4j.driver.exceptions
This is the base class for all exceptions caused as part of communication with the remote Neo4j server.
Neo4jException(String) - Constructor for exception org.neo4j.driver.exceptions.Neo4jException
 
Neo4jException(String, Throwable) - Constructor for exception org.neo4j.driver.exceptions.Neo4jException
 
Neo4jException(String, String) - Constructor for exception org.neo4j.driver.exceptions.Neo4jException
 
Neo4jException(String, String, Throwable) - Constructor for exception org.neo4j.driver.exceptions.Neo4jException
 
next() - Method in interface org.neo4j.driver.Result
Navigate to and retrieve the next Record in this result.
nextAsync() - Method in interface org.neo4j.driver.async.ResultCursor
Asynchronously navigate to and retrieve the next Record in this result.
Node - Interface in org.neo4j.driver.types
The Node interface describes the characteristics of a node from a Neo4j graph.
NODE() - Method in interface org.neo4j.driver.types.TypeSystem
 
nodes() - Method in interface org.neo4j.driver.types.Path
Create an iterable over the nodes in this path, nodes will appear in the same order as they appear in the path.
nodesCreated() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
nodesDeleted() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
none() - Static method in class org.neo4j.driver.AuthTokens
No authentication scheme.
none() - Static method in interface org.neo4j.driver.Logging
Create logging implementation that discards all messages and logs nothing.
NoSuchRecordException - Exception in org.neo4j.driver.exceptions
Thrown whenever a client expected to read a record that was not available (i.e.
NoSuchRecordException(String) - Constructor for exception org.neo4j.driver.exceptions.NoSuchRecordException
 
Notification - Interface in org.neo4j.driver.summary
Representation for notifications found when executing a query.
notifications() - Method in interface org.neo4j.driver.summary.ResultSummary
A list of notifications that might arise when executing the query.
NotMultiValued - Exception in org.neo4j.driver.exceptions.value
A NotMultiValued exception indicates that the value does not consist of multiple values, a.k.a.
NotMultiValued(String) - Constructor for exception org.neo4j.driver.exceptions.value.NotMultiValued
 
NULL() - Method in interface org.neo4j.driver.types.TypeSystem
 
NULL - Static variable in class org.neo4j.driver.Values
 
NUMBER() - Method in interface org.neo4j.driver.types.TypeSystem
 

O

of(String, int) - Static method in interface org.neo4j.driver.net.ServerAddress
Create a new address with the given host and port.
ofBoolean() - Static method in class org.neo4j.driver.Values
Converts values to Boolean.
ofDouble() - Static method in class org.neo4j.driver.Values
Converts values to Double.
ofEntity() - Static method in class org.neo4j.driver.Values
Converts values to Entity.
ofEntityId() - Static method in class org.neo4j.driver.Values
Converts values to entity id.
ofFloat() - Static method in class org.neo4j.driver.Values
Converts values to Float.
offset() - Method in interface org.neo4j.driver.summary.InputPosition
The character offset referred to by this position; offset numbers start at 0.
ofInteger() - Static method in class org.neo4j.driver.Values
Converts values to Integer.
ofIsoDuration() - Static method in class org.neo4j.driver.Values
Converts values to IsoDuration.
ofList() - Static method in class org.neo4j.driver.Values
Converts values to List of Object.
ofList(Function<Value, T>) - Static method in class org.neo4j.driver.Values
Converts values to List of T.
ofLocalDate() - Static method in class org.neo4j.driver.Values
Converts values to LocalDate.
ofLocalDateTime() - Static method in class org.neo4j.driver.Values
Converts values to LocalDateTime.
ofLocalTime() - Static method in class org.neo4j.driver.Values
Converts values to LocalTime.
ofLong() - Static method in class org.neo4j.driver.Values
Converts values to Long.
ofMap() - Static method in class org.neo4j.driver.Values
Converts values to Map.
ofMap(Function<Value, T>) - Static method in class org.neo4j.driver.Values
Converts values to Map, with the map values further converted using the provided converter.
ofNode() - Static method in class org.neo4j.driver.Values
Converts values to Node.
ofNumber() - Static method in class org.neo4j.driver.Values
Converts values to Number.
ofObject() - Static method in class org.neo4j.driver.Values
Converts values to objects using Value.asObject().
ofOffsetDateTime() - Static method in class org.neo4j.driver.Values
Converts values to OffsetDateTime.
ofOffsetTime() - Static method in class org.neo4j.driver.Values
Converts values to OffsetTime.
ofPath() - Static method in class org.neo4j.driver.Values
Converts values to Path.
ofPoint() - Static method in class org.neo4j.driver.Values
Converts values to Point.
ofRelationship() - Static method in class org.neo4j.driver.Values
Converts values to Relationship.
ofString() - Static method in class org.neo4j.driver.Values
Converts values to String.
ofToString() - Static method in class org.neo4j.driver.Values
Converts values using Value.toString(), a human-readable string description of any value.
ofValue() - Static method in class org.neo4j.driver.Values
The identity function for value conversion - returns the value untouched.
ofZonedDateTime() - Static method in class org.neo4j.driver.Values
Converts values to ZonedDateTime.
operatorType() - Method in interface org.neo4j.driver.summary.Plan
 
org.neo4j.driver - package org.neo4j.driver
 
org.neo4j.driver.async - package org.neo4j.driver.async
 
org.neo4j.driver.exceptions - package org.neo4j.driver.exceptions
 
org.neo4j.driver.exceptions.value - package org.neo4j.driver.exceptions.value
 
org.neo4j.driver.net - package org.neo4j.driver.net
 
org.neo4j.driver.reactive - package org.neo4j.driver.reactive
 
org.neo4j.driver.summary - package org.neo4j.driver.summary
 
org.neo4j.driver.types - package org.neo4j.driver.types
 
org.neo4j.driver.util - package org.neo4j.driver.util
 

P

pageCacheHitRatio() - Method in interface org.neo4j.driver.summary.ProfiledPlan
 
pageCacheHits() - Method in interface org.neo4j.driver.summary.ProfiledPlan
 
pageCacheMisses() - Method in interface org.neo4j.driver.summary.ProfiledPlan
 
Pair<K,V> - Interface in org.neo4j.driver.util
Immutable pair of a key and a value
parameters() - Method in class org.neo4j.driver.Query
 
parameters(Object...) - Static method in class org.neo4j.driver.Values
Helper function for creating a map of parameters, this can be used when you run queries.
Path - Interface in org.neo4j.driver.types
A Path is a directed sequence of relationships between two nodes.
PATH() - Method in interface org.neo4j.driver.types.TypeSystem
 
Path.Segment - Interface in org.neo4j.driver.types
A segment combines a relationship in a path with a start and end node that describe the traversal direction for that relationship.
peek() - Method in interface org.neo4j.driver.Result
Investigate the next upcoming record without moving forward in the result.
peekAsync() - Method in interface org.neo4j.driver.async.ResultCursor
Asynchronously investigate the next upcoming Record without moving forward in the result.
Plan - Interface in org.neo4j.driver.summary
This describes the plan that the database planner produced and used (or will use) to execute your query.
plan() - Method in interface org.neo4j.driver.summary.ResultSummary
This describes how the database will execute your query.
Point - Interface in org.neo4j.driver.types
Represents a single point in a particular coordinate reference system.
POINT() - Method in interface org.neo4j.driver.types.TypeSystem
 
point(int, double, double) - Static method in class org.neo4j.driver.Values
 
point(int, double, double, double) - Static method in class org.neo4j.driver.Values
 
port() - Method in interface org.neo4j.driver.net.ServerAddress
Retrieve the port portion of this ServerAddress.
position() - Method in interface org.neo4j.driver.summary.Notification
The position in the query where this notification points to.
profile() - Method in interface org.neo4j.driver.summary.ResultSummary
This describes how the database did execute your query.
ProfiledPlan - Interface in org.neo4j.driver.summary
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.
propertiesSet() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
ProtocolException - Exception in org.neo4j.driver.exceptions
A signal that the contract for client-server communication has broken down.
ProtocolException(String) - Constructor for exception org.neo4j.driver.exceptions.ProtocolException
 
ProtocolException(String, Throwable) - Constructor for exception org.neo4j.driver.exceptions.ProtocolException
 
protocolVersion() - Method in interface org.neo4j.driver.summary.ServerInfo
Returns Bolt protocol version with which the remote server communicates.

Q

Query - Class in org.neo4j.driver
The components of a Cypher query, containing the query text and parameter map.
Query(String, Value) - Constructor for class org.neo4j.driver.Query
Create a new query.
Query(String, Map<String, Object>) - Constructor for class org.neo4j.driver.Query
Create a new query.
Query(String) - Constructor for class org.neo4j.driver.Query
Create a new query.
query() - Method in interface org.neo4j.driver.summary.ResultSummary
 
QueryRunner - Interface in org.neo4j.driver
Common interface for components that can execute Neo4j queries.
QueryType - Enum in org.neo4j.driver.summary
The type of query executed.
queryType() - Method in interface org.neo4j.driver.summary.ResultSummary
 

R

readTransaction(RxTransactionWork<? extends Publisher<T>>) - Method in interface org.neo4j.driver.reactive.RxSession
Execute given unit of reactive work in a read reactive transaction.
readTransaction(RxTransactionWork<? extends Publisher<T>>, TransactionConfig) - Method in interface org.neo4j.driver.reactive.RxSession
Execute given unit of reactive work in a read reactive transaction with the specified configuration.
readTransaction(TransactionWork<T>) - Method in interface org.neo4j.driver.Session
Execute a unit of work in a managed read transaction.
readTransaction(TransactionWork<T>, TransactionConfig) - Method in interface org.neo4j.driver.Session
Execute a unit of work in a managed read transaction with the specified configuration.
readTransactionAsync(AsyncTransactionWork<CompletionStage<T>>) - Method in interface org.neo4j.driver.async.AsyncSession
Execute given unit of asynchronous work in a read asynchronous transaction.
readTransactionAsync(AsyncTransactionWork<CompletionStage<T>>, TransactionConfig) - Method in interface org.neo4j.driver.async.AsyncSession
Execute given unit of asynchronous work in a read asynchronous transaction with the specified configuration.
Record - Interface in org.neo4j.driver
Container for Cypher result values.
records() - Method in interface org.neo4j.driver.reactive.RxResult
Returns a cold unicast publisher of records.
Records - Class in org.neo4j.driver
Static utility methods for retaining records
Records() - Constructor for class org.neo4j.driver.Records
 
records() - Method in interface org.neo4j.driver.summary.ProfiledPlan
 
relationship() - Method in interface org.neo4j.driver.types.Path.Segment
 
Relationship - Interface in org.neo4j.driver.types
The Relationship interface describes the characteristics of a relationship from a Neo4j graph.
RELATIONSHIP() - Method in interface org.neo4j.driver.types.TypeSystem
 
relationships() - Method in interface org.neo4j.driver.types.Path
Create an iterable over the relationships in this path.
relationshipsCreated() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
relationshipsDeleted() - Method in interface org.neo4j.driver.summary.SummaryCounters
 
requiresRevocationChecking(RevocationCheckingStrategy) - Static method in enum org.neo4j.driver.RevocationCheckingStrategy
 
reset() - Method in interface org.neo4j.driver.Session
Deprecated.
This method should not be used and violates the expected usage pattern of Session objects. They are expected to be not thread-safe and should not be shared between thread. However this method is only useful when Session object is passed to another monitoring thread that calls it when appropriate. It is not useful when Session is used in a single thread because in this case Session.close() can be used. Since version 3.1, Neo4j database allows users to specify maximum transaction execution time and contains procedures to list and terminate running queries. These functions should be used instead of calling this method.
resolve(ServerAddress) - Method in interface org.neo4j.driver.net.ServerAddressResolver
Resolve the given address to a set of other addresses.
resolver() - Method in class org.neo4j.driver.Config
Server address resolver.
Resource - Interface in org.neo4j.driver.util
A Resource is an AutoCloseable that allows introspecting if it already has been closed through its Resource.isOpen() method.
Result - Interface in org.neo4j.driver
The result of running a Cypher query, conceptually a stream of records.
resultAvailableAfter(TimeUnit) - Method in interface org.neo4j.driver.summary.ResultSummary
The time it took the server to make the result available for consumption.
resultConsumedAfter(TimeUnit) - Method in interface org.neo4j.driver.summary.ResultSummary
The time it took the server to consume the result.
ResultConsumedException - Exception in org.neo4j.driver.exceptions
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.
ResultConsumedException(String) - Constructor for exception org.neo4j.driver.exceptions.ResultConsumedException
 
ResultCursor - Interface in org.neo4j.driver.async
The result of asynchronous execution of a Cypher query, conceptually an asynchronous stream of records.
ResultSummary - Interface in org.neo4j.driver.summary
The result summary of running a query.
revocationCheckingStrategy() - Method in class org.neo4j.driver.Config.TrustStrategy
The revocation strategy used for verifying certificates.
RevocationCheckingStrategy - Enum in org.neo4j.driver
Defines strategy for revocation checks.
revocationStrategy() - Method in class org.neo4j.driver.Config.TrustStrategy
rollback() - Method in interface org.neo4j.driver.reactive.RxTransaction
Rolls back the transaction.
rollback() - Method in interface org.neo4j.driver.Transaction
Roll back this current transaction.
rollbackAsync() - Method in interface org.neo4j.driver.async.AsyncTransaction
Rollback this transaction in asynchronous fashion.
routingDriver(Iterable<URI>, AuthToken, Config) - Static method in class org.neo4j.driver.GraphDatabase
Deprecated.
driver should be configured with initial address resolution as documented in the driver manual
run(String, Value) - Method in interface org.neo4j.driver.QueryRunner
Run a query and return a result stream.
run(String, Map<String, Object>) - Method in interface org.neo4j.driver.QueryRunner
Run a query and return a result stream.
run(String, Record) - Method in interface org.neo4j.driver.QueryRunner
Run a query and return a result stream.
run(String) - Method in interface org.neo4j.driver.QueryRunner
Run a query and return a result stream.
run(Query) - Method in interface org.neo4j.driver.QueryRunner
Run a query and return a result stream.
run(String, Value) - Method in interface org.neo4j.driver.reactive.RxQueryRunner
Register running of a query and return a reactive result stream.
run(String, Map<String, Object>) - Method in interface org.neo4j.driver.reactive.RxQueryRunner
Register running of a query and return a reactive result stream.
run(String, Record) - Method in interface org.neo4j.driver.reactive.RxQueryRunner
Register running of a query and return a reactive result stream.
run(String) - Method in interface org.neo4j.driver.reactive.RxQueryRunner
Register running of a query and return a reactive result stream.
run(Query) - Method in interface org.neo4j.driver.reactive.RxQueryRunner
Register running of a query and return a reactive result stream.
run(String, TransactionConfig) - Method in interface org.neo4j.driver.reactive.RxSession
Run a query with parameters in an auto-commit transaction with specified TransactionConfig and return a reactive result stream.
run(String, Map<String, Object>, TransactionConfig) - Method in interface org.neo4j.driver.reactive.RxSession
Run a query with parameters in an auto-commit transaction with specified TransactionConfig and return a reactive result stream.
run(Query, TransactionConfig) - Method in interface org.neo4j.driver.reactive.RxSession
Run a query in an auto-commit transaction with specified configuration and return a reactive result stream.
run(String, TransactionConfig) - Method in interface org.neo4j.driver.Session
Run a query in a managed auto-commit transaction with the specified configuration, and return a result stream.
run(String, Map<String, Object>, TransactionConfig) - Method in interface org.neo4j.driver.Session
Run a query with parameters in a managed auto-commit transaction with the specified configuration, and return a result stream.
run(Query, TransactionConfig) - Method in interface org.neo4j.driver.Session
Run a query in a managed auto-commit transaction with the specified configuration, and return a result stream.
runAsync(String, Value) - Method in interface org.neo4j.driver.async.AsyncQueryRunner
Run a query asynchronously and return a CompletionStage with a result cursor.
runAsync(String, Map<String, Object>) - Method in interface org.neo4j.driver.async.AsyncQueryRunner
Run a query asynchronously and return a CompletionStage with a result cursor.
runAsync(String, Record) - Method in interface org.neo4j.driver.async.AsyncQueryRunner
Run a query asynchronously and return a CompletionStage with a result cursor.
runAsync(String) - Method in interface org.neo4j.driver.async.AsyncQueryRunner
Run a query asynchronously and return a CompletionStage with a result cursor.
runAsync(Query) - Method in interface org.neo4j.driver.async.AsyncQueryRunner
Run a query asynchronously and return a CompletionStage with a result cursor.
runAsync(String, TransactionConfig) - Method in interface org.neo4j.driver.async.AsyncSession
Run a query asynchronously in an auto-commit transaction with the specified configuration and return a CompletionStage with a result cursor.
runAsync(String, Map<String, Object>, TransactionConfig) - Method in interface org.neo4j.driver.async.AsyncSession
Run a query asynchronously in an auto-commit transaction with the specified configuration and return a CompletionStage with a result cursor.
runAsync(Query, TransactionConfig) - Method in interface org.neo4j.driver.async.AsyncSession
Run a query asynchronously in an auto-commit transaction with the specified configuration and return a CompletionStage with a result cursor.
RxQueryRunner - Interface in org.neo4j.driver.reactive
Common interface for components that can execute Neo4j queries using Reactive API.
RxResult - Interface in org.neo4j.driver.reactive
A reactive result provides a reactive way to execute query on the server and receives records back.
rxSession() - Method in interface org.neo4j.driver.Driver
Create a new general purpose RxSession with default session configuration.
rxSession(SessionConfig) - Method in interface org.neo4j.driver.Driver
Create a new RxSession with a specified session configuration.
RxSession - Interface in org.neo4j.driver.reactive
A reactive session is the same as Session except it provides a reactive API.
RxTransaction - Interface in org.neo4j.driver.reactive
Same as Transaction except this reactive transaction exposes a reactive API.
RxTransactionWork<T> - Interface in org.neo4j.driver.reactive
Callback that executes operations against a given RxTransaction.

S

seconds() - Method in interface org.neo4j.driver.types.IsoDuration
Retrieve amount of seconds in this duration.
SecurityException - Exception in org.neo4j.driver.exceptions
Failed to communicate with the server due to security errors.
SecurityException(String, String) - Constructor for exception org.neo4j.driver.exceptions.SecurityException
 
SecurityException(String, Throwable) - Constructor for exception org.neo4j.driver.exceptions.SecurityException
 
server() - Method in interface org.neo4j.driver.summary.ResultSummary
The basic information of the server where the result is obtained from
ServerAddress - Interface in org.neo4j.driver.net
Represents a host and port.
ServerAddressResolver - Interface in org.neo4j.driver.net
A resolver function used by the routing driver to resolve the initial address used to create the driver.
ServerInfo - Interface in org.neo4j.driver.summary
Provides some basic information of the server where the result is obtained from.
ServiceUnavailableException - Exception in org.neo4j.driver.exceptions
An ServiceUnavailableException indicates that the driver cannot communicate with the cluster.
ServiceUnavailableException(String) - Constructor for exception org.neo4j.driver.exceptions.ServiceUnavailableException
 
ServiceUnavailableException(String, Throwable) - Constructor for exception org.neo4j.driver.exceptions.ServiceUnavailableException
 
session() - Method in interface org.neo4j.driver.Driver
Create a new general purpose Session with default session configuration.
session(SessionConfig) - Method in interface org.neo4j.driver.Driver
Create a new Session with a specified session configuration.
Session - Interface in org.neo4j.driver
Provides a context of work for database interactions.
SessionConfig - Class in org.neo4j.driver
The session configurations used to configure a session.
SessionConfig.Builder - Class in org.neo4j.driver
Builder used to configure SessionConfig which will be used to create a session.
SessionExpiredException - Exception in org.neo4j.driver.exceptions
A SessionExpiredException indicates that the session can no longer satisfy the criteria under which it was acquired, e.g.
SessionExpiredException(String) - Constructor for exception org.neo4j.driver.exceptions.SessionExpiredException
 
SessionExpiredException(String, Throwable) - Constructor for exception org.neo4j.driver.exceptions.SessionExpiredException
 
severity() - Method in interface org.neo4j.driver.summary.Notification
The severity level of the notification.
single() - Method in interface org.neo4j.driver.Result
Return the first record in the result, failing if there is not exactly one record left in the stream Calling this method always exhausts the result, even when NoSuchRecordException is thrown.
singleAsync() - Method in interface org.neo4j.driver.async.ResultCursor
Asynchronously return the first record in the result, failing if there is not exactly one record left in the stream.
size() - Method in interface org.neo4j.driver.types.MapAccessor
Retrieve the number of entries in this map
size() - Method in interface org.neo4j.driver.Value
If the underlying value is a collection type, return the number of values in the collection.
slf4j() - Static method in interface org.neo4j.driver.Logging
Create logging implementation that uses SLF4J.
srid() - Method in interface org.neo4j.driver.types.Point
Retrieve identifier of the coordinate reference system for this point.
start() - Method in interface org.neo4j.driver.types.Path.Segment
The node that this segment starts at.
start() - Method in interface org.neo4j.driver.types.Path
 
startNodeId() - Method in interface org.neo4j.driver.types.Relationship
Id of the node where this relationship starts.
strategy() - Method in class org.neo4j.driver.Config.TrustStrategy
Return the strategy type desired.
stream() - Method in interface org.neo4j.driver.Result
Convert this result to a sequential Stream of records.
STRING() - Method in interface org.neo4j.driver.types.TypeSystem
 
SummaryCounters - Interface in org.neo4j.driver.summary
Contains counters for various operations that a query triggered.
supportsMultiDb() - Method in interface org.neo4j.driver.Driver
Returns true if the server or cluster the driver connects to supports multi-databases, otherwise false.
supportsMultiDbAsync() - Method in interface org.neo4j.driver.Driver
Asynchronous check if the server or cluster the driver connects to supports multi-databases.
systemUpdates() - Method in interface org.neo4j.driver.summary.SummaryCounters
 

T

text() - Method in class org.neo4j.driver.Query
 
time() - Method in interface org.neo4j.driver.summary.ProfiledPlan
 
TIME() - Method in interface org.neo4j.driver.types.TypeSystem
 
timedOutToAcquire() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
A counter to record how many times that we've failed to acquire a connection from the pool within configured maximum acquisition timeout set by Config.ConfigBuilder.withConnectionAcquisitionTimeout(long, TimeUnit).
timeout() - Method in class org.neo4j.driver.TransactionConfig
Get the configured transaction timeout.
title() - Method in interface org.neo4j.driver.summary.Notification
Returns a short summary of the notification.
TokenExpiredException - Exception in org.neo4j.driver.exceptions
The provided token has expired.
TokenExpiredException(String, String) - Constructor for exception org.neo4j.driver.exceptions.TokenExpiredException
 
toString() - Method in class org.neo4j.driver.Query
 
toString() - Method in class org.neo4j.driver.SessionConfig
 
toString() - Method in class org.neo4j.driver.TransactionConfig
 
toString() - Method in interface org.neo4j.driver.Value
 
totalAcquisitionTime() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
A counter to record the total acquisition time in milliseconds of all connection acquisition requests since the pool is created.
totalConnectionTime() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
A counter to record the total time in milliseconds spent to establishing new socket connections since the pool is created.
totalInUseCount() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
The total amount of connections that are borrowed outside the pool since the pool is created.
totalInUseTime() - Method in interface org.neo4j.driver.ConnectionPoolMetrics
A counter to record the total time in milliseconds connections are borrowed out of the pool, such as the time spent in user's application code to run cypher queries.
trace(String, Object...) - Method in interface org.neo4j.driver.Logger
Logs binary sent and received by this driver.
Transaction - Interface in org.neo4j.driver
Logical container for an atomic unit of work.
TransactionConfig - Class in org.neo4j.driver
Configuration object containing settings for transactions.
TransactionConfig.Builder - Class in org.neo4j.driver
Builder used to construct transaction configuration objects.
TransactionNestingException - Exception in org.neo4j.driver.exceptions
This exception indicates a user is nesting new transaction with an on-going transaction (unmanaged and/or auto-commit).
TransactionNestingException(String) - Constructor for exception org.neo4j.driver.exceptions.TransactionNestingException
 
TransactionWork<T> - Interface in org.neo4j.driver
Callback that executes operations against a given Transaction.
TransientException - Exception in org.neo4j.driver.exceptions
A TransientException signals a temporary fault that may be worked around by retrying.
TransientException(String, String) - Constructor for exception org.neo4j.driver.exceptions.TransientException
 
trustAllCertificates() - Static method in class org.neo4j.driver.Config.TrustStrategy
Trust strategy for certificates that trust all certificates blindly.
trustCustomCertificateSignedBy(File...) - Static method in class org.neo4j.driver.Config.TrustStrategy
Only encrypted connections to Neo4j instances with certificates signed by a trusted certificate will be accepted.
trustStrategy() - Method in class org.neo4j.driver.Config
 
trustSystemCertificates() - Static method in class org.neo4j.driver.Config.TrustStrategy
Trust strategy for certificates that can be verified through the local system store.
type() - Method in interface org.neo4j.driver.types.Relationship
Return the type of this relationship.
Type - Interface in org.neo4j.driver.types
The type of a Value as defined by the Cypher language
type() - Method in interface org.neo4j.driver.Value
 
TypeSystem - Interface in org.neo4j.driver.types
A listing of all database types this driver can handle.

U

Uncoercible - Exception in org.neo4j.driver.exceptions.value
A Uncoercible exception indicates that the conversion cannot be achieved.
Uncoercible(String, String) - Constructor for exception org.neo4j.driver.exceptions.value.Uncoercible
 
Unsizable - Exception in org.neo4j.driver.exceptions.value
An Unsizable exception indicates that the value does not have a size.
Unsizable(String) - Constructor for exception org.neo4j.driver.exceptions.value.Unsizable
 
UntrustedServerException - Exception in org.neo4j.driver.exceptions
Thrown if the remote server cannot be verified as Neo4j.
UntrustedServerException(String) - Constructor for exception org.neo4j.driver.exceptions.UntrustedServerException
 
userAgent() - Method in class org.neo4j.driver.Config
 

V

value() - Method in interface org.neo4j.driver.util.Pair
 
Value - Interface in org.neo4j.driver
A unit of data that adheres to the Neo4j type system.
value(Object) - Static method in class org.neo4j.driver.Values
 
value(Value...) - Static method in class org.neo4j.driver.Values
 
value(byte...) - Static method in class org.neo4j.driver.Values
 
value(String...) - Static method in class org.neo4j.driver.Values
 
value(boolean...) - Static method in class org.neo4j.driver.Values
 
value(char...) - Static method in class org.neo4j.driver.Values
 
value(long...) - Static method in class org.neo4j.driver.Values
 
value(short...) - Static method in class org.neo4j.driver.Values
 
value(int...) - Static method in class org.neo4j.driver.Values
 
value(double...) - Static method in class org.neo4j.driver.Values
 
value(float...) - Static method in class org.neo4j.driver.Values
 
value(List<Object>) - Static method in class org.neo4j.driver.Values
 
value(Iterable<Object>) - Static method in class org.neo4j.driver.Values
 
value(Iterator<Object>) - Static method in class org.neo4j.driver.Values
 
value(Stream<Object>) - Static method in class org.neo4j.driver.Values
 
value(char) - Static method in class org.neo4j.driver.Values
 
value(String) - Static method in class org.neo4j.driver.Values
 
value(long) - Static method in class org.neo4j.driver.Values
 
value(int) - Static method in class org.neo4j.driver.Values
 
value(double) - Static method in class org.neo4j.driver.Values
 
value(boolean) - Static method in class org.neo4j.driver.Values
 
value(Map<String, Object>) - Static method in class org.neo4j.driver.Values
 
value(LocalDate) - Static method in class org.neo4j.driver.Values
 
value(OffsetTime) - Static method in class org.neo4j.driver.Values
 
value(LocalTime) - Static method in class org.neo4j.driver.Values
 
value(LocalDateTime) - Static method in class org.neo4j.driver.Values
 
value(OffsetDateTime) - Static method in class org.neo4j.driver.Values
 
value(ZonedDateTime) - Static method in class org.neo4j.driver.Values
 
value(Period) - Static method in class org.neo4j.driver.Values
 
value(Duration) - Static method in class org.neo4j.driver.Values
 
ValueException - Exception in org.neo4j.driver.exceptions.value
A ValueException indicates that the client has carried out an operation on values incorrectly.
ValueException(String) - Constructor for exception org.neo4j.driver.exceptions.value.ValueException
 
valueOf(String) - Static method in enum org.neo4j.driver.AccessMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.neo4j.driver.Config.TrustStrategy.Strategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.neo4j.driver.MetricsAdapter
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.neo4j.driver.RevocationCheckingStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.neo4j.driver.summary.QueryType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.neo4j.driver.AccessMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in interface org.neo4j.driver.Bookmark
Returns a read-only set of bookmark strings that this bookmark instance identifies.
values() - Static method in enum org.neo4j.driver.Config.TrustStrategy.Strategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.neo4j.driver.MetricsAdapter
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in interface org.neo4j.driver.Record
Retrieve the values of the underlying map
values() - Static method in enum org.neo4j.driver.RevocationCheckingStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.neo4j.driver.summary.QueryType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in interface org.neo4j.driver.types.MapAccessor
Retrieve all values of the underlying collection
values(Function<Value, T>) - Method in interface org.neo4j.driver.types.MapAccessor
Map and retrieve all values of the underlying collection
Values - Class in org.neo4j.driver
Utility for wrapping regular Java types and exposing them as Value objects, and vice versa.
values(Object...) - Static method in class org.neo4j.driver.Values
 
verifyConnectivity() - Method in interface org.neo4j.driver.Driver
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.
verifyConnectivityAsync() - Method in interface org.neo4j.driver.Driver
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.
version() - Method in interface org.neo4j.driver.summary.ServerInfo
Deprecated.
in 4.3, please use ServerInfo.agent(), ServerInfo.protocolVersion(), or call the dbms.components procedure instead. Method might be removed in the next major release.

W

warn(String, Object...) - Method in interface org.neo4j.driver.Logger
Logs warnings that happened when using the driver.
warn(String, Throwable) - Method in interface org.neo4j.driver.Logger
Logs warnings that happened during using the driver
withBookmarks(Bookmark...) - Method in class org.neo4j.driver.SessionConfig.Builder
Set the initial bookmarks to be used in a session.
withBookmarks(Iterable<Bookmark>) - Method in class org.neo4j.driver.SessionConfig.Builder
Set the initial bookmarks to be used in a session.
withConnectionAcquisitionTimeout(long, TimeUnit) - Method in class org.neo4j.driver.Config.ConfigBuilder
Configure maximum amount of time connection acquisition will attempt to acquire a connection from the connection pool.
withConnectionLivenessCheckTimeout(long, TimeUnit) - Method in class org.neo4j.driver.Config.ConfigBuilder
Pooled connections that have been idle in the pool for longer than this timeout will be tested before they are used again, to ensure they are still live.
withConnectionTimeout(long, TimeUnit) - Method in class org.neo4j.driver.Config.ConfigBuilder
Specify socket connection timeout.
withDatabase(String) - Method in class org.neo4j.driver.SessionConfig.Builder
Sets target database name for queries executed within session.
withDefaultAccessMode(AccessMode) - Method in class org.neo4j.driver.SessionConfig.Builder
Set the type of access required by units of work in this session, e.g.
withDriverMetrics() - Method in class org.neo4j.driver.Config.ConfigBuilder
Enable driver metrics backed by internal basic implementation.
withEncryption() - Method in class org.neo4j.driver.Config.ConfigBuilder
Set to use encrypted traffic.
withEventLoopThreads(int) - Method in class org.neo4j.driver.Config.ConfigBuilder
Configure the event loop thread count.
withFetchSize(long) - Method in class org.neo4j.driver.Config.ConfigBuilder
Specify how many records to fetch in each batch.
withFetchSize(long) - Method in class org.neo4j.driver.SessionConfig.Builder
Specify how many records to fetch in each batch for this session.
withHostnameVerification() - Method in class org.neo4j.driver.Config.TrustStrategy
Enable hostname verification for this trust strategy.
withImpersonatedUser(String) - Method in class org.neo4j.driver.SessionConfig.Builder
Set the impersonated user that the newly created session is going to use for query execution.
withLeakedSessionsLogging() - Method in class org.neo4j.driver.Config.ConfigBuilder
Enable logging of leaked sessions.
withLogging(Logging) - Method in class org.neo4j.driver.Config.ConfigBuilder
Provide a logging implementation for the driver to use.
withMaxConnectionLifetime(long, TimeUnit) - Method in class org.neo4j.driver.Config.ConfigBuilder
Pooled connections older than this threshold will be closed and removed from the pool.
withMaxConnectionPoolSize(int) - Method in class org.neo4j.driver.Config.ConfigBuilder
Configure maximum amount of connections in the connection pool towards a single database.
withMaxTransactionRetryTime(long, TimeUnit) - Method in class org.neo4j.driver.Config.ConfigBuilder
Specify the maximum time transactions are allowed to retry via Session.readTransaction(TransactionWork) and Session.writeTransaction(TransactionWork) methods.
withMetadata(Map<String, Object>) - Method in class org.neo4j.driver.TransactionConfig.Builder
Set the transaction metadata.
withMetricsAdapter(MetricsAdapter) - Method in class org.neo4j.driver.Config.ConfigBuilder
Enable driver metrics with given MetricsAdapter.
withoutCertificateRevocationChecks() - Method in class org.neo4j.driver.Config.TrustStrategy
Configures the Config.TrustStrategy to not carry out OCSP revocation checks on certificates.
withoutDriverMetrics() - Method in class org.neo4j.driver.Config.ConfigBuilder
Disable driver metrics.
withoutEncryption() - Method in class org.neo4j.driver.Config.ConfigBuilder
Set to use unencrypted traffic.
withoutHostnameVerification() - Method in class org.neo4j.driver.Config.TrustStrategy
Disable hostname verification for this trust strategy.
withParameters(Value) - Method in class org.neo4j.driver.Query
 
withParameters(Map<String, Object>) - Method in class org.neo4j.driver.Query
 
withResolver(ServerAddressResolver) - Method in class org.neo4j.driver.Config.ConfigBuilder
Specify a custom server address resolver used by the routing driver to resolve the initial address used to create the driver.
withRoutingFailureLimit(int) - Method in class org.neo4j.driver.Config.ConfigBuilder
Deprecated.
in 1.2 because driver memorizes seed URI used during construction and falls back to it at runtime when all other known router servers failed to respond. Driver is also able to perform DNS lookup for the seed URI during rediscovery. This means updates of cluster members will be picked up if they are reflected in a DNS record. This configuration allowed driver to retry rediscovery procedure and postpone failure. Currently there exists a better way of doing retries via Session.readTransaction(TransactionWork) and Session.writeTransaction(TransactionWork). Method will be removed in the next major release.
withRoutingRetryDelay(long, TimeUnit) - Method in class org.neo4j.driver.Config.ConfigBuilder
Deprecated.
in 1.2 because driver memorizes seed URI used during construction and falls back to it at runtime when all other known router servers failed to respond. Driver is also able to perform DNS lookup for the seed URI during rediscovery. This means updates of cluster members will be picked up if they are reflected in a DNS record. This configuration allowed driver to retry rediscovery procedure and postpone failure. Currently there exists a better way of doing retries via Session.readTransaction(TransactionWork) and Session.writeTransaction(TransactionWork). Method will be removed in the next major release.
withRoutingTablePurgeDelay(long, TimeUnit) - Method in class org.neo4j.driver.Config.ConfigBuilder
Specify how long to wait before purging stale routing tables.
withStrictRevocationChecks() - Method in class org.neo4j.driver.Config.TrustStrategy
Configures the Config.TrustStrategy to carry out strict OCSP revocation checks for revocation status that are stapled to the certificate.
withText(String) - Method in class org.neo4j.driver.Query
 
withTimeout(Duration) - Method in class org.neo4j.driver.TransactionConfig.Builder
Set the transaction timeout.
withTrustStrategy(Config.TrustStrategy) - Method in class org.neo4j.driver.Config.ConfigBuilder
Specify how to determine the authenticity of an encryption certificate provided by the Neo4j instance we are connecting to.
withUpdatedParameters(Value) - Method in class org.neo4j.driver.Query
Create a new query with new parameters derived by updating this' query's parameters using the given updates.
withUserAgent(String) - Method in class org.neo4j.driver.Config.ConfigBuilder
Configure the user_agent field sent to the server to identify the connected client.
withVerifyIfPresentRevocationChecks() - Method in class org.neo4j.driver.Config.TrustStrategy
Configures the Config.TrustStrategy to carry out OCSP revocation checks when the revocation status is stapled to the certificate.
writeTransaction(RxTransactionWork<? extends Publisher<T>>) - Method in interface org.neo4j.driver.reactive.RxSession
Execute given unit of reactive work in a write reactive transaction.
writeTransaction(RxTransactionWork<? extends Publisher<T>>, TransactionConfig) - Method in interface org.neo4j.driver.reactive.RxSession
Execute given unit of reactive work in a write reactive transaction with the specified configuration.
writeTransaction(TransactionWork<T>) - Method in interface org.neo4j.driver.Session
Execute a unit of work in a managed write transaction.
writeTransaction(TransactionWork<T>, TransactionConfig) - Method in interface org.neo4j.driver.Session
Execute a unit of work in a managed write transaction with the specified configuration.
writeTransactionAsync(AsyncTransactionWork<CompletionStage<T>>) - Method in interface org.neo4j.driver.async.AsyncSession
Execute given unit of asynchronous work in a write asynchronous transaction.
writeTransactionAsync(AsyncTransactionWork<CompletionStage<T>>, TransactionConfig) - Method in interface org.neo4j.driver.async.AsyncSession
Execute given unit of asynchronous work in a write asynchronous transaction with the specified configuration.

X

x() - Method in interface org.neo4j.driver.types.Point
Retrieve x coordinate of this point.

Y

y() - Method in interface org.neo4j.driver.types.Point
Retrieve y coordinate of this point.

Z

z() - Method in interface org.neo4j.driver.types.Point
Retrieve z coordinate of this point.
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
Skip navigation links