Documentation

postgresql_ext - Add or remove PostgreSQL extensions from a database.

New in version 1.9.

Synopsis

  • Add or remove PostgreSQL extensions from a database.

Requirements

The below requirements are needed on the host that executes this module.

  • psycopg2

Parameters

Parameter
Choices/Defaults
Comments
db
required
Default:
None
name of the database to add or remove the extension to/from
login_host
Default:
localhost
Host running the database
login_password
Default:
None
The password used to authenticate with
login_user
Default:
None
The username used to authenticate with
name
required
Default:
None
name of the extension to add or remove
port
Default:
5432
Database port to connect to.
state
    Choices:
  • present ←
  • absent
The database extension state

Notes

Note

  • The default authentication assumes that you are either logging in as or sudo’ing to the postgres account on the host.
  • This module uses psycopg2, a Python PostgreSQL database adapter. You must ensure that psycopg2 is installed on the host before using this module. If the remote host is the PostgreSQL server (which is the default case), then PostgreSQL must also be installed on the remote host. For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages on the remote host before using this module.

Examples

# Adds postgis to the database "acme"
- postgresql_ext:
    name: postgis
    db: acme

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Daniel Schep (@dschep)

Hint

If you notice any issues in this documentation you can edit this document to improve it.