community.postgresql.postgresql_owner – Change an owner of PostgreSQL database object

Note

This plugin is part of the community.postgresql collection (version 1.5.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_owner.

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis

Change an owner of PostgreSQL database object.
Also allows to reassign the ownership of database objects owned by a database role to another role.

Requirements

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

psycopg2

Parameters

Parameter	Choices/Defaults	Comments
ca_cert 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. aliases: ssl_rootcert
db string		Name of database to connect to. aliases: login_db
fail_on_role boolean	Choices: no yes ←	If `yes`, fail when reassign_owned_by role does not exist. Otherwise just warn and continue. Mutually exclusive with obj_name and obj_type.
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	Default: "postgres"	The username this module should use to establish its PostgreSQL session.
new_owner string / required		Role (user/group) to set as an obj_name owner.
obj_name string		Name of a database object to change ownership. Mutually exclusive with reassign_owned_by.
obj_type string	Choices: database function matview sequence schema table tablespace view	Type of a database object. Mutually exclusive with reassign_owned_by. aliases: type
port integer	Default: 5432	Database port to connect to. aliases: login_port
reassign_owned_by list / elements=string		The list of role names. The ownership of all the objects within the current database, and of all shared objects (databases, tablespaces), owned by this role(s) will be reassigned to owner. Pay attention - it reassigns all objects owned by this role(s) in the db! If role(s) exists, always returns changed True. Cannot reassign ownership of objects that are required by the database system. Mutually exclusive with `obj_type`.
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	Choices: allow disable prefer ← require verify-ca verify-full	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.
trust_input boolean added in 0.2.0 of community.postgresql	Choices: no yes ←	If `no`, check whether values of parameters new_owner, obj_name, reassign_owned_by, session_role are potentially dangerous. It makes sense to use `no` only when SQL injections via the parameters are possible.

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.

Examples

# Set owner as alice for function myfunc in database bar by ansible ad-hoc command:
# ansible -m postgresql_owner -a "db=bar new_owner=alice obj_name=myfunc obj_type=function"

- name: The same as above by playbook
  community.postgresql.postgresql_owner:
    db: bar
    new_owner: alice
    obj_name: myfunc
    obj_type: function

- name: Set owner as bob for table acme in database bar
  community.postgresql.postgresql_owner:
    db: bar
    new_owner: bob
    obj_name: acme
    obj_type: table

- name: Set owner as alice for view test_view in database bar
  community.postgresql.postgresql_owner:
    db: bar
    new_owner: alice
    obj_name: test_view
    obj_type: view

- name: Set owner as bob for tablespace ssd in database foo
  community.postgresql.postgresql_owner:
    db: foo
    new_owner: bob
    obj_name: ssd
    obj_type: tablespace

- name: Reassign all object in database bar owned by bob to alice
  community.postgresql.postgresql_owner:
    db: bar
    new_owner: alice
    reassign_owned_by: bob

- name: Reassign all object in database bar owned by bob and bill to alice
  community.postgresql.postgresql_owner:
    db: bar
    new_owner: alice
    reassign_owned_by:
    - bob
    - bill

Return Values

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

Key	Returned	Description
queries string	always	List of executed queries. Sample: ['REASSIGN OWNED BY "bob" TO "alice"']

Authors

Andrew Klychkov (@Andersson007)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/postgresql/postgresql_owner_module.html