Type alias TransactionOptions

TransactionOptions: {
    allowDirtyRead?: boolean;
    allowImplicit?: boolean;
    lockTimeout?: number;
    maxTransactionSize?: number;
    waitForSync?: boolean;
}

Options for how the transaction should be performed.

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.

  • Optional allowImplicit?: boolean

    Whether the transaction may read from collections not specified for this transaction. If set to false, accessing any collections not specified will result in the transaction being aborted to avoid potential deadlocks.

    Default: true.

  • Optional lockTimeout?: number

    Determines how long the database will wait while attempting to gain locks on collections used by the transaction before timing out.

  • Optional maxTransactionSize?: number

    (RocksDB only.) Determines the transaction size limit in bytes.

  • Optional waitForSync?: boolean

    Determines whether to force the transaction to write all data to disk before returning.

Settings

Theme

Generated using TypeDoc