Class QueryCache

Index

Constructors

Properties

deepCloneResults entries immutableResults

Methods

clear get getOrSet prepareRecords queryHash

Constructors

constructor

new QueryCache(): QueryCache
Returns QueryCache

Properties

`Private`deepCloneResults

deepCloneResults: boolean = false

`Private` `Readonly`entries

entries: Map<string, QueryCacheEntry> = ...

`Private`immutableResults

immutableResults: boolean = false

Methods

clear

clear(objectType?: string): void
Delete all cached entries for all or just the specified object type
Parameters
- OptionalobjectType: string
  Object type to clear the cache for
Returns void
- Defined in packages/salesforce/src/queryCache.ts:21

get

get<T>(soql: string): undefined | T[] | Promise<T[]>
Get the records/result associated to the specified SOQL or execute the query.

Returns a shallow copy of the cached result so that the caller can modify the result without affecting the cache.
Type Parameters
- T
Parameters
- soql: string
  SOQL query
Returns undefined | T[] | Promise<T[]>
Promise of the array pointing to the records retrieved or undefined if the query is not cached
- Defined in packages/salesforce/src/queryCache.ts:41

getOrSet

getOrSet<T>(soql: string, records: () => Promise<T[]>): T[] | Promise<T[]>
Get the records/result associated to the specified SOQL or execute the query.

Returns a shallow copy of the cached result so that the caller can modify the result without affecting the cache.
Type Parameters
- T
Parameters
- soql: string
  SOQL query
- records: () => Promise<T[]>
  executor to retrieve the records
Returns T[] | Promise<T[]>
Promise of the array pointing to the records retrieved
- Defined in packages/salesforce/src/queryCache.ts:57

`Private`prepareRecords

prepareRecords<T>(records: T[] | Promise<T[]>): any
Type Parameters
- T
Parameters
- records: T[] | Promise<T[]>
Returns any
- Defined in packages/salesforce/src/queryCache.ts:85

`Private`queryHash

queryHash(soql: string | SalesforceQueryData): string
Calculate a unique hash for the specified query by sorting the query fields, order and group-by clauses to create a unique key that represents the query being executed best
Parameters
- soql: string | SalesforceQueryData
  SOQL
Returns string
unique SHA1 hash of the query that can be used as cache-entry
- Defined in packages/salesforce/src/queryCache.ts:110