#cqrs

cqrs

An event-sourced command-query system

5 unstable releases

0.3.1 Aug 7, 2019
0.3.0 Apr 29, 2019
0.2.1 Mar 8, 2019
0.2.0 Feb 4, 2019
0.1.0 Feb 1, 2019


Used in cqrs-postgres

Apache-2.0

73KB
2K SLoC

cqrs

cqrs is an event-driven framework for writing software that uses events as the "source of truth" and implements command–query responsibility separation (CQRS).

The framework is built around a few key concepts:

  • Events: The things that happened in the system
  • Aggregates: Projections of events that calculate a view of the current state of the system
  • Commands: Intentions which, when executed against an aggregate, may produce zero or more events, or which may be prohibited by the current state of an aggregate
  • Reactions: Processes that execute an action when certain events occur in the system

The framework is written to be applicable to a generic backend, with an implementation provided for a PostgreSQL backend.

For an example of how to construct a domain which includes aggregates, events, and commands, look at the cqrs-todo-core crate, which is a simple to-do list implementation.

The source repository also contains a binary in the cqrs-todoql-psql directory which demonstrates the use of the todo domain in concert with the PostgreSQL backend and a GraphQL frontend using the juniper crate.

Development

To build all crates in this repository:

cargo build

To test all crates and documentation:

cargo test

To compile documentation for the crates in the repository (remove --no-deps to also include documentation for dependencies; add --open to automatically open the documentation in a browser):

cargo doc --no-deps

This crate aims to support the wasm32-unknown-unknown target for the cqrs, cqrs-core, and cqrs-todo-core crates. To build against this target, execute:

cargo build --target=wasm32-unknown-unknown -p cqrs-core -p cqrs -p cqrs-todo-core

License

cqrs is openly-licensed under the Apache-2.0 license.

Dependencies

~655KB
~12K SLoC