Nedb-based read model store adapter for the Magek framework
npm install @magek/adapter-read-model-store-nedbThis package provides a NeDB-based read model store adapter for the Magek framework.
``bash`
npm install @magek/adapter-read-model-store-nedb
`typescript
import { MagekConfig } from '@magek/common'
import { readModelStore } from '@magek/adapter-read-model-store-nedb'
const config = new MagekConfig('development')
config.readModelStoreAdapter = readModelStore
`
- Full ReadModelStoreAdapter interface implementation
- Support for fetch, search, store, and delete operations
- Built-in health checks
- Comprehensive query capabilities with filtering, sorting, and pagination
- Optimistic concurrency control
- Field projection support
The adapter implements the standard ReadModelStoreAdapter interface:
- fetch(config, readModelName, readModelID) - Fetch a single read model by IDsearch(config, readModelName, parameters)
- - Search read models with filtersstore(config, readModelName, readModel)
- - Store or update a read modeldelete(config, readModelName, readModelID)
- - Delete a read model by IDrawToEnvelopes(rawReadModels)
- - Convert raw data to read model envelopeshealthCheck
- - Health check methods (isUp, details, urls)
Read models are stored in a local NeDB file at .magek/read_models.json`.