cqrs

README

ose-micro/cqrs

A lightweight, extensible Go package for implementing the CQRS (Command Query Responsibility Segregation) pattern with message bus support.

Overview

ose-micro/cqrs provides a simple yet powerful CQRS toolkit for Go microservices. It includes:

• Generic CommandBus and QueryBus implementations.
• Support for external buses like NATS.
• Middleware support (logging, tracing, metrics, retries).

Built with generics to simplify development while keeping type safety and performance.

Features

• ✅ Strongly typed command and query handlers using Go generics.
• ✅ Middleware chaining for cross-cutting concerns.
• ✅ Native support for NATS and easy extensibility for Kafka/Redis.
• ✅ Pluggable message bus interface.
• ✅ Clear separation of write and read models.

Installation

go get github.com/ose-micro/cqrs

Documentation

Index

• type Command
• type CommandHandle
• type Event
• type EventHandle
• type Query
• type QueryHandle

Types

type Command

type Command interface {
	CommandName() string
	Validate() error
}

type CommandHandle

type CommandHandle[C Command, R any] interface {
	Handle(ctx context.Context, command C) (R, error)
}

type Event

type Event interface {
	EventName() string
}

type EventHandle

type EventHandle[E Event] interface {
	Handle(ctx context.Context, event E) error
}

type Query

type Query interface {
	QueryName() string
}

type QueryHandle

type QueryHandle[Q Query, R any] interface {
	Handle(ctx context.Context, query Q) (R, error)
}