IFdbTransactionOptions

Namespace: FoundationDB.Client · interface

Helper that can set various options on transactions

Properties

ApiVersion

int ApiVersion { get; }

API version of this transaction

MaxRetryDelay

int MaxRetryDelay { get; set; }

Maximum amount of back-off delay incurred in the call to onError if the error is retry-able. Defaults to 1000 ms. Valid parameter values are [0, int.MaxValue]. If the maximum retry delay is less than the current retry delay of the transaction, then the current retry delay will be clamped to the maximum retry delay.

RetryLimit

int RetryLimit { get; set; }

Maximum number of retries after which additional calls to onError will throw the most recently seen error code. Valid parameter values are [-1, int.MaxValue]. If set to -1, will disable the retry limit.

Timeout

int Timeout { get; set; }

Timeout in milliseconds which, when elapsed, will cause the transaction automatically to be cancelled. Valid parameter values are [0, int.MaxValue]. If set to 0, will disable all timeouts. All pending and any future uses of the transaction will throw an exception. The transaction can be used again after it is reset.

Tracing

FdbTracingOptions Tracing { get; set; }

Tracing options for this transaction.

Methods

SetOption

IFdbTransactionOptions SetOption(FdbTransactionOption option)

Sets an option on this transaction that does not take any parameter

  • option — Option to set

IFdbTransactionOptions SetOption(FdbTransactionOption option, long value)

Sets an option on this transaction that takes an integer value

  • option — Option to set
  • value — Value of the parameter

IFdbTransactionOptions SetOption(FdbTransactionOption option, ReadOnlySpan<char> value)

Sets an option on this transaction that takes a string value

  • option — Option to set
  • value — Value of the parameter (can be null)

IFdbTransactionOptions SetOption(FdbTransactionOption option, ReadOnlySpan<byte> value)

Sets an option on this transaction that takes a byte array value

  • option — Option to set
  • value — Value of the parameter (can be null)