Type Alias IDatabaseLockAdapter

Type declaration

• find:function

  • find(context: IReadableContext, key: string): Promise<null | ILockData>

  • Retrieves the current lock data for a given key. Used for querying lock state without modifying it.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the lock

    Returns Promise<null | ILockData>

    Promise resolving to the lock's owner and expiration data if found, otherwise null

• remove:function

  • remove(
        context: IReadableContext,
        key: string,
    ): Promise<null | ILockExpirationData>

  • Removes a lock from the database regardless of its current owner. Used for administrative cleanup or when the current owner is unavailable.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the lock

    Returns Promise<null | ILockExpirationData>

    Promise resolving to the removed lock's expiration data if a lock existed, otherwise null

• removeIfOwner:function

  • removeIfOwner(
        context: IReadableContext,
        key: string,
        lockId: string,
    ): Promise<null | ILockData>

  • Removes a lock from the database only if owned by the specified lockId. Ownership verification prevents accidental deletion of locks held by others.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the lock
    • lockId: string

      The unique identifier of the expected lock owner

    Returns Promise<null | ILockData>

    Promise resolving to the lock's owner and expiration data if successfully removed, null if the lock wasn't found or the owner didn't match

• transaction:function

  • transaction<TReturn>(
        context: IReadableContext,
        fn: InvokableFn<[transaction: IDatabaseLockTransaction], Promise<TReturn>>,
    ): Promise<TReturn>

  • Executes the provided function within a database transaction. Ensures atomicity of all lock operations (upsert, find) within the transaction. Should use the strictest transaction isolation level to prevent race conditions.

    Type Parameters

    • TReturn

      The return type of the transaction function

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • fn: InvokableFn<[transaction: IDatabaseLockTransaction], Promise<TReturn>>

      Function to execute within the transaction, receives transaction object

    Returns Promise<TReturn>

    Promise resolving to the return value of the transaction function

• updateExpiration:function

  • updateExpiration(
        context: IReadableContext,
        key: string,
        lockId: string,
        expiration: Date,
    ): Promise<number>

  • Updates the expiration time of a lock if owned by the specified lockId. Ownership verification ensures only the lock owner can extend the lock.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the lock
    • lockId: string

      The unique identifier of the expected lock owner
    • expiration: Date

      The new date and time when the lock should expire

    Returns Promise<number>

    Promise resolving to the number of locks updated (1 if successful, 0 if not found or ownership mismatch)