community.postgresql.postgresql_publication module – Add, update, or remove PostgreSQL publication

Note

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

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_publication.

Synopsis

  • Add, update, or remove PostgreSQL publication.

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

boolean

Drop publication dependencies. Has effect with state=absent only.

Choices:

  • no ← (default)

  • yes

db

aliases: login_db

string

Name of the database to connect to and where the publication state will be changed.

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

string / required

Name of the publication to add, update, or remove.

owner

string

Publication owner.

If owner is not defined, the owner will be set as login_user or session_role.

parameters

dictionary

Dictionary with optional publication parameters.

Available parameters depend on PostgreSQL version.

port

aliases: login_port

integer

Database port to connect to.

Default: 5432

session_role

string

added in 0.2.0 of community.postgresql

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

Choices:

  • absent

  • present ← (default)

tables

list / elements=string

List of tables to add to the publication.

If no value is set all tables are targeted.

If the publication already exists for specific tables and tables is not passed, nothing will be changed.

If you need to add all tables to the publication with the same name, drop existent and create new without passing tables.

trust_input

boolean

added in 0.2.0 of community.postgresql

If no, check whether values of parameters name, tables, owner, session_role, params are potentially dangerous.

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

Choices:

  • no

  • yes ← (default)

Notes

Note

  • PostgreSQL version must be 10 or greater.

  • 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

CREATE PUBLICATION reference

Complete reference of the CREATE PUBLICATION command documentation.

ALTER PUBLICATION reference

Complete reference of the ALTER PUBLICATION command documentation.

DROP PUBLICATION reference

Complete reference of the DROP PUBLICATION command documentation.

Examples

- name: Create a new publication with name "acme" targeting all tables in database "test"
  community.postgresql.postgresql_publication:
    db: test
    name: acme

- name: Create publication "acme" publishing only prices and vehicles tables
  community.postgresql.postgresql_publication:
    name: acme
    tables:
    - prices
    - vehicles

- name: >
    Create publication "acme", set user alice as an owner, targeting all tables
    Allowable DML operations are INSERT and UPDATE only
  community.postgresql.postgresql_publication:
    name: acme
    owner: alice
    parameters:
      publish: 'insert,update'

- name: >
    Assuming publication "acme" exists and there are targeted
    tables "prices" and "vehicles", add table "stores" to the publication
  community.postgresql.postgresql_publication:
    name: acme
    tables:
    - prices
    - vehicles
    - stores

- name: Remove publication "acme" if exists in database "test"
  community.postgresql.postgresql_publication:
    db: test
    name: acme
    state: absent

Return Values

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

Key

Description

alltables

boolean

Flag indicates that all tables are published.

Returned: if publication exists

Sample: false

exists

boolean

Flag indicates the publication exists or not at the end of runtime.

Returned: always

Sample: true

owner

string

Owner of the publication at the end of runtime.

Returned: if publication exists

Sample: “alice”

parameters

dictionary

Publication parameters at the end of runtime.

Returned: if publication exists

Sample: {“publish”: {“delete”: false, “insert”: false, “update”: true}}

queries

string

List of executed queries.

Returned: always

Sample: [“DROP PUBLICATION \”acme\” CASCADE”]

tables

list / elements=string

List of tables in the publication at the end of runtime.

If all tables are published, returns empty list.

Returned: if publication exists

Sample: [”\”public\”.\”prices\””, “\”public\”.\”vehicles\””]

Authors

  • Loic Blot (@nerzhul)

  • Andrew Klychkov (@Andersson007)