Skip to content

Protean

Migration Guides

proteanhq/protean

Protean
Getting Started
Guides
Reference
Concepts
Patterns & Recipes
Glossary
Community

Protean

proteanhq/protean

Protean
Protean
Getting Started
Getting Started
- Installation
- Hello, Protean!
- Quickstart
- Tutorial
  Tutorial
  - Part I - Building the Domain
    Part I - Building the Domain
    
    1. Your First Aggregate
    
    2. Rich Fields and Value Objects
    
    3. Entities and Associations
    
    4. Business Rules
  - Part II - Making It Event-Driven
    Part II - Making It Event-Driven
    
    5. Commands and Handlers
    
    6. Events and Reactions
  - Part III - Read Models and Persistence
    Part III - Read Models and Persistence
    
    7. Projections
    
    8. Connecting a Real Database
  - Part IV - Testing
    Part IV - Testing
    
    9. Testing Your Domain
    
    10. What Comes Next
Guides
Guides
- Choose a Path
  Choose a Path
- Set Up the Domain
  Set Up the Domain
- Model Your Domain
  Model Your Domain
- Add Rules and Behavior
  Add Rules and Behavior
- Change State
  Change State
- React to Changes
  React to Changes
- Expose Your Domain
  Expose Your Domain
  - Endpoint Tests
- Run the Server
  Run the Server
- Test Your Application
  Test Your Application
Reference
Reference
- Domain Elements
  Domain Elements
- Fields
  Fields
- Configuration
  Configuration
- CLI
  CLI
  - Project
    
    Project
    
    protean new
    
    Domain Discovery
    
    protean shell
    
    protean docs
  - Runtime
    
    Runtime
    
    protean server
    
    protean observatory
  - Data
    
    Data
    
    protean db
    
    protean events
    
    protean snapshot
    
    protean projection
- Server
  Server
- Adapters
  Adapters
  - Database
    
    Database
    
    PostgreSQL
    
    Elasticsearch
  - Brokers
    
    Brokers
    
    Inline Broker
    
    Redis Stream Broker
    
    Redis PubSub Broker
    
    Custom Brokers
  - Caches
    
    Caches
    
    Redis
  - Event Stores
    
    Event Stores
    
    Message DB
- Type Checking
  Type Checking
- Testing
  Testing
  - Pytest Plugin
- Migration
  Migration
  - Migrating to 0.15
Concepts
Concepts
- Philosophy & Principles
  Philosophy & Principles
- Foundations
  Foundations
- Architecture Patterns
  Architecture Patterns
- Building Blocks
  Building Blocks
- Async Processing
  Async Processing
- Ports & Adapters
  Ports & Adapters
- Internals
  Internals
Patterns & Recipes
Patterns & Recipes
- Aggregate Design
  Aggregate Design
- Event-Driven Patterns
  Event-Driven Patterns
- Architecture & Quality
  Architecture & Quality
- Identity & Communication
  Identity & Communication
- Testing & Infrastructure
  Testing & Infrastructure
Glossary
Community
Community

Reference
Migration

Migration Guides

Guides for upgrading between major Protean versions.

v0.15 Migration — Breaking changes and upgrade steps for v0.15

Migrating to 0.15

Copyright © 2019 - 2026 Subhash Bhushan

Made with Material for MkDocs