community.postgresql.postgresql_schema module – Add or remove PostgreSQL schema

Note

This module is part of the community.postgresql collection (version 2.1.5).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.postgresql.

To use it in a playbook, specify: community.postgresql.postgresql_schema.

Synopsis

  • Add or remove PostgreSQL schema.

Requirements

The below requirements are needed on the host that executes this module.

  • psycopg2

Parameters

Parameter

Comments

ca_cert

aliases: ssl_rootcert

string

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.

cascade_drop

boolean

Drop schema with CASCADE to remove child objects.

Choices:

  • no ← (default)

  • yes

database

aliases: db, login_db

string

Name of the database to connect to and add or remove the schema.

Default: “postgres”

login_host

string

Host running the database.

If you have connection issues when using localhost, try to use 127.0.0.1 instead.

login_password

string

The password this module should use to establish its PostgreSQL session.

login_unix_socket

string

Path to a Unix domain socket for local connections.

login_user

string

The username this module should use to establish its PostgreSQL session.

Default: “postgres”

name

aliases: schema

string / required

Name of the schema to add or remove.

owner

string

Name of the role to set as owner of the schema.

port

aliases: login_port

integer

Database port to connect to.

Default: 5432

session_role

string

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

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.

Choices:

  • allow

  • disable

  • prefer ← (default)

  • require

  • verify-ca

  • verify-full

state

string

The schema state.

Choices:

  • absent

  • present ← (default)

trust_input

boolean

added in 0.2.0 of community.postgresql

If no, check whether values of parameters schema, owner, session_role are potentially dangerous.

It makes sense to use no only when SQL injections via the parameters are possible.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • Supports check_mode.

  • 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 schemas

General information about PostgreSQL schemas.

CREATE SCHEMA reference

Complete reference of the CREATE SCHEMA command documentation.

ALTER SCHEMA reference

Complete reference of the ALTER SCHEMA command documentation.

DROP SCHEMA reference

Complete reference of the DROP SCHEMA command documentation.

Examples

- name: Create a new schema with name acme in test database
  community.postgresql.postgresql_schema:
    db: test
    name: acme

- name: Create a new schema acme with a user bob who will own it
  community.postgresql.postgresql_schema:
    name: acme
    owner: bob

- name: Drop schema "acme" with cascade
  community.postgresql.postgresql_schema:
    name: acme
    state: absent
    cascade_drop: yes

Return Values

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

Key

Description

queries

list / elements=string

List of executed queries.

Returned: always

Sample: [“CREATE SCHEMA \”acme\””]

schema

string

Name of the schema.

Returned: success, changed

Sample: “acme”

Authors

  • Flavien Chantelot (@Dorn-)

  • Thomas O’Donnell (@andytom)