Python API

This section documents general aspects of the Python API that are not related to a specific operation context but may apply to several of them. It also describes the data models used through the API.

Warning

At the moment, this Python API should not be considered stable, it might change without notice. This documentation is mostly useful to pglift’s developers.

• Data model
  • System model
  • Interface model
• Exceptions
  • Exception hierarchy
  • Exception classes
• Command execution
  • asyncio_run()
  • asyncio_start_program()
  • terminate_program()
  • status_program()
• PostgreSQL configuration management
  • make()
  • read()
• Instances
  • apply()
  • get()
  • exists()
  • ls()
  • drop()
  • init()
  • configure()
  • start()
  • stop()
  • restart()
  • reload()
  • pending_restart()
  • stopped()
  • promote()
  • upgrade()
  • settings()
• PostgreSQL
  • status()
  • check_status()
  • is_ready()
  • logs()
  • replication_lag()
• Databases
  • apply()
  • exists()
  • ls()
  • get()
  • drop()
  • run()
  • dump()
• Roles
  • apply()
  • exists()
  • get()
  • drop()
• Privileges
  • get()
• Utilities
  • template()