Documentation

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

New in version 1.7.

Synopsis

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 (on host that executes module)

  • psycopg2

Options

parameter required default choices comments
cascade
 no
  • yes
  • no
when dropping a language, also delete object that depend on this language.
only used when state=absent.
db
 no
    name of database where the language will be added, removed or changed
    fail_on_drop
    		 no yes
    • yes
    • no
    if 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 cascade.
    force_trust
    		 no
    • yes
    • no
    marks the language as trusted, even if it's marked as untrusted in pg_pltemplate.
    use with care!
    lang
    		 yes
      name of the procedural language to add, remove or change
      login_host
      		 no localhost
        Host running PostgreSQL where you want to execute the actions.
        login_password
        		 no
          Password used to authenticate with PostgreSQL (must match login_user)
          login_user
          		 no postgres
            User used to authenticate with PostgreSQL
            port
            		 no 5432
              Database port to connect to.
              state
              		 no present
              • present
              • absent
              The state of the language for the selected database
              trust
              		 no
              • yes
              • no
              make this language trusted for the selected db

              Examples

              # 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

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

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

# 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

              Notes

              Note

              The default authentication assumes that you are either logging in as or sudo’ing to the postgres account on the host.

              Note

              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.

              This is an Extras Module

              For more information on what this means please read Extras Modules

              For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.