Perseid

User Guide

  • Overview
    • Availability and Installation
    • Use Cases
      • Version Control
      • Supplementary Actions
  • Known Issues
    • Coverage of Database Objects
      • PostgreSQL Extensions
    • YAML Formatting
    • Statement Ordering
  • dbtoyaml - Database to YAML
    • Synopsis
    • Description
    • Positional arguments
    • Options
    • Examples
  • yamltodb - YAML to Database
    • Synopsis
    • Description
    • Positional arguments
    • Options
    • Examples
  • Common Command Line Options
  • YAML Format Reference
    • Top-level structure
    • Schema properties
    • Table properties
    • Column properties
    • Example

Developer Guide

  • Installation
    • Core build requirements
    • Documentation requirements (optional)
    • Testing requirements
    • Dependencies
      • Installing dependencies on Debian/Ubuntu
  • Building
    • Build steps
      • Build targets
      • Test databases
    • Documentation
      • Building documentation
  • Testing
    • Running the tests
      • Smoke test: running against alternate databases
    • Unit tests
    • Integration tests
    • Functional tests
    • Test organization

API Reference

  • API Reference
    • Database
      • perseid::Config
        • Config()
        • Config()
        • dbname()
        • host()
        • port()
        • user()
        • password()
      • perseid::Database
        • Database()
        • Database()
        • to_yaml()
        • from_yaml()
        • diff_yaml()
        • from_catalog()
        • fetch_reserved_words()
        • db()
        • map()
        • map()
      • perseid::Database_map
        • from_catalog()
        • from_yaml()
        • diff_yaml()
        • schemas()
        • tables()
    • Database objects
      • perseid::Db_object
        • Db_object()
        • Db_object()
        • ~Db_object()
        • obj_type()
        • extern_key()
        • identifier()
        • create()
        • drop()
        • comment()
        • alter_owner()
        • alter()
        • name()
        • set_name()
        • description()
        • set_description()
        • owner()
        • set_owner()
      • perseid::Schema_object
        • Schema_object()
        • Schema_object()
        • extern_key()
        • identifier()
        • qual_name()
        • schema()
        • set_schema()
      • perseid::Schema
        • Schema()
        • Schema()
        • obj_type()
        • create()
        • drop()
        • to_yaml()
        • catalog_query()
        • from_yaml()
      • perseid::Schema_map
        • from_catalog()
        • transform()
        • schemas()
        • set_schemas()
      • perseid::Relation
        • Relation()
        • Relation()
        • key()
      • perseid::Table
        • Table()
        • Table()
        • obj_type()
        • create()
        • drop()
        • alter()
        • alter()
        • to_yaml()
        • columns()
        • set_columns()
        • add_column()
        • check_constraints()
        • set_check_constraints()
        • add_check_constraint()
        • primary_key()
        • set_primary_key()
        • reset_primary_key()
        • foreign_keys()
        • set_foreign_keys()
        • add_foreign_key()
        • unique_constraints()
        • set_unique_constraints()
        • add_unique_constraint()
        • catalog_query()
        • from_yaml()
      • perseid::Table_map
        • from_catalog()
        • from_yaml()
        • transform()
        • topo_sort()
        • tables()
        • table()
        • set_tables()
        • add_table()
        • key()
      • perseid::Column
        • Column()
        • Column()
        • add()
        • comment()
        • drop_column()
        • rename_column()
        • identifier()
        • alter()
        • to_yaml()
        • number()
        • set_number()
        • not_null()
        • set_not_null()
        • default_val()
        • set_default()
        • description()
        • set_description()
        • catalog_query()
        • from_yaml()
      • perseid::Constraint
        • Constraint()
        • Constraint()
        • obj_type()
        • identifier()
        • key_columns()
        • add()
        • drop()
        • comment()
        • to_yaml()
        • table()
        • set_table()
        • columns()
        • set_columns()
        • add_column()
      • perseid::Check_constraint
        • obj_type()
        • create()
        • add()
        • to_yaml()
        • expression()
        • set_expression()
        • Constraint()
        • Constraint()
        • catalog_query()
        • from_yaml()
      • perseid::Primary_key
        • obj_type()
        • create()
        • to_yaml()
        • access_method()
        • set_access_method()
        • Constraint()
        • Constraint()
        • catalog_query()
        • from_yaml()
      • perseid::Foreign_key
        • obj_type()
        • create()
        • add()
        • to_yaml()
        • ref_schema()
        • set_ref_schema()
        • ref_table()
        • set_ref_table()
        • ref_columns()
        • set_ref_columns()
        • add_ref_column()
        • on_update()
        • set_on_update()
        • on_delete()
        • set_on_delete()
        • Constraint()
        • Constraint()
        • catalog_query()
        • from_yaml()
      • perseid::Unique_constraint
        • obj_type()
        • create()
        • to_yaml()
        • Constraint()
        • Constraint()
        • catalog_query()
        • from_yaml()
    • Command-line arguments
      • perseid::Common_args
        • Common_args()
        • config()
        • add_connection_options()
        • prog
        • parser
      • parse_args()
Perseid
  • Search

© Copyright 2010-2026, Joe Abbate.

Built with Sphinx using a theme provided by Read the Docs.