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

Note

This plugin is part of the community.postgresql collection (version 1.2.0).

To install it use: ansible-galaxy collection install community.postgresql.

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

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

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
ca_cert 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. aliases: ssl_rootcert
cascade boolean	Choices: no ← yes	Automatically install/remove any extensions that this extension depends on that are not already installed/removed (supported since PostgreSQL 9.6).
db string / required		Name of the database to add or remove the extension to/from. aliases: login_db
login_host string		Host running the database.
login_password string		The password used to authenticate with.
login_unix_socket string		Path to a Unix domain socket for local connections.
login_user string	Default: "postgres"	The username used to authenticate with.
name string / required		Name of the extension to add or remove. aliases: ext
port integer	Default: 5432	Database port to connect to. aliases: login_port
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_mode string	Choices: allow disable prefer ← require verify-ca verify-full	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.
state string	Choices: absent present ←	The database extension state.
trust_input boolean added in 0.2.0 of community.postgresql	Choices: no yes ←	If `no`, check whether values of parameters ext, schema, version, session_role are potentially dangerous. It makes sense to use `no` only when SQL injections via the parameters are possible.
version string		Extension version to add or update to. Has effect with state=present only. If not specified, the latest extension version will be created. It can't downgrade an extension version. When version downgrade is needed, remove the extension and create new one with appropriate version. Set version=latest to update the extension to the latest available version.

Notes ¶

Note

Supports check_mode.
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.
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 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.
The ca_cert parameter requires at least Postgres version 8.4 and psycopg2 version 2.4.3.

Examples ¶

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

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

- name: Adds earthdistance extension to the database template1 cascade
  community.postgresql.postgresql_ext:
    name: earthdistance
    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
    db: acme
    cascade: yes
    state: absent

- name: Create extension foo of version 1.2 or update it if it's already created
  community.postgresql.postgresql_ext:
    db: acme
    name: foo
    version: 1.2

- name: Assuming extension foo is created, update it to the latest version
  community.postgresql.postgresql_ext:
    db: acme
    name: foo
    version: latest

Return Values ¶

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

Key	Returned	Description
query list / elements=string	always	List of executed queries. Sample: ['DROP EXTENSION "acme"']

Authors¶

Daniel Schep (@dschep)
Thomas O’Donnell (@andytom)
Sandro Santilli (@strk)
Andrew Klychkov (@Andersson007)

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

Synopsis¶

Requirements¶

Parameters¶

Notes¶

See Also¶

Examples¶

Return Values¶