Read Model

The read model's cache of an entity's state
attribute
type
description
id
string
ID of the entity
version
integer
Version number of the projection
state
object
An arbitrary object containing the entity's state

get(id)
Retrieve the stored projection for a given entity.

attribute
type
description
id
string
(required) the ID of the entity

projection

set(id, { version, state })
Set the projection state for a given entity.

attribute
type
description
id
string
(required) the ID of the entity
version
integer
(required) the version of the projection
state
object
(required) an arbitrary object containing the entity state

null

batchGet([ ...ids ])
Fetch multiple projections at once

attribute
type
description
ids
array
(required) the IDs of entities to fetch

[ projections ] (array of projections) - the projections (if they exist)

batchWrite({ id: { version, state }, id: { version, state }, ... })
Set multiple projections at once

attribute
type
description
id
string
(required) the ID of the entity
version
integer
(required) the version of the projection
state
object
(required) an arbitrary object containing the entity state
search(params)
Search for projections

attribute
type
description
id
object
(required) an arbitrary object of search params

{ total, data }
attribute
type
description
total
integer
(required) the total number of records found
data
array
(required) an array of projection objects
Copy link
On this page
Types
projection
Methods
get
set
batchGet
batchWrite
search