Class DbQueryResultCache

Caches query result into current database, into separate table called "query-result-cache".

Hierarchy

DbQueryResultCache

Implements

QueryResultCache

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DbQueryResultCache(connection: Connection): DbQueryResultCache

- Defined in cache/DbQueryResultCache.ts:22
Parameters
- connection: Connection
Returns DbQueryResultCache

Properties

Protected connection

connection: Connection

Private queryResultCacheTable

queryResultCacheTable: string

Methods

clear

clear(queryRunner: QueryRunner): Promise<void>

- Defined in cache/DbQueryResultCache.ts:200
Clears everything stored in the cache.

Parameters
- queryRunner: QueryRunner
Returns Promise<void>

connect

connect(): Promise<void>

Implementation of QueryResultCache.connect
- Defined in cache/DbQueryResultCache.ts:41
Creates a connection with given cache provider.

Returns Promise<void>

disconnect

disconnect(): Promise<void>

Implementation of QueryResultCache.disconnect
- Defined in cache/DbQueryResultCache.ts:47
Disconnects with given cache provider.

Returns Promise<void>

getFromCache

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

Implementation of QueryResultCache.getFromCache
- Defined in cache/DbQueryResultCache.ts:110
Caches given query result. Returns cache result if found. Returns undefined if result is not cached.

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

Protected getQueryRunner

getQueryRunner(queryRunner: QueryRunner | undefined): QueryRunner

- Defined in cache/DbQueryResultCache.ts:224
Gets a query runner to work with.

Parameters
- queryRunner: QueryRunner | undefined
Returns QueryRunner

isExpired

isExpired(savedCache: QueryResultCacheOptions): boolean

Implementation of QueryResultCache.isExpired
- Defined in cache/DbQueryResultCache.ts:142
Checks if cache is expired or not.

Parameters
- savedCache: QueryResultCacheOptions
Returns boolean

remove

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

Implementation of QueryResultCache.remove
- Defined in cache/DbQueryResultCache.ts:207
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>

Implementation of QueryResultCache.storeInCache
- Defined in cache/DbQueryResultCache.ts:149
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>

Implementation of QueryResultCache.synchronize
- Defined in cache/DbQueryResultCache.ts:53
Creates table for storing cache if it does not exist yet.

Parameters
- Optional queryRunner: QueryRunner
Returns Promise<void>

Generated using TypeDoc