Class CacheManager

public
Defined in: ../store/src/-private/managers/cache-manager.ts:14
Module: @ember-data/store

The CacheManager wraps a Cache enforcing that only the public API surface area is exposed.

Hence, it is the value of Store.cache, wrapping the cache instance returned by Store.createCache.

It handles translating between cache versions when necessary, for instance when a Store is configured to use both a v1 and a v2 cache depending on some heuristic.

Starting with the v2 spec, the cache is designed such that it must be implemented as a singleton.

Show:

changedAttrs (identifier) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:371

identifier
returns

Query the cache for the changed attributes of a resource.

changedRelationships (identifier) Map<string, RelationshipDiff> public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:410

identifier
StableRecordIdentifier
returns
Map<string, RelationshipDiff>

Query the cache for the changes to relationships of a resource.

Returns a map of relationship names to RelationshipDiff objects.

type RelationshipDiff =
 | {
     kind: 'collection';
     remoteState: StableRecordIdentifier[];
     additions: Set<StableRecordIdentifier>;
     removals: Set<StableRecordIdentifier>;
     localState: StableRecordIdentifier[];
     reordered: boolean;
   }
 | {
     kind: 'resource';
     remoteState: StableRecordIdentifier | null;
     localState: StableRecordIdentifier | null;
   };

clientDidCreate (identifier, options) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:277

identifier
options

[LIFECYCLE] Signal to the cache that a new record has been instantiated on the client

It returns properties from options that should be set on the record during the create process. This return value behavior is deprecated.

commitWasRejected (identifier, errors) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:317

identifier
errors

[LIFECYCLE] Signals to the cache that a resource was update via a save transaction failed.

didCommit (identifier, data) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:304

identifier
data

[LIFECYCLE] Signals to the cache that a resource was successfully updated as part of a save transaction.

diff public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:197

Generate the list of changes applied to all record in the store.

Each individual resource or document that has been mutated should be described as an individual Change entry in the returned array.

A Change is described by an object containing up to three properties: (1) the identifier of the entity that changed; (2) the op code of that change being one of upsert or remove, and if the op is upsert a patch containing the data to merge into the cache for the given entity.

This patch is opaque to the Store but should be understood by the Cache and may expect to be utilized by an Adapter when generating data during a save operation.

It is generally recommended that the patch contain only the updated state, ignoring fields that are unchanged

interface Change {
 identifier: StableRecordIdentifier | StableDocumentIdentifier;
 op: 'upsert' | 'remove';
 patch?: unknown;
}

dump Promise<ReadableStream> public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:237

returns
Promise<ReadableStream>

Serialize the entire contents of the Cache into a Stream which may be fed back into a new instance of the same Cache via cache.hydrate.

fork public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:166

returns

Promise

Create a fork of the cache from the current state.

Applications should typically not call this method themselves, preferring instead to fork at the Store level, which will utilize this method to fork the cache.

getAttr (identifier, propertyName) Unknown public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:345

identifier
propertyName
returns
Unknown

Retrieve the data for an attribute from the cache

getErrors (identifier) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:501

identifier
returns

Query the cache for any validation errors applicable to the given resource.

getRelationship (identifier, propertyName) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:469

identifier
propertyName
returns

resource relationship object

Query the cache for the current state of a relationship property

hasChangedAttrs (identifier) Boolean public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:383

identifier
returns
Boolean

Query the cache for whether any mutated attributes exist

hasChangedRelationships (identifier) Boolean public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:441

identifier
StableRecordIdentifier
returns
Boolean

Query the cache for whether any mutated attributes exist

hydrate (stream) Promise<void> public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:250

stream
ReadableStream
returns
Promise<void>

hydrate a Cache from a Stream with content previously serialized from another instance of the same Cache, resolving when hydration is complete.

This method should expect to be called both in the context of restoring the Cache during application rehydration after SSR AND at unknown times during the lifetime of an already booted application when it is desired to bulk-load additional information into the cache. This latter behavior supports optimizing pre/fetching of data for route transitions via data-only SSR modes.

