postgresql_ext – Add or remove PostgreSQL extensions from a database

From Get docs
Ansible/docs/2.8/modules/postgresql ext module


postgresql_ext – Add or remove PostgreSQL extensions from a database

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

added in 2.8

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

added in 2.8

  • 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

added in 2.8

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

added in 2.8

Name of the schema to add the extension to.

session_role

string

added in 2.8

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

added in 2.8

  • 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

  • absent
  • present

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.
  • 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.
  • 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
  postgresql_ext:
    name: postgis
    db: acme
    schema: foo

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

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

Return Values

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

Key Returned Description

query

list

always

List of executed queries.


Sample:

['DROP EXTENSION "acme"']




Status

Authors

  • Daniel Schep (@dschep)
  • Thomas O’Donnell (@andytom)

Hint

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


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/postgresql_ext_module.html