Skip to content

Latest commit

 

History

History

cqrs-go

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
pkg
pkg
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
main.go
main.go
 
 
migrations.sql
migrations.sql
 
 
spin.toml
spin.toml
 
 

README.md

Command and Query Responsibility Segregation (CQRS)

This folder contains a simple Command and Query Responsibility Segregation (CQRS) implementation written in TinyGo.

What is Command and Query Responsibility Segregation (CQRS)

CQRS is a software architectural pattern that separates the responsibility of handling commands (requests that change the system's state) from handling queries (requests that fetch data without modifying state). In a CQRS architecture, commands are handled by a separate component or layer known as the Command side, while queries are handled by another component or layer called the Query side. This segregation allows each side to be optimized independently, as they often have different scalability, performance, and optimization requirements.

On the Command side, operations are focused on enforcing business rules, validation, and updating the state of the system. This side typically utilizes a domain-driven design approach to model the business logic effectively. On the Query side, the emphasis is on efficiently retrieving data to fulfill read requests from clients. This side often employs de-normalized data models and specialized data storage mechanisms optimized for fast read access. By separating the concerns of commands and queries, CQRS promotes a clearer separation of concerns and can lead to improved scalability, performance, and maintainability in complex software systems.

Exposed Endpoints

Queries

  • GET /items - To retrieve a list of all items
  • GET /items/:id - To retrieve a item using its identifier

Commands

  • POST /items - To create a new item
  • PUT /items/:id - To update an existing item using its identifier
  • DELETE /items/:id - To delete an existing item using its identifier

Send data to POST /items and PUT /items/:id using the following structure:

{
    "name": "item name",
    "description": "Description fo the item"
}

Supported Platforms

  • Local (spin up)
  • Fermyon Cloud
  • SpinKube
  • Fermyon Platform for Kubernetes

Prerequisites

To use this sample you must have

  • TinyGo installed on your machine
  • Spin CLI installed on your machine

Running the Sample

Local (spin up)

To run the sample locally, you must provide the migrations.sql file using the --sqlite flag to provision database on the first run:

# Build the project
spin build

# Run the sample
spin up --sqlite @migrations.sql
Logging component stdio to ".spin/logs/"
Storing default SQLite data to ".spin/sqlite_db.db"

Serving http://127.0.0.1:3000
Available Routes:
  cqrs-go: http://127.0.0.1:3000 (wildcard)

Fermyon Cloud

You can deploy this sample to Fermyon Cloud following the steps below:

# Authenticate
spin cloud login

# Deploy the sample to Fermyon Cloud
# This will ask if a new database should be created or an existing one should be used
# Answer the question with "create a new database"
spin deploy
Uploading cqrs-go version 0.1.0 to Fermyon Cloud...
Deploying...
App "cqrs-go" accesses a database labeled "default"
    Would you like to link an existing database or create a new database?: Create a new database and link the app to it
What would you like to name your database?
    Note: This name is used when managing your database at the account level. The app "cqrs-go" will refer to this database by the label "default".
    Other apps can use different labels to refer to the same database.: gentle-whale
Creating database named 'gentle-whale'
Waiting for application to become ready........ ready

View application:   https://cqrs-go-8csubcks.fermyon.app/
Manage application: https://cloud.fermyon.com/app/cqrs-go


# Ensure tables are created in the new database (here gentle-whale)
spin cloud sqlite execute --database gentle-whale @migrations.sql