Interface QueryResultCache

Implementations of this interface provide different strategies to cache query builder results.

Hierarchy

QueryResultCache

Implemented by

Index

Methods

Methods

clear

clear(queryRunner?: QueryRunner): Promise<void>

- Defined in cache/QueryResultCache.ts:42
Clears everything stored in the cache.

Parameters
- Optional queryRunner: QueryRunner
Returns Promise<void>

connect

connect(): Promise<void>

- Defined in cache/QueryResultCache.ts:12
Creates a connection with given cache provider.

Returns Promise<void>

disconnect

disconnect(): Promise<void>

- Defined in cache/QueryResultCache.ts:17
Closes a connection with given cache provider.

Returns Promise<void>

getFromCache

getFromCache(options: QueryResultCacheOptions, queryRunner?: QueryRunner): Promise<QueryResultCacheOptions | undefined>

- Defined in cache/QueryResultCache.ts:27
Caches given query result.

Parameters
- options: QueryResultCacheOptions
- Optional queryRunner: QueryRunner
Returns Promise<QueryResultCacheOptions | undefined>

isExpired

isExpired(savedCache: QueryResultCacheOptions): boolean

- Defined in cache/QueryResultCache.ts:37
Checks if cache is expired or not.

Parameters
- savedCache: QueryResultCacheOptions
Returns boolean

remove

remove(identifiers: string[], queryRunner?: QueryRunner): Promise<void>

- Defined in cache/QueryResultCache.ts:47
Removes all cached results by given identifiers from cache.

Parameters
- identifiers: string[]
- Optional queryRunner: QueryRunner
Returns Promise<void>

storeInCache

storeInCache(options: QueryResultCacheOptions, savedCache: QueryResultCacheOptions | undefined, queryRunner?: QueryRunner): Promise<void>

- Defined in cache/QueryResultCache.ts:32
Stores given query result in the cache.

Parameters
- options: QueryResultCacheOptions
- savedCache: QueryResultCacheOptions | undefined
- Optional queryRunner: QueryRunner
Returns Promise<void>

synchronize

synchronize(queryRunner?: QueryRunner): Promise<void>

- Defined in cache/QueryResultCache.ts:22
Performs operations needs to be created during schema synchronization.

Parameters
- Optional queryRunner: QueryRunner
Returns Promise<void>

Generated using TypeDoc