Class TransactionsConfigBuilder

A class for configuring transactions options.

Inheritance

object

TransactionsConfigBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.Client.Transactions.Config

Assembly: Couchbase.NetClient.dll

Syntax

public class TransactionsConfigBuilder

Methods

Build()

Generate a TransactionsConfig from the values provided.

Declaration

public TransactionsConfig Build()

Returns

Type	Description
TransactionsConfig	A TransactionsConfig that has been initialized with the given values.

CleanupConfig(TransactionCleanupConfig)

Set various parameters controlling how cleanup of lost/abandoned transactions will function.

Declaration

public TransactionsConfigBuilder CleanupConfig(TransactionCleanupConfig cleanupConfig)

Parameters

Type	Name	Description
TransactionCleanupConfig	cleanupConfig

Returns

Type	Description
TransactionsConfigBuilder

Create()

Create an instance of the config.

Declaration

public static TransactionsConfigBuilder Create()

Returns

Type	Description
TransactionsConfigBuilder	An instance of the TransactionsConfigBuilder.

DurabilityLevel(DurabilityLevel)

The writes of all transactions created by this object will be performed with this durability setting.

Declaration

public TransactionsConfigBuilder DurabilityLevel(DurabilityLevel durabilityLevel)

Parameters

Type	Name	Description
DurabilityLevel	durabilityLevel	A value from the DurabilityLevel(DurabilityLevel) enum.

Returns

Type	Description
TransactionsConfigBuilder	The builder.

ExpirationTime(TimeSpan)

Set the ExpirationTime value.

Declaration

public TransactionsConfigBuilder ExpirationTime(TimeSpan expirationTime)

Parameters

Type	Name	Description
TimeSpan	expirationTime	The maximum time that transactions created by this Transactions object can run for, before expiring.

Returns

Type	Description
TransactionsConfigBuilder	The builder.

KeyValueTimeout(TimeSpan)

Set the default timeout used for all KV writes.

Declaration

public TransactionsConfigBuilder KeyValueTimeout(TimeSpan keyValueTimeout)

Parameters

Type	Name	Description
TimeSpan	keyValueTimeout	The default timeout used for all KV writes.

Returns

Type	Description
TransactionsConfigBuilder	The builder.

LoggerFactory(ILoggerFactory)

The ILoggerFactory to be used for logging in the Transactions internals.

Declaration

public TransactionsConfigBuilder LoggerFactory(ILoggerFactory loggerFactory)

Parameters

Type	Name	Description
ILoggerFactory	loggerFactory	The logger factory.

Returns

Type	Description
TransactionsConfigBuilder	The builder.

MetadataCollection(Keyspace)

Set ICouchbaseCollection to use for Active Transaction Record metadata.

Declaration

public TransactionsConfigBuilder MetadataCollection(Keyspace metadataCollection)

Parameters

Type	Name	Description
Keyspace	metadataCollection	The collection to use.

Returns

Type	Description
TransactionsConfigBuilder	The builder.

Remarks

If this is not set, then the metadata collection will be chosen based on the VBucket of the first document modification in the transaction.

QueryConfig(TransactionQueryConfigBuilder)

Configuration builder for values related to Query.

Declaration

public TransactionsConfigBuilder QueryConfig(TransactionQueryConfigBuilder queryConfigBuilder)

Parameters

Type	Name	Description
TransactionQueryConfigBuilder	queryConfigBuilder	A TransactionQueryConfigBuilder to configure query options for transactions.

Returns

Type	Description
TransactionsConfigBuilder	The original TransactionsConfigBuilder.

Extension Methods

Extensions.QueryConfig(TransactionsConfigBuilder, Action<TransactionQueryConfigBuilder>?)