Module @metreeca/pipe-store - v0.11.1

Store processing tasks.

Provides ready-made @metreeca/flow steps for working with @metreeca/keep stores in pipelines run by the @metreeca/gear executor.

A job binds a store connector to createStore once, and every step that needs a store uses that one.

@metreeca/pipe-store

Store processing tasks for @metreeca/pipe.

Provides ready-made @metreeca/flow steps for working with @metreeca/keep stores in pipelines run by the @metreeca/gear job executor.

Installation

npm install @metreeca/gear                       # the job executor
npm install @metreeca/pipe-store                 # this package
npm install @metreeca/keep-<connector>           # store connector for the target backend

Important

Node.js 22 or later is required.

Warning

TypeScript consumers must use "moduleResolution": "nodenext"/"node16"/"bundler" in tsconfig.json. The legacy "node" resolver is not supported.

Usage

Task	Description
`lookup()`	Store resource retriever
`retire()`	Retired resource selector
`settle()`	Resource delta writer

The store service has no default: a job binds a store connector to createStore() once, and every task or sink in the execution then reads from or writes to the store that connector reaches.

Support

open an issue to report a problem or to suggest a new feature
start a discussion to ask a how-to question or to share an idea

License

This project is licensed under the Apache 2.0 License – see LICENSE file for details.

Interfaces

Tally: Counts of the deltas a settle run handled, by outcome.

Type Aliases

Delta: Target state of a single resource.

Functions

createStore: Creates the default store.
lookup: Retrieves a resource, or the items of a collection it holds, from the store.
retire: Creates a task that selects the resources to retire.
settle: Creates a sink that writes the deltas of a pipeline to the store.
delta: Creates a delta for a resource.