isDeleted (identifier) Boolean public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:538

identifier
returns
Boolean

Query the cache for whether a given resource is marked as deleted (but not necessarily persisted yet).

isDeletionCommitted (identifier) Boolean public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:551

identifier
returns
Boolean

Query the cache for whether a given resource has been deleted and that deletion has also been persisted.

isEmpty (identifier) Boolean public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:513

identifier
returns
Boolean

Query the cache for whether a given resource has any available data

isNew (identifier) Boolean public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:525

identifier
returns
Boolean

Query the cache for whether a given resource was created locally and not yet persisted.

merge (cache) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:181

cache
Cache
returns

Promise

Merge a fork back into a parent Cache.

Applications should typically not call this method themselves, preferring instead to merge at the Store level, which will utilize this method to merge the caches.

mutate (mutation) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:86

mutation

Update resource data with a local mutation. Currently supports operations on relationships only.

patch (op) Void public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:71

op

the operation to perform

returns
Void

Perform an operation on the cache to update the remote state.

Note: currently the only valid operation is a MergeOperation which occurs when a collision of identifiers is detected.

peek (identifier) ResourceDocument | ResourceBlob | null public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:98

identifier
StableRecordIdentifier | StableDocumentIdentifier
returns
ResourceDocument | ResourceBlob | null

the known resource data

Peek resource data from the Cache.

In development, if the return value is JSON the return value will be deep-cloned and deep-frozen to prevent mutation thereby enforcing cache Immutability.

This form of peek is useful for implementations that want to feed raw-data from cache to the UI or which want to interact with a blob of data directly from the presentation cache.

An implementation might want to do this because de-referencing records which read from their own blob is generally safer because the record does not require retaining connections to the Store and Cache to present data on a per-field basis.

This generally takes the place of getAttr as an API and may even take the place of getRelationship depending on implementation specifics, though this latter usage is less recommended due to the advantages of the Graph handling necessary entanglements and notifications for relational data.

peekRequest (UNKNOWN) StableDocumentIdentifier | null public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:136

UNKNOWN
StableDocumentIdentifier
returns
StableDocumentIdentifier | null

Peek the Cache for the existing request data associated with a cacheable request

put (doc) ResourceDocument public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:44

doc
StructuredDocument
returns
ResourceDocument

Cache the response to a request

Unlike store.push which has UPSERT semantics, put has replace semantics similar to the http method PUT

the individually cacheable e resource data it may contain should upsert, but the document data surrounding it should fully replace any existing information

Note that in order to support inserting arbitrary data to the cache that did not originate from a request put should expect to sometimes encounter a document with only a content member and therefor must not assume the existence of request and response on the document.

rollbackAttrs (identifier) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:395

identifier
returns

the names of attributes that were restored

Tell the cache to discard any uncommitted mutations to attributes

rollbackRelationships (identifier) String[] public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:453

identifier
StableRecordIdentifier
returns
String[]

the names of relationships that were restored

Tell the cache to discard any uncommitted mutations to relationships.

This will also discard the change on any appropriate inverses.

This method is a candidate to become a mutation

setAttr (identifier, propertyName, value) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:358

identifier
propertyName
value

Mutate the data for an attribute in the cache

setIsDeleted (identifier, isDeleted) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:488

identifier
isDeleted

Update the cache state for the given resource to be marked as locally deleted, or remove such a mark.

unloadRecord (identifier) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:330

identifier

[LIFECYCLE] Signals to the cache that all data for a resource should be cleared.

upsert (identifier, data, hasRecord) Void | string[] public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:149

identifier
data
hasRecord
returns
Void | string[]

if hasRecord is true then calculated key changes should be returned

Push resource data from a remote source into the cache for this identifier

willCommit (identifier) public

Module: @ember-data/store

Defined in ../packages/store/src/-private/managers/cache-manager.ts:292

identifier

[LIFECYCLE] Signals to the cache that a resource will be part of a save transaction.