Databases operations

Command line interface

The pglift database command line entry point exposes commands to manage PostgreSQL databases of an instance.

$ pglift database --help
Usage: pglift database [OPTIONS] COMMAND [ARGS]...

  Manage databases.

Options:
  -i, --instance <version>/<name>
                                  Instance identifier; the <version>/ prefix
                                  may be omitted if there's only one instance
                                  matching <name>. Required if there is more
                                  than one instance on system.
  --schema                        Print the JSON schema of database model and
                                  exit.
  --help                          Show this message and exit.

Commands:
  alter       Alter a database in a PostgreSQL instance
  create      Create a database in a PostgreSQL instance
  drop        Drop a database
  dump        Dump a database
  get         Get the description of a database
  list        List databases
  privileges  List default privileges on a database.
  run         Run given command on databases of a PostgreSQL instance

Note

When cloning a database from an existing one, it can be useful to examine pg_dump and pg_restore commands logs. This can be achieved by setting the log-level to DEBUG in pglift command (e.g. pglift -L debug instance create --clone-from xxxx).

Ansible module

The database module within dalibo.pglift collection is the main entry point for PostgreSQL databases management through Ansible.

Example task:

tasks:
  - name: my database
    dalibo.pglift.database:
      instance: myinstance
      name: myapp
      owner: dba

It’s also possible to use the instance module within dalibo.pglift collection as the main entry point to manage your PostgreSQL database. Some examples about managing databases directly with the Ansible instance module are available under the dedicated documentation.