community.postgresql.postgresql_publication – Add, update, or remove PostgreSQL publication
Note
This plugin is part of the community.postgresql collection (version 1.6.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
.
Parameters
Parameter |
Comments |
---|---|
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. |
|
Drop publication dependencies. Has effect with state=absent only. Choices:
|
|
Name of the database to connect to and where the publication state will be changed. |
|
Host running the database. If you have connection issues when using |
|
The password this module should use to establish its PostgreSQL session. |
|
Path to a Unix domain socket for local connections. |
|
The username this module should use to establish its PostgreSQL session. Default: “postgres” |
|
Name of the publication to add, update, or remove. |
|
Publication owner. If owner is not defined, the owner will be set as login_user or session_role. |
|
Dictionary with optional publication parameters. Available parameters depend on PostgreSQL version. |
|
Database port to connect to. Default: 5432 |
|
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. |
|
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 Choices:
|
|
The publication state. Choices:
|
|
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. |
|
If It makes sense to use Choices:
|
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 |
---|---|
Flag indicates that all tables are published. Returned: if publication exists Sample: false |
|
Flag indicates the publication exists or not at the end of runtime. Returned: always Sample: true |
|
Owner of the publication at the end of runtime. Returned: if publication exists Sample: “alice” |
|
Publication parameters at the end of runtime. Returned: if publication exists Sample: {“publish”: {“delete”: false, “insert”: false, “update”: true}} |
|
List of executed queries. Returned: always Sample: [“DROP PUBLICATION \”acme\” CASCADE”] |
|
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) <loic.blot@unix-experience.fr>
Andrew Klychkov (@Andersson007) <aaklychkov@mail.ru>