Type Alias IDatabaseCacheAdapter<TType>

Type declaration

• find:function

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

  • Retrieves a cached value by key. Returns the complete cache entry with value and expiration, or null if not found.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The cache key identifier

    Returns Promise<null | ICacheData<TType>>

    Cache entry with value and expiration, or null if not found.

• removeAll:function

  • removeAll(context: IReadableContext): Promise<void>

  • Removes all entries from the cache. Complete cache flush operation.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation

    Returns Promise<void>

    Void (always succeeds)

• removeByKeyPrefix:function

  • removeByKeyPrefix(context: IReadableContext, prefix: string): Promise<void>

  • Removes all cache entries whose keys start with the given prefix. Useful for clearing related cache entries (e.g., all user data: "user:*").

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • prefix: string

      Key prefix to match (e.g., "user:123:" for all data for user 123)

    Returns Promise<void>

    Void (always succeeds)

• removeMany:function

  • removeMany(
        context: IReadableContext,
        keys: string[],
    ): Promise<ICacheDataExpiration[]>

  • Removes multiple specific cache entries by key. Silently ignores missing keys.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • keys: string[]

      Array of cache key identifiers to delete

    Returns Promise<ICacheDataExpiration[]>

    Array of expiration info for all removed entries

• transaction:function

  • transaction<TValue>(
        context: IReadableContext,
        trxFn: InvokableFn<
            [trx: IDatabaseCacheTransaction<TType>],
            Promise<TValue>,
        >,
    ): Promise<TValue>

  • Executes a function within a database transaction. Ensures all cache operations in the function are atomic and isolated.

    Type Parameters

    • TValue

      Return type of the transaction function

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • trxFn: InvokableFn<[trx: IDatabaseCacheTransaction<TType>], Promise<TValue>>

      Async function receiving transaction object, returns value of any type

    Returns Promise<TValue>

    The value returned by the transaction function

    Throws

    Error if transaction fails or is rolled back

• update:function

  • update(
        context: IReadableContext,
        key: string,
        value: TType,
    ): Promise<null | ICacheDataExpiration>

  • Updates the value for an existing cache key. Returns null if the key doesn't exist (use upsert for auto-create).

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The cache key to update
    • value: TType

      The new value to cache

    Returns Promise<null | ICacheDataExpiration>

    Expiration info of the updated entry, or null if key not found