community.postgresql.postgresql_ext module – Add or remove PostgreSQL extensions from a database

Note

This module is part of the community.postgresql collection (version 3.14.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.postgresql. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.postgresql.postgresql_ext.

Synopsis

• Add or remove PostgreSQL extensions from a database.

Requirements

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

• psycopg2 >= 2.5.1

Parameters

Parameter	Comments
ca_cert aliases: ssl_rootcert string	Specifies the name of a file containing SSL certificate authority (CA) certificate(s). If the file exists, the server’s certificate will be verified to be signed by one of these authorities.
cascade boolean	Automatically install/remove any extensions that this extension depends on that are not already installed/removed (supported since PostgreSQL 9.6). Choices: false ← (default) true
comment string added in community.postgresql 3.3.0	Sets a comment on the extension. To reset the comment, pass an empty string.
connect_params dictionary added in community.postgresql 2.3.0	Any additional parameters to be passed to libpg. These parameters take precedence. Default: {}
login_db aliases: db string / required	Name of the database to add or remove the extension to/from. The db alias is deprecated and will be removed in version 5.0.0.
login_host aliases: host string	Host running the database. If you have connection issues when using localhost, try to use 127.0.0.1 instead. Default: ""
login_password string	The password this module should use to establish its PostgreSQL session. Default: ""
login_unix_socket aliases: unix_socket string	Path to a Unix domain socket for local connections. Default: ""
login_user aliases: login string	The username this module should use to establish its PostgreSQL session. Default: "postgres"
name aliases: ext string / required	Name of the extension to add or remove.
port aliases: login_port integer	Database port to connect to. Default: 5432
schema string	Name of the schema to add the extension to.
session_role string	Switch to session_role after connecting. The specified session_role must be a role that the current login_user is a member of. Permissions checking for SQL commands is carried out as though the session_role were the one that had logged in originally.
ssl_cert path added in community.postgresql 2.4.0	Specifies the file name of the client SSL certificate.
ssl_key path added in community.postgresql 2.4.0	Specifies the location for the secret key used for the client certificate.
ssl_mode string	Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server. See https://www.postgresql.org/docs/current/static/libpq-ssl.html for more information on the modes. Default of prefer matches libpq default. Choices: "allow" "disable" "prefer" ← (default) "require" "verify-ca" "verify-full"
state string	The database extension state. Choices: "absent" "present" ← (default)
trust_input boolean added in community.postgresql 0.2.0	If false, check whether values of parameters ext, schema, version, session_role are potentially dangerous. It makes sense to use false only when SQL injections via the parameters are possible. Choices: false true ← (default)
version string	Extension version to add or update to. Has effect with state=present only. If not specified and extension is not installed in the database, the latest version available will be created. If extension is already installed, will update to the given version if a valid update path exists. Downgrading is only supported if the extension provides a downgrade path otherwise the extension must be removed and a lower version of the extension must be made available. Set version=latest to update the extension to the latest available version.

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying target.

Notes

Note

• Incomparable versions, for example PostGIS ``unpackaged``, cannot be installed.

• The default authentication assumes that you are either logging in as or sudo’ing to the postgres account on the host.

• To avoid “Peer authentication failed for user postgres” error, use postgres user as a become_user.

• This module uses psycopg, a Python PostgreSQL database adapter. You must ensure that psycopg2 >= 2.5.1 or psycopg3 >= 3.1.8 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 python3-psycopg2 packages on the remote host before using this module.

See Also

See also

PostgreSQL extensions

General information about PostgreSQL extensions.

CREATE EXTENSION reference

Complete reference of the CREATE EXTENSION command documentation.

ALTER EXTENSION reference

Complete reference of the ALTER EXTENSION command documentation.

DROP EXTENSION reference

Complete reference of the DROP EXTENSION command documentation.

Examples

- name: Adds postgis extension to the database acme in the schema foo
  community.postgresql.postgresql_ext:
    name: postgis
    login_db: acme
    schema: foo
    comment: Test extension

- name: Removes postgis extension to the database acme
  community.postgresql.postgresql_ext:
    name: postgis
    login_db: acme
    state: absent

- name: Adds earthdistance extension to the database template1 cascade
  community.postgresql.postgresql_ext:
    name: earthdistance
    login_db: template1
    cascade: true

# In the example below, if earthdistance extension is installed,
# it will be removed too because it depends on cube:
- name: Removes cube extension from the database acme cascade
  community.postgresql.postgresql_ext:
    name: cube
    login_db: acme
    cascade: true
    state: absent

- name: Create extension foo of version 1.2 or update it to that version if it's already created and a valid update path exists
  community.postgresql.postgresql_ext:
    login_db: acme
    name: foo
    version: 1.2

- name: Create the latest available version of extension foo. If already installed, update it to the latest version
  community.postgresql.postgresql_ext:
    login_db: acme
    name: foo
    version: latest

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
prev_version string added in community.postgresql 3.1.0	Previous installed extension version or empty string if the extension was not installed. Returned: success Sample: "1.0"
queries list / elements=string	List of executed queries. Returned: success Sample: ["DROP EXTENSION \"acme\""]
version string added in community.postgresql 3.1.0	Current installed extension version or empty string if the extension is not installed. Returned: success Sample: "2.0"

Authors

• Daniel Schep (@dschep)

• Thomas O’Donnell (@andytom)

• Sandro Santilli (@strk)

• Andrew Klychkov (@Andersson007)

• Keith Fiske (@keithf4)

• Daniele Giudice (@RealGreenDragon)

Collection links

• Issue Tracker
• Repository (Sources)
• Report an issue
• Communication