Module org.neo4j.driver

Package org.neo4j.driver

Class QueryConfig

java.lang.Object

org.neo4j.driver.QueryConfig

All Implemented Interfaces:

Serializable

public final class QueryConfig
extends Object
implements Serializable

Query configuration used by Driver.executableQuery(String) and its variants.

Since:

5.5

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	QueryConfig.Builder	Builder used to configure QueryConfig which will be used to execute a query.

Method Summary

Modifier and Type	Method	Description
Optional<BookmarkManager>	bookmarkManager(BookmarkManager defaultBookmarkManager)	Returns bookmark manager for the query.
static QueryConfig.Builder	builder()	Creates a new QueryConfig.Builder used to construct a configuration object with default implementation returning EagerResult.
Optional<String>	database()	Returns target database for the query.
static QueryConfig	defaultConfig()	Returns default config value.
boolean	equals(Object o)
int	hashCode()
Optional<String>	impersonatedUser()	Returns impersonated user for the query.
RoutingControl	routing()	Returns routing mode for the query.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

defaultConfig

public static QueryConfig defaultConfig()

Returns default config value.

Returns:

config value

builder

public static QueryConfig.Builder builder()

Creates a new QueryConfig.Builder used to construct a configuration object with default implementation returning EagerResult.

Returns:

a query configuration builder

routing

public RoutingControl routing()

Returns routing mode for the query.

Returns:

routing mode

database

public Optional<String> database()

Returns target database for the query.

Returns:

target database

impersonatedUser

public Optional<String> impersonatedUser()

Returns impersonated user for the query.

Returns:

impersonated user

bookmarkManager

public Optional<BookmarkManager> bookmarkManager(BookmarkManager defaultBookmarkManager)

Returns bookmark manager for the query.

Parameters:

defaultBookmarkManager - default bookmark manager to use when none has been configured explicitly,

Returns:

bookmark manager

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object