Type Alias IDatabaseReaderSemaphoreTransaction

Type declaration

• findSemaphore:function

  • findSemaphore(
        context: IReadableContext,
        key: string,
    ): Promise<null | IReaderSemaphoreData>

  • Retrieves the reader semaphore configuration (limit) for a given key.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The shared lock identifier

    Returns Promise<null | IReaderSemaphoreData>

    Semaphore config with limit, or null if not found

• findSlots:function

  • findSlots(
        context: IReadableContext,
        key: string,
    ): Promise<IReaderSemaphoreSlotData[]>

  • Retrieves all reader slots for a given shared lock. Returns empty array if no readers or shared lock doesn't exist. Includes expired slots until they are explicitly removed.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The shared lock identifier

    Returns Promise<IReaderSemaphoreSlotData[]>

    Array of reader slot data with IDs and expirations

• removeAllSlots:function

  • removeAllSlots(
        context: IReadableContext,
        key: string,
    ): Promise<IReaderSemaphoreSlotExpirationData[]>

  • Removes all reader slots for a given shared lock. Used for cleanup or reset operations.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The shared lock identifier

    Returns Promise<IReaderSemaphoreSlotExpirationData[]>

    Array of expiration data for all removed slots

• removeSlot:function

  • removeSlot(
        context: IReadableContext,
        key: string,
        slotId: string,
    ): Promise<null | IReaderSemaphoreSlotExpirationData>

  • Removes a specific reader slot, releasing it for other readers.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The shared lock identifier
    • slotId: string

      The reader slot identifier to remove

    Returns Promise<null | IReaderSemaphoreSlotExpirationData>

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

• updateExpiration:function

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

  • Extends a reader slot's expiration if it hasn't expired yet. Heartbeat/keep-alive mechanism for long-running readers.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The shared lock identifier
    • slotId: string

      The reader slot identifier to extend
    • expiration: Date

      New expiration time

    Returns Promise<number>

    Number > 0 if updated, 0 if slot not found or already expired

• upsertSemaphore:function

  • upsertSemaphore(
        context: IReadableContext,
        key: string,
        limit: number,
    ): Promise<void>

  • Creates or updates the reader semaphore configuration. Sets the maximum number of concurrent readers allowed.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The shared lock identifier
    • limit: number

      Maximum concurrent reader slots

    Returns Promise<void>

• upsertSlot:function

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

  • Creates or updates a reader slot within the semaphore. Called when a reader acquires a slot.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The shared lock identifier
    • lockId: string

      Unique identifier for this reader slot
    • expiration: null | Date

      When the slot expires, or null for indefinite

    Returns Promise<void>