postgresql_lang – Adds, removes or changes procedural languages with a PostgreSQL database¶
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 cascade=yes 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 careful 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.
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
|
|
When dropping a language, also delete object that depend on this language.
Only used when state=absent.
|
db
string
|
Name of database to connect to and where the language will be added, removed or changed.
aliases: login_db |
|
fail_on_drop
boolean
|
|
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
boolean
|
|
Marks the language as trusted, even if it's marked as untrusted in pg_pltemplate.
Use with care!
|
lang
string
/ required
|
Name of the procedural language to add, remove or change.
aliases: name |
|
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.
|
port
integer
|
Default: 5432
|
Database port to connect to.
aliases: login_port |
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 |
|
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
|
|
The state of the language for the selected database.
|
trust
boolean
|
|
Make this language trusted for the selected db.
|
Notes¶
Note
- 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 languages
- General information about PostgreSQL languages.
- CREATE LANGUAGE reference
- Complete reference of the CREATE LANGUAGE command documentation.
- ALTER LANGUAGE reference
- Complete reference of the ALTER LANGUAGE command documentation.
- DROP LANGUAGE reference
- Complete reference of the DROP LANGUAGE command documentation.
Examples¶
- name: 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
- name: Add language pltclu to database testdb if it doesn't exist and mark it as trusted
postgresql_lang:
db: testdb
lang: pltclu
state: present
trust: yes
force_trust: yes
- name: Remove language pltclu from database testdb
postgresql_lang:
db: testdb
lang: pltclu
state: absent
- name: Remove language pltclu from database testdb and remove all dependencies
postgresql_lang:
db: testdb
lang: pltclu
state: absent
cascade: yes
- name: 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
queries
list
added in 2.8 |
always |
List of executed queries.
Sample:
['CREATE LANGUAGE "acme"']
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Jens Depuydt (@jensdepuydt)
- Thomas O’Donnell (@andytom)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.