Reference

The reference section provides factual, lookup-oriented documentation for Protean's machinery. Use it to find specific configuration options, field types, CLI commands, adapter settings, and API details.

For understanding why things work as they do, see Concepts. For step-by-step how-to instructions, see Guides.

• Domain Elements

  ---

  Decorator options, meta attributes, reflection API, identity configuration.

  Element Decorators · Object Model · Identity

• Fields

  ---

  All field types, arguments, and definition styles.

  Fields

• Configuration

  ---

  domain.toml parameters, environment overlays, adapter configuration.

  Configuration

• CLI

  ---

  All protean CLI commands and their options.

  CLI Commands

• Server

  ---

  Subscription types, profiles, multi-worker mode, observability.

  Subscription Types · Configuration · Multi-Worker · Observability

• Adapters

  ---

  Database, broker, cache, and event store adapter configuration.

  Adapters

• Type Checking

  ---

  Mypy plugin setup and configuration.

  Type Checking

• Testing

  ---

  Pytest plugin, --protean-env option, and test fixtures.

  Pytest Plugin

• Migration

  ---

  Version migration guides.

  Migrating to 0.15