Pyrseas¶
Pyrseas provides utilities to describe a PostgreSQL database schema as YAML, to verify the schema against the same or a different database and to generate SQL that will modify the schema to match the YAML description.
Features¶
- Outputs a YAML/JSON description of a PostgreSQL database’s tables and other objects (metadata), suitable for storing in a version control repository
- Generates SQL statements to modify a database so that it will match an input YAML/JSON specification
- Generates an augmented YAML description of a PostgreSQL database from its catalogs and an augmentation specification.
Requirements¶
- PostgreSQL 10 or higher
- Python 3.7 or higher
- Psycopg3 3.1 or higher
- PyYAML 5.3 or higher
Contents¶
API Reference¶
Currently, the only external APIs are the class
Database and the methods
to_map() and
diff_map() of the latter. Other
classes and methods are documented mainly for developer use.