This example demonstrates a basic setup of a stateful system (implemented as a
Polylith base) whose lifecycle is handled by
the Integrant. It caters for both
in-REPL development and production use cases.
The most frequently asked system was taken as an illustrative example. It uses several single-purpose components to work with a traditional database, in this case PostgreSQL.
Unfortunately, the term "component" becomes overloaded in the current context. It can both mean a Polylith component (a type of brick) and an Integrant system component (a.k.a. a "key" in Integrant's parlance). In order not to go nuts and at the same time not to introduce new terms further complicating understanding, we will use this term with qualifiers — "stateful" and "stateless".
By "stateful" we mean components that are part of the Integrant system (used at runtime) and that may also have Polylith counterparts (used at build time). And by "stateless" we mean regular Polylith components that do not become a part of the Integrant system's state.
The minimal set of system components:
| Component | Polylith name | Integrant system key | Description |
|---|---|---|---|
| Config | config |
:integrant.system/config |
A "stateful" component encapsulating the system runtime configuration. Every system should start with this one. Here we have it for completeness and keep its implementation dead simple. |
| Embedded DB | embedded-pg |
:integrant.system/embedded-pg |
A "stateful" component which should be divided into two parts along the boundary between the component and the Integrant system that merely prepares arguments and calls its methods. |
| DataSource | n/a | :integrant.system/data-source |
A "stateful" component which is only required at runtime (to be started and stopped properly), i.e. lacks a Polylith counterpart. |
| DB Operations | pg-ops |
n/a | A regular "stateless" component whose methods are parametrized by the required system state (e.g. data-source) or its derivatives. |