codegen_database

Warning

codegen_database is in pre-alpha. APIs may change between releases.

Getting started

• Setting up a new project
  • Installation
  • Dependencies
  • alembic.ini
  • env.py
  • models.py
• Module layout
  • Why the split
  • Rule of thumb
• Configuration
  • Creating a config
  • Fields
  • Methods
  • Typical project setup
• Playground
  • Getting the code
  • Prerequisites
  • Configuration
  • Setup
  • Commands
  • Typical workflow
  • Adding models

Guides

• Declarative style
  • Quick comparison
  • Using mapped_column and Mapped[]
  • Declarative style in depth
  • Kitchen-sink declarative example
  • Kitchen-sink imperative example
  • Mixing styles
  • Choosing a style
• Factories
  • Simple
  • Append-only (SCD Type 2)
  • EAV (Entity-Attribute-Value)
  • Ledger
• Constraints and indices
  • Column markers
  • Check constraints
  • Indices
  • Foreign keys
  • Simple dimension example
  • Append-only dimension example
  • EAV dimension example
• Ledger tables
  • Basic ledger
  • Double-entry ledger
  • Customising the value type
  • Using a UUID primary key
  • Ledger events
  • Chart helpers
  • Plugin reference
• Ledger events
  • Reconciliation (diff mode)
  • Simple event (input only)
  • Factory integration
  • Validation
• Audit queries
  • What is exposed
  • How to use
  • Append-only
  • EAV
• Comments queries
  • What is exposed
  • How to use
• Naming conventions
  • Setting up naming conventions
  • Overriding a specific convention
  • Convention reference
• Cookbook
  • Migrations only
  • Using codegen_database models in your application
  • Indices and foreign keys

Reference

• Plugin architecture
  • Core concepts
  • Plugin execution order
  • Plugin resolution
  • Singleton groups
  • Context keys
  • Writing a custom plugin
  • Global configuration
  • Factory and view reference
  • Built-in plugins reference
• Built-in plugins
  • SerialPKPlugin
  • UUIDV4PKPlugin
  • UUIDV7PKPlugin
  • construct_column_name_plugin
  • SimpleTablePlugin
  • RawTableProtectionPlugin
  • TableCheckPlugin
  • TableIndexPlugin
  • TableFKPlugin
  • AppendOnlyTablePlugin
  • EAVTablePlugin
  • SoftDeletePlugin
  • TemporalPlugin
  • LedgerSnapshotPlugin
  • SearchVectorPlugin
  • CodegenDatabaseAutogeneratedIdentifierColumn
  • Plugin execution order
• Extension system
  • Built-in extensions
  • Plugins vs extensions
  • Quick start
  • Extension hooks
  • Inter-extension dependencies
  • Entry point discovery
  • Writing an extension
  • pg_cron extension
  • PostGIS extension
  • Chart extension
• API reference
  • Declarative primitives (codegen_database.*)
  • Migration glue (codegen_database.alembic.*)
  • Pre-built features (codegen_database.ext.*)
• Benchmarks
  • What is benchmarked
  • Representative results

Contributing

• Development
• Changelog