Type Alias IDatabaseSemaphoreTransaction

Type declaration

• findSemaphore:function

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

  • Retrieves semaphore configuration by key. Returns the limit (max concurrent slots) or null if semaphore doesn't exist.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The semaphore identifier (e.g., "api-rate-limit", "db-connection-pool")

    Returns Promise<null | ISemaphoreData>

    Semaphore config with limit, or null if not found

• findSlots:function

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

  • Retrieves all active slots (acquired requests) for a semaphore. Returns empty array if semaphore has no slots or doesn't exist. Includes expired slots (not auto-cleaned until explicitly removed).

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The semaphore identifier

    Returns Promise<ISemaphoreSlotData[]>

    Array of slot data with ids and expirations

• upsertSemaphore:function

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

  • Creates new semaphore or updates existing semaphore limit. Idempotent: calling multiple times with same limit is safe.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The semaphore identifier
    • limit: number

      Maximum number of concurrent slots

    Returns Promise<void>

    Void (always succeeds)

• upsertSlot:function

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

  • Creates new slot or updates existing slot expiration. Called when a request acquires a slot (with expiration time). Idempotent: updating same slot's expiration is safe.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The semaphore identifier
    • slotId: string

      Unique slot identifier (generated by consumer)
    • expiration: null | Date

      When slot expires and becomes available again, or null for no expiration

    Returns Promise<void>

    Void (always succeeds)