ansible.builtin.postgresql_lang (v2.7.17) — module

Install Ansible via pip

Install with pip install ansible==2.7.17

Description

Adds, removes or changes procedural languages with a PostgreSQL database.

This module allows you to add a language, remote a language or change the trust relationship with a PostgreSQL database. The module can be used on the machine where executed or on a remote host.

When removing a language from a database, it is possible that dependencies prevent the database from being removed. In that case, you can specify casade to automatically drop objects that depend on the language (such as functions in the language). In case the language can't be deleted because it is required by the database system, you can specify fail_on_drop=no to ignore the error.

Be carefull when marking a language as trusted since this could be a potential security breach. Untrusted languages allow only users with the PostgreSQL superuser privilege to use this language to create new functions.

Requirements

• psycopg2

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Add language pltclu to database testdb if it doesn't exist:
- postgresql_lang db=testdb lang=pltclu state=present

# Add language pltclu to database testdb if it doesn't exist and mark it as trusted:
# Marks the language as trusted if it exists but isn't trusted yet
# force_trust makes sure that the language will be marked as trusted
- postgresql_lang:
    db: testdb
    lang: pltclu
    state: present
    trust: yes
    force_trust: yes

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Remove language pltclu from database testdb:
- postgresql_lang:
    db: testdb
    lang: pltclu
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Remove language pltclu from database testdb and remove all dependencies:
- postgresql_lang:
    db: testdb
    lang: pltclu
    state: absent
    cascade: yes

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Remove language c from database testdb but ignore errors if something prevents the removal:
- postgresql_lang:
    db: testdb
    lang: pltclu
    state: absent
    fail_on_drop: no

Inputs

    
db:
    description:
    - name of database where the language will be added, removed or changed

lang:
    description:
    - name of the procedural language to add, remove or change
    required: true

port:
    default: 5432
    description:
    - Database port to connect to.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The state of the language for the selected database

trust:
    default: 'no'
    description:
    - make this language trusted for the selected db
    type: bool

cascade:
    default: 'no'
    description:
    - when dropping a language, also delete object that depend on this language.
    - only used when C(state=absent).
    type: bool

login_host:
    default: localhost
    description:
    - Host running PostgreSQL where you want to execute the actions.

login_user:
    default: postgres
    description:
    - User used to authenticate with PostgreSQL

force_trust:
    default: 'no'
    description:
    - marks the language as trusted, even if it's marked as untrusted in pg_pltemplate.
    - use with care!
    type: bool

fail_on_drop:
    default: 'yes'
    description:
    - if C(yes), fail when removing a language. Otherwise just log and continue
    - in some cases, it is not possible to remove a language (used by the db-system).
      When         dependencies block the removal, consider using C(cascade).
    type: bool

login_password:
    description:
    - Password used to authenticate with PostgreSQL (must match C(login_user))