community.postgresql.postgresql_db module – Add or remove PostgreSQL databases from a remote host

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Add or remove PostgreSQL databases from a remote host.

Requirements

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

  • psycopg2 >= 2.5.1

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.

comment

string

added in community.postgresql 3.3.0

Sets a comment on the database.

To reset the comment, pass an empty string.

conn_limit

string

Specifies the database connection limit.

Default: ""

connect_params

dictionary

added in community.postgresql 2.3.0

Any additional parameters to be passed to libpg.

These parameters take precedence.

Default: {}

dump_extra_args

string

added in community.postgresql 0.2.0

Provides additional arguments when state is dump.

Cannot be used with dump-file-format-related arguments like ``--format=d``.

encoding

string

Encoding of the database.

Default: ""

force

boolean

Used to forcefully drop a database when the state is absent, ignored otherwise.

Choices:

  • false ← (default)

  • true

icu_locale

string

added in community.postgresql 3.4.0

Specifies the ICU locale (ICU_LOCALE) for the database default collation order and character classification, overriding the setting locale.

The locale provider must be ICU. The default is the setting of locale if specified; otherwise the same setting as the template database.

Default: ""

lc_collate

string

Collation order (LC_COLLATE) to use in the database must match collation order of template database unless template0 is used as template.

Default: ""

lc_ctype

string

Character classification (LC_CTYPE) to use in the database (e.g. lower, upper, …).

Must match LC_CTYPE of template database unless template0 is used as template.

Default: ""

locale_provider

string

added in community.postgresql 3.4.0

Specifies the provider to use for the default collation in this database (LOCALE_PROVIDER).

Possible values are icu (if the server was built with ICU support) or libc.

By default, the provider is the same as that of the template.

Default: ""

login_host

aliases: host

string

Host running the database.

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

Default: ""

login_password

string

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

Default: ""

login_unix_socket

aliases: unix_socket

string

Path to a Unix domain socket for local connections.

Default: ""

login_user

aliases: login

string

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

Default: "postgres"

maintenance_db

string

The value specifies the initial database (which is also called as maintenance DB) that Ansible connects to.

Default: "postgres"

name

aliases: db

string / required

Name of the database to add or remove.

owner

string

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

Default: ""

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_cert

path

added in community.postgresql 2.4.0

Specifies the file name of the client SSL certificate.

ssl_key

path

added in community.postgresql 2.4.0

Specifies the location for the secret key used for the client certificate.

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 database state.

present implies that the database should be created if necessary.

absent implies that the database should be removed if present.

dump requires a target definition to which the database will be backed up. (Added in Ansible 2.4) Note that in some PostgreSQL versions of pg_dump, which is an embedded PostgreSQL utility and is used by the module, returns rc 0 even when errors occurred (e.g. the connection is forbidden by pg_hba.conf, etc.), so the module returns changed=True but the dump has not actually been done. Please, be sure that your version of pg_dump returns rc 1 in this case.

restore also requires a target definition from which the database will be restored. (Added in Ansible 2.4).

The format of the backup will be detected based on the target name.

Supported compression formats for dump and restore determined by target file format .pgc (custom), .bz2 (bzip2), .gz (gzip/pigz) and .xz (xz).

Supported formats for dump and restore determined by target file format .sql (plain), .tar (tar), .pgc (custom) and .dir (directory) For the directory format which is supported since collection version 1.4.0.

Restore program is selected by target file format: .tar, .pgc, and .dir are handled by pg_restore, other with pgsql.

.

DEPRECATED (see the discussion). rename is used to rename the database name to target. To rename a database, use the community.postgresql.postgresql_query module.

Choices:

  • "absent"

  • "dump"

  • "present" ← (default)

  • "rename"

  • "restore"

tablespace

path

The tablespace to set for the database https://www.postgresql.org/docs/current/sql-alterdatabase.html.

If you want to move the database back to the default tablespace, explicitly set this to pg_default.

Default: ""

target

path

File to back up or restore from.

Used when state is dump or restore.

Default: ""

target_opts

string

Additional arguments for pg_dump or restore program (pg_restore or psql, depending on target’s format).

Used when state is dump or restore.

Default: ""

template

string

Template used to create the database.

Default: ""

trust_input

boolean

added in community.postgresql 0.2.0

If false, check whether values of parameters owner, conn_limit, encoding, db, template, tablespace, session_role are potentially dangerous.

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

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

Notes

Note

  • State dump and restore don’t require psycopg since ansible version 2.8.

  • 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 psycopg, a Python PostgreSQL database adapter. You must ensure that psycopg2 >= 2.5.1 or psycopg3 >= 3.1.8 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 python3-psycopg2 packages on the remote host before using this module.

See Also

See also

CREATE DATABASE reference

Complete reference of the CREATE DATABASE command documentation.

DROP DATABASE reference

Complete reference of the DROP DATABASE command documentation.

pg_dump reference

Complete reference of pg_dump documentation.

pg_restore reference

Complete reference of pg_restore documentation.

community.postgresql.postgresql_tablespace

Add or remove PostgreSQL tablespaces from remote hosts.

community.postgresql.postgresql_info

Gather information about PostgreSQL servers.

community.postgresql.postgresql_ping

Check remote PostgreSQL server availability.

Examples

- name: Create a new database with name "acme"
  community.postgresql.postgresql_db:
    name: acme
    comment: My test DB

# Note: If a template different from "template0" is specified,
# encoding and locale settings must match those of the template.
- name: Create a new database with name "acme" and specific encoding and locale # settings
  community.postgresql.postgresql_db:
    name: acme
    encoding: UTF-8
    lc_collate: de_DE.UTF-8
    lc_ctype: de_DE.UTF-8
    locale_provider: icu
    icu_locale: de-DE-x-icu
    template: template0

# Note: Default limit for the number of concurrent connections to
# a specific database is "-1", which means "unlimited"
- name: Create a new database with name "acme" which has a limit of 100 concurrent connections
  community.postgresql.postgresql_db:
    name: acme
    conn_limit: "100"

- name: Dump an existing database to a file
  community.postgresql.postgresql_db:
    name: acme
    state: dump
    target: /tmp/acme.sql

- name: Dump an existing database to a file excluding the test table
  community.postgresql.postgresql_db:
    name: acme
    state: dump
    target: /tmp/acme.sql
    dump_extra_args: --exclude-table=test

- name: Dump an existing database to a file (with compression)
  community.postgresql.postgresql_db:
    name: acme
    state: dump
    target: /tmp/acme.sql.gz

- name: Dump a single schema for an existing database
  community.postgresql.postgresql_db:
    name: acme
    state: dump
    target: /tmp/acme.sql
    target_opts: "-n public"

- name: Dump only table1 and table2 from the acme database
  community.postgresql.postgresql_db:
    name: acme
    state: dump
    target: /tmp/table1_table2.sql
    target_opts: "-t table1 -t table2"

- name: Dump an existing database using the directory format
  community.postgresql.postgresql_db:
    name: acme
    state: dump
    target: /tmp/acme.dir

- name: Dump an existing database using the custom format
  community.postgresql.postgresql_db:
    name: acme
    state: dump
    target: /tmp/acme.pgc

# name: acme - the name of the database to connect through which the recovery will take place
- name: Restore database using the tar format
  community.postgresql.postgresql_db:
    name: acme
    state: restore
    target: /tmp/acme.tar

# Note: In the example below, if database foo exists and has another tablespace
# the tablespace will be changed to foo. Access to the database will be locked
# until the copying of database files is finished.
- name: Create a new database called foo in tablespace bar
  community.postgresql.postgresql_db:
    name: foo
    tablespace: bar

Return Values

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

Key

Description

executed_commands

list / elements=string

added in community.postgresql 0.2.0

List of commands which tried to run.

Returned: success

Sample: ["CREATE DATABASE acme"]

Authors

  • Ansible Core Team