Method Driver

Namespace

Neo4j.Driver

Assembly

Neo4j.Driver.dll

Driver(string)

Returns a driver for a Neo4j instance with default configuration settings and disabled authentication.

public static IDriver Driver(string uri)

Parameters

uri string

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

Returns

IDriver

A new IDriver instance specified by the uri.

Remarks

Ensure you provide the protocol for the uri.

Exceptions

ArgumentNullException

Thrown if uri is null.

Driver(Uri)

Returns a driver for a Neo4j instance with default configuration settings and disabled authentication.

public static IDriver Driver(Uri uri)

Parameters

uri Uri

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

Returns

IDriver

A new IDriver instance specified by the uri.

Remarks

Ensure you provide the protocol for the uri.

Exceptions

ArgumentNullException

Thrown if uri is null.

Driver(string, Action<ConfigBuilder>)

Returns a driver for a Neo4j instance with custom configuration and disabled authentication.

public static IDriver Driver(string uri, Action<ConfigBuilder> action)

Parameters

uri string

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

action Action<ConfigBuilder>

Specifies how to build a driver configuration Config, using ConfigBuilder. If set to null, then no modification will be carried out and the default driver configurations Config will be used when creating the driver.

Returns

IDriver

A new IDriver instance specified by the uri.

Remarks

Ensure you provide the protocol for the uri.

Exceptions

ArgumentNullException

Thrown if uri is null.

Driver(Uri, Action<ConfigBuilder>)

Returns a driver for a Neo4j instance with custom configuration and disabled authentication.

public static IDriver Driver(Uri uri, Action<ConfigBuilder> action)

Parameters

uri Uri

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

action Action<ConfigBuilder>

Specifies how to build a driver configuration Config, using ConfigBuilder. If set to null, then no modification will be carried out and the default driver configurations Config will be used when creating the driver.

Returns

IDriver

A new IDriver instance specified by the uri.

Remarks

Ensure you provide the protocol for the uri.

Exceptions

ArgumentNullException

Thrown if uri is null.

Driver(string, IAuthToken)

Returns a driver for a Neo4j instance with default configuration settings.

public static IDriver Driver(string uri, IAuthToken authToken)

Parameters

uri string

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

authToken IAuthToken

Authentication to use, AuthTokens.

Returns

IDriver

A new IDriver instance specified by the uri.

Remarks

Ensure you provide the protocol for the uri.

Exceptions

ArgumentNullException

Thrown if uri is null.

Driver(Uri, IAuthToken)

Returns a driver for a Neo4j instance with default configuration settings.

public static IDriver Driver(Uri uri, IAuthToken authToken)

Parameters

uri Uri

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

authToken IAuthToken

Authentication to use, AuthTokens.

Returns

IDriver

A new IDriver instance specified by the uri.

Remarks

Ensure you provide the protocol for the uri.

Exceptions

ArgumentNullException

Thrown if uri is null.

Driver(Uri, IAuthTokenManager)

Returns a driver for a Neo4j instance with default configuration settings.

public static IDriver Driver(Uri uri, IAuthTokenManager authTokenManager)

Parameters

uri Uri

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

authTokenManager IAuthTokenManager

The IAuthTokenManager to use for authentication.

Returns

IDriver

A new IDriver instance.

Driver(string, IAuthToken, Action<ConfigBuilder>)

Returns a driver for a Neo4j instance with custom configuration.

public static IDriver Driver(string uri, IAuthToken authToken, Action<ConfigBuilder> action)

Parameters

uri string

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

authToken IAuthToken

Authentication to use, AuthTokens.

action Action<ConfigBuilder>

Specifies how to build a driver configuration Config, using ConfigBuilder. If set to null, then no modification will be carried out and the default driver configurations Config will be used when creating the driver.

Returns

IDriver

A new driver to the database instance specified by the uri.

Driver(string, IAuthTokenManager, Action<ConfigBuilder>)

Returns a driver for a Neo4j instance with custom configuration.

public static IDriver Driver(string uri, IAuthTokenManager authTokenManager, Action<ConfigBuilder> action)

Parameters

uri string

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

authTokenManager IAuthTokenManager

The IAuthTokenManager to use for authentication.

action Action<ConfigBuilder>

Specifies how to build a driver configuration Config, using ConfigBuilder. If set to null, then no modification will be carried out and the default driver configurations Config will be used when creating the driver.

Returns

IDriver

A new IDriver instance.

Driver(Uri, IAuthToken, Action<ConfigBuilder>)

Returns a driver for a Neo4j instance with custom configuration.

public static IDriver Driver(Uri uri, IAuthToken authToken, Action<ConfigBuilder> action)

Parameters

uri Uri

The URI to the Neo4j instance. Should be in the form neo4j://<server location>:<port>. If port is not supplied the default of 7687 will be used.

authToken IAuthToken

Authentication to use, AuthTokens.

action Action<ConfigBuilder>

Defines how to build a driver configuration Config using ConfigBuilder . If set to null, then no modification will be carried out on the build. As a result, a default config with default settings will be used Config when creating the new driver.

Returns

IDriver

A new driver to the database instance specified by the uri.

Driver(Uri, IAuthTokenManager, Action<ConfigBuilder>)

Returns a driver for a Neo4j instance with custom configuration.

public static IDriver Driver(Uri uri, IAuthTokenManager authTokenManager, Action<ConfigBuilder> action)

Parameters

uri Uri

The URI to the Neo4j instance. Should be in the form protocol://<server location>:<port>. If port is not supplied the default of 7687 will be used. The supported protocols in URI could either be bolt or neo4j. The protocol bolt should be used when creating a driver connecting to the Neo4j instance directly. The protocol neo4j should be used when creating a driver with built-in routing.

authTokenManager IAuthTokenManager

The IAuthTokenManager to use for authentication.

action Action<ConfigBuilder>

Specifies how to build a driver configuration Config, using ConfigBuilder. If set to null, then no modification will be carried out and the default driver configurations Config will be used when creating the driver.

Returns

IDriver

A new IDriver instance.