transact

Call Signature

transact<T>(fn): Promise<number>

Defined in: .work/repos/olmdb/src/olmdb.ts:294

Executes a function within a database transaction context.

All database operations (get, put, del) must be performed within a transaction. Transactions are automatically committed if the function completes successfully, or aborted if an error occurs. Failed transactions may be automatically retried up to 6 times in case of validation conflicts.

Type Parameters

T

T

The return type of the transaction function.

Parameters

fn

() => Promise<typeof RETURN_COMMIT_SEQ>

The (optionally asynchronous) function to execute within the transaction context.

Returns

Promise<number>

A promise that resolves with the function’s return value. If the function returns the special symbol RETURN_COMMIT_SEQ, the promise resolves with the commit sequence number instead.

Throws

If nested transactions are attempted.

Throws

With code “RACING_TRANSACTION” if the transaction fails after retries due to conflicts.

Throws

With code “TRANSACTION_FAILED” if the transaction fails for other reasons.

Throws

With code “TXN_LIMIT” if maximum number of transactions is reached.

Throws

With code “LMDB-{code}” for LMDB-specific errors.

Example

const result = await transact(() => {
  const value = get(keyBytes);
  if (value) {
    put(keyBytes, newValueBytes);
  }
  return value;
});

Call Signature

transact<T>(fn): Promise<number>

Defined in: .work/repos/olmdb/src/olmdb.ts:295

Executes a function within a database transaction context.

All database operations (get, put, del) must be performed within a transaction. Transactions are automatically committed if the function completes successfully, or aborted if an error occurs. Failed transactions may be automatically retried up to 6 times in case of validation conflicts.

Type Parameters

T

T

The return type of the transaction function.

Parameters

fn

() => typeof RETURN_COMMIT_SEQ

The (optionally asynchronous) function to execute within the transaction context.

Returns

Promise<number>

A promise that resolves with the function’s return value. If the function returns the special symbol RETURN_COMMIT_SEQ, the promise resolves with the commit sequence number instead.

Throws

If nested transactions are attempted.

Throws

With code “RACING_TRANSACTION” if the transaction fails after retries due to conflicts.

Throws

With code “TRANSACTION_FAILED” if the transaction fails for other reasons.

Throws

With code “TXN_LIMIT” if maximum number of transactions is reached.

Throws

With code “LMDB-{code}” for LMDB-specific errors.

Example

const result = await transact(() => {
  const value = get(keyBytes);
  if (value) {
    put(keyBytes, newValueBytes);
  }
  return value;
});

Call Signature

transact<T>(fn): Promise<T>

Defined in: .work/repos/olmdb/src/olmdb.ts:296

Executes a function within a database transaction context.

All database operations (get, put, del) must be performed within a transaction. Transactions are automatically committed if the function completes successfully, or aborted if an error occurs. Failed transactions may be automatically retried up to 6 times in case of validation conflicts.

Type Parameters

T

T

The return type of the transaction function.

Parameters

fn

() => Promise<T>

The (optionally asynchronous) function to execute within the transaction context.

Returns

Promise<T>

A promise that resolves with the function’s return value. If the function returns the special symbol RETURN_COMMIT_SEQ, the promise resolves with the commit sequence number instead.

Throws

If nested transactions are attempted.

Throws

With code “RACING_TRANSACTION” if the transaction fails after retries due to conflicts.

Throws

With code “TRANSACTION_FAILED” if the transaction fails for other reasons.

Throws

With code “TXN_LIMIT” if maximum number of transactions is reached.

Throws

With code “LMDB-{code}” for LMDB-specific errors.

Example

const result = await transact(() => {
  const value = get(keyBytes);
  if (value) {
    put(keyBytes, newValueBytes);
  }
  return value;
});

Call Signature

transact<T>(fn): Promise<T>

Defined in: .work/repos/olmdb/src/olmdb.ts:297

Executes a function within a database transaction context.

All database operations (get, put, del) must be performed within a transaction. Transactions are automatically committed if the function completes successfully, or aborted if an error occurs. Failed transactions may be automatically retried up to 6 times in case of validation conflicts.

Type Parameters

T

T

The return type of the transaction function.

Parameters

fn

() => T

The (optionally asynchronous) function to execute within the transaction context.

Returns

Promise<T>

A promise that resolves with the function’s return value. If the function returns the special symbol RETURN_COMMIT_SEQ, the promise resolves with the commit sequence number instead.

Throws

If nested transactions are attempted.

Throws

With code “RACING_TRANSACTION” if the transaction fails after retries due to conflicts.

Throws

With code “TRANSACTION_FAILED” if the transaction fails for other reasons.

Throws

With code “TXN_LIMIT” if maximum number of transactions is reached.

Throws

With code “LMDB-{code}” for LMDB-specific errors.

Example

const result = await transact(() => {
  const value = get(keyBytes);
  if (value) {
    put(keyBytes, newValueBytes);
  }
  return value;
});