Pyrseas

Pyrseas provides a framework and utilities to upgrade and maintain a PostgreSQL database.

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 willl match an input YAML/JSON specification
• Generates an augmented YAML description of a PostgreSQL database from its catalogs and an augmentation specification.

Requirements

• PostgreSQL 9.2 or higher
• Python 2.7 or higher
• Psycopg2 2.5 or higher
• PyYAML 3.10 or higher
• PgDbConn 0.8 or higher

Contents

• Overview
  • Use Cases
  • Version Control
  • Data Maintenance
  • Naming
• Installation
  • Summary
  • Requirements
  • Downloading
  • Installation
• Configuration
  • Configuration File Name
  • System Configuration
  • User Configuration
  • Repository Configuration
  • Command Line Configuration
• Configuration Items
  • Augmenter
  • Database
  • Datacopy
  • Repository
• Development
  • Requirements
  • Version Control
  • Programming Language
  • Database Installation
  • Other Libraries and Tools
• Testing
  • Environment Variables
  • Restrictions
  • Testing Checklist
• Known Issues
  • Memory utilization
  • Object renaming
  • Multiline Strings
  • Views Dependent on Primary Key
• Predefined Database Augmentations
  • Columns
  • Functions
  • Audit Columns

• dbaugment - Augment a database
• dbtoyaml - Database to YAML
• yamltodb - YAML to Database
• Common Command Line Options

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.

• Database Objects
  • Database Object
  • Database Object Dictionary
  • Schema Object
• Databases
  • Database
• Casts
  • Cast
  • Cast Dictionary
• Procedural Languages
  • Procedural Language
  • Language Dictionary
• Schemas
  • Schema
  • Schema Dictionary
• Collations
  • Collation
  • Collation Dictionary
• Conversions
  • Conversion
  • Conversion Dictionary
• Event Triggers
  • Event Trigger
  • Event Trigger Dictionary
• Extensions
  • Extension
  • Extension Dictionary
• Functions
  • Procedure
  • Function
  • Aggregate Function
  • Procedure Dictionary
• Operators
  • Operator
  • Operator Dictionary
• Operator Families
  • Operator Family
  • Operator Family Dictionary
• Operator Classes
  • Operator Class
  • Operator Class Dictionary
• Types and Domains
  • Database Type
  • Base Type
  • Composite
  • Enum
  • Domain
  • Type Dictionary
• Tables, Views and Sequences
  • Database Class
  • Sequence
  • Table
  • Class Dictionary
  • View
  • Materialized View
• Columns
  • Column
  • Column Dictionary
• Constraints
  • Constraint
  • Check Constraint
  • Primary Key
  • Foreign Key
  • Unique Constraint
  • Constraint Dictionary
• Indexes
  • Index
  • Index Dictionary
• Rules
  • Rule
  • Rule Dictionary
• Triggers
  • Trigger
  • Trigger Dictionary
• Text Search Objects
  • Text Search Configuration
  • Text Search Configuration Dictionary
  • Text Search Dictionary
  • Text Search Dictionary Dictionary
  • Text Search Parser
  • Text Search Parser Dictionary
  • Text Search Template
  • Text Search Template Dictionary
• Foreign Data Objects
  • Database Object With Options
  • Foreign Data Wrapper
  • Foreign Data Wrapper Dictionary
  • Foreign Server
  • Foreign Server Dictionary
  • User Mapping
  • User Mapping Dictionary
  • Foreign Table
  • Foreign Table Dictionary

Augmenter API Reference

• Augmenter Databases
  • Augmenter Database
• Augmenter Configuration Objects
  • Configuration Functions
  • Configuration Columns
  • Configuration Triggers
  • Configuration Audit Columns
• Augmentation Objects
  • Augmentation Schema
  • Augmentation Table

Indices and tables

• Index
• Module Index
• Search Page