community.general.postgresql_ext (1.3.14) — module

Add or remove PostgreSQL extensions from a database

Authors: Daniel Schep (@dschep), Thomas O'Donnell (@andytom), Sandro Santilli (@strk), Andrew Klychkov (@Andersson007)

Install collection

Install with ansible-galaxy collection install community.general:==1.3.14


Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.14

Description

Add or remove PostgreSQL extensions from a database.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Adds postgis extension to the database acme in the schema foo
  community.general.postgresql_ext:
    name: postgis
    db: acme
    schema: foo
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Removes postgis extension to the database acme
  community.general.postgresql_ext:
    name: postgis
    db: acme
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Adds earthdistance extension to the database template1 cascade
  community.general.postgresql_ext:
    name: earthdistance
    db: template1
    cascade: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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.general.postgresql_ext:
    name: cube
    db: acme
    cascade: yes
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create extension foo of version 1.2 or update it if it's already created
  community.general.postgresql_ext:
    db: acme
    name: foo
    version: 1.2
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Assuming extension foo is created, update it to the latest version
  community.general.postgresql_ext:
    db: acme
    name: foo
    version: latest

Inputs

    
db:
    aliases:
    - login_db
    description:
    - Name of the database to add or remove the extension to/from.
    required: true
    type: str

name:
    aliases:
    - ext
    description:
    - Name of the extension to add or remove.
    required: true
    type: str

port:
    aliases:
    - login_port
    default: 5432
    description:
    - Database port to connect to.
    type: int

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The database extension state.
    type: str

schema:
    description:
    - Name of the schema to add the extension to.
    type: str

ca_cert:
    aliases:
    - ssl_rootcert
    description:
    - 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.
    type: str

cascade:
    default: false
    description:
    - Automatically install/remove any extensions that this extension depends on that
      are not already installed/removed (supported since PostgreSQL 9.6).
    type: bool

version:
    description:
    - Extension version to add or update to. Has effect with I(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 I(version=latest) to update the extension to the latest available version.
    type: str

ssl_mode:
    choices:
    - allow
    - disable
    - prefer
    - require
    - verify-ca
    - verify-full
    default: prefer
    description:
    - Determines whether or with what priority a secure SSL TCP/IP connection will be
      negotiated with the server.
    - See U(https://www.postgresql.org/docs/current/static/libpq-ssl.html) for more information
      on the modes.
    - Default of C(prefer) matches libpq default.
    type: str

login_host:
    description:
    - Host running the database.
    type: str

login_user:
    default: postgres
    description:
    - The username used to authenticate with.
    type: str

trust_input:
    default: true
    description:
    - If C(no), check whether values of parameters I(ext), I(schema), I(version), I(session_role)
      are potentially dangerous.
    - It makes sense to use C(no) only when SQL injections via the parameters are possible.
    type: bool
    version_added: 0.2.0
    version_added_collection: community.general

session_role:
    description:
    - 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.
    type: str

login_password:
    description:
    - The password used to authenticate with.
    type: str

login_unix_socket:
    description:
    - Path to a Unix domain socket for local connections.
    type: str

Outputs

query:
  description: List of executed queries.
  returned: always
  sample:
  - DROP EXTENSION "acme"
  type: list

See also