Type Alias IDatabaseWriterLockTransaction

Type declaration

• find:function

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

  • Retrieves the current writer lock data for a given key.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the shared lock

    Returns Promise<null | IWriterLockData>

    Lock data with owner and expiration if found, otherwise null

• remove:function

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

  • Removes the writer lock regardless of current owner. Used for administrative cleanup or forced unlock.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the shared lock to remove

    Returns Promise<null | IWriterLockExpirationData>

    Expiration data of the removed lock, or null if not found

• removeIfOwner:function

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

  • Removes the writer lock only if owned by the specified lock ID. Ensures only the lock holder can release it.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the shared lock
    • lockId: string

      Expected owner's lock identifier

    Returns Promise<null | IWriterLockData>

    Lock data if successfully removed, null if not found or owner mismatch

• updateExpiration:function

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

  • Extends the writer lock expiration if owned by the specified lock ID. Refreshes the lock hold period (heartbeat/keep-alive).

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the shared lock
    • lockId: string

      Expected owner's lock identifier
    • expiration: Date

      New expiration time

    Returns Promise<number>

    Number >= 1 if updated, 0 if not found or owner mismatch

• upsert:function

  • upsert(
        context: IReadableContext,
        key: string,
        lockId: string,
        expiration: null | Date,
    ): Promise<void>

  • Creates a new writer lock or updates the existing one. Stores the lock owner and expiration state atomically.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the shared lock
    • lockId: string

      Unique identifier of the lock owner/acquirer
    • expiration: null | Date

      When the lock expires, or null for indefinite

    Returns Promise<void>