Class TransactionConfigBuilder

Namespace

Neo4j.Driver

Assembly

Neo4j.Driver.dll

The builder to create a TransactionConfig

public sealed class TransactionConfigBuilder

Inheritance

object

TransactionConfigBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ValueExtensions.As<T>(object)

ValueExtensions.As<T>(object, T)

Methods

WithMetadata(IDictionary<string, object>)

The transaction metadata. Specified metadata will be attached to the executing transaction and visible in the output of

dbms.listQueries

and

dbms.listTransactions

procedures. It will also get logged to the

query.log

. Transactions starting with this TransactionConfig This functionality makes it easier to tag transactions and is equivalent to

dbms.setTXMetaData

procedure. Leave this field unmodified to use default timeout configured on database.

WithTimeout(TimeSpan?)

Sets the transaction timeout. Transactions that execute longer than the configured timeout will be terminated by the database. This functionality allows user code to limit query/transaction execution time. The specified timeout overrides the default timeout configured in the database using the

db.transaction.timeout

setting (

dbms.transaction.timeout

before Neo4j 5.0). Values higher than

db.transaction.timeout

will be

ignored and will fall back to default for server versions between 4.2 and 5.2 (inclusive). Leave this field unmodified or set it to

null

to use the default timeout configured on the server. A timeout of zero will make the transaction execute indefinitely.

If the timeout is not an exact number of milliseconds, it will be rounded up to the next millisecond.