community.postgresql.postgresql_ext module – Add or remove PostgreSQL extensions from a database
Note
This module is part of the community.postgresql collection (version 2.3.1).
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
Parameters
Parameter |
Comments |
---|---|
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. |
|
Automatically install/remove any extensions that this extension depends on that are not already installed/removed (supported since PostgreSQL 9.6). Choices:
|
|
Any additional parameters to be passed to libpg. These parameters take precedence. Default: |
|
Name of the database to add or remove the extension to/from. |
|
Host running the database. If you have connection issues when using Default: |
|
The password this module should use to establish its PostgreSQL session. Default: |
|
Path to a Unix domain socket for local connections. Default: |
|
The username this module should use to establish its PostgreSQL session. Default: |
|
Name of the extension to add or remove. |
|
Database port to connect to. Default: |
|
Name of the schema to add the extension to. |
|
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. |
|
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 Choices:
|
|
The database extension state. Choices:
|
|
If It makes sense to use Choices:
|
|
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 always 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
, andpython-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.
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
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: 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:
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:
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 |
---|---|
List of executed queries. Returned: always Sample: |
Collection links
Issue Tracker Repository (Sources) Report an issue Communication