community.postgresql.postgresql_owner module – Change an owner of PostgreSQL database object
This module is part of the community.postgresql collection (version 3.4.0).
You might already have this collection installed if you are using the
It is not included in
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:
Change an owner of PostgreSQL database object.
Also allows to reassign the ownership of database objects owned by a database role to another role.
The below requirements are needed on the host that executes this module.
psycopg2 >= 2.5.1
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.
Any additional parameters to be passed to libpg.
These parameters take precedence.
Name of database to connect to.
Mutually exclusive with obj_name and obj_type.
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.
Role (user/group) to set as an obj_name owner.
Name of a database object to change ownership.
Mutually exclusive with reassign_owned_by.
Type of a database object.
Mutually exclusive with reassign_owned_by.
obj_type=matview is available since PostgreSQL 9.3.
obj_type=event_trigger, obj_type=procedure, obj_type=publication, obj_type=statistics, and obj_type=routine are available since PostgreSQL 11.
Database port to connect to.
Caution - the ownership of all the objects within the specified db, owned by this role(s) will be reassigned to new_owner.
REASSIGN OWNED is often used to prepare for the removal of one or more roles.
REASSIGN OWNED does not affect objects within other databases.
Execute this command in each database that contains objects owned by a role that is to be removed.
If role(s) exists, always returns changed True.
Cannot reassign ownership of objects that are required by the database system.
Mutually exclusive with
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.
Specifies the file name of the client SSL certificate.
Specifies the location for the secret key used for the client certificate.
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.
It makes sense to use
Can run in check_mode and return changed status prediction without modifying target.
Function Overloading is not supported so when obj_type is
procedureobj_name is considered the only object of same type with this name.
Despite Function Overloading is not supported, when obj_type=aggregate obj_name must contain also aggregate signature because it is required by SQL syntax.
new_owner must be a superuser if obj_type is
To manage subscriptions ownership use
The default authentication assumes that you are either logging in as or sudo’ing to the
postgresaccount 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.1or
psycopg3 >= 3.1.8is 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
python3-psycopg2packages on the remote host before using this module.
Create, alter, or remove a user (role) from a PostgreSQL server instance.
Grant or revoke privileges on PostgreSQL database objects.
Add or remove PostgreSQL roles from groups.
Add, update, or remove PostgreSQL subscription.
- PostgreSQL REASSIGN OWNED command reference
Complete reference of the PostgreSQL REASSIGN OWNED command documentation.
# 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
- name: Set owner as bob for table acme in database bar
- name: Set owner as alice for view test_view in database bar
- name: Set owner as bob for tablespace ssd in database foo
- name: Reassign all databases owned by bob to alice and all objects in database bar owned by bob to alice
- name: Reassign all databases owned by bob or bill to alice and all objects in database bar owned by bob or bill to alice
Common return values are documented here, the following are the fields unique to this module:
List of executed queries.