Skip to content

Domain Elements

Reference documentation for the core properties shared by all Protean domain elements, decorators, the object model, and identity configuration.

For guides on defining domain elements, see Model Your Domain.

  • Domain Constructor: Domain() parameters: root_path, name, config, identity_function.
  • Decorators: All element decorators and their options.
  • Object Model: Meta attributes available on every domain element.
  • Identity: Identity strategies, types, and custom identity functions.
  • Indexes: Index declarations on aggregates and entities, options, dialect support, and the Index.from_sql escape hatch.