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

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

Synopsis

• Add, update, or remove PostgreSQL publication.

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.
cascade boolean	Drop publication dependencies. Has effect with state=absent only. Choices: false ← (default) true
columns dictionary added in community.postgresql 3.8.0	List of tables and its columns to add to the publication. If no columns are passed for table, it will be published as a whole. Mutually exclusive with tables and tables_in_schema.
comment string added in community.postgresql 3.3.0	Sets a comment on the publication. To reset the comment, pass an empty string.
connect_params dictionary added in community.postgresql 2.3.0	Any additional parameters to be passed to libpg. These parameters take precedence. Default: {}
login_db aliases: db string	Name of the database to connect to and where the publication state will be changed. The db alias is deprecated and will be removed in version 5.0.0.
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"
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
rowfilters dictionary added in community.postgresql 3.12.0	Optional dictionary of row filters to apply to tables or columns of the publication. Mutually exclusive with tables_in_schema.
session_role string added in community.postgresql 0.2.0	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 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. Mutually exclusive with tables_in_schema and columns.
tables_in_schema list / elements=string added in community.postgresql 3.5.0	Specifies a list of schemas to add to the publication to replicate changes for all tables in those schemas. If you want to remove all schemas, explicitly pass an empty list []. Supported since PostgreSQL 15. Mutually exclusive with tables and columns.
trust_input boolean added in community.postgresql 0.2.0	If false, check whether values of parameters name, tables, owner, session_role, params 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

• PostgreSQL version must be 10 or greater.

• 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 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:
    login_db: test
    name: acme
    comment: Made by Ansible

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

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

- name: Create publication "acme" publishing id and name from vehicles tables, with a row filter
  community.postgresql.postgresql_publication:
    name: acme
    columns:
      vehicles:
        - id
        - name
    rowfilters:
        vehicles: (id > 100)

- name: >
    Assuming publication "acme" exists, publishing id and name from vehicles table with a
    row filter (id > 100), remove and re-add the table to the publication, with the updated row filter
  community.postgresql.postgresql_publication:
    name: acme
    columns:
      vehicles:
        - id
        - name
    rowfilters:
        vehicles: WHERE (id > 100) AND (id < 200)

- name: Create a new publication "acme" for tables in schema "myschema"
  community.postgresql.postgresql_publication:
    login_db: test
    name: acme
    tables_in_schema: myschema

- name: Remove all schemas from "acme" publication
  community.postgresql.postgresql_publication:
    login_db: test
    name: acme
    tables_in_schema: []

- 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:
    login_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: success 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: success 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)

• George Spanos (@grantanplan)

Collection links

• Issue Tracker
• Repository (Sources)
• Report an issue
• Communication