community.postgresql.postgresql_user_obj_stat_info module – Gather statistics about PostgreSQL user objects
Note
This module is part of the community.postgresql collection (version 2.3.1).
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_user_obj_stat_info
.
New in community.postgresql 0.2.0
Synopsis
Gathers statistics about PostgreSQL user objects.
Requirements
The below requirements are needed on the host that executes this module.
psycopg2
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. |
|
Any additional parameters to be passed to libpg. These parameters take precedence. Default: |
|
Name of database to connect. |
|
Limit the collected information by comma separated string or YAML list. Allowable values are By default, collects all subsets. Unsupported values are ignored. |
|
Host running the database. If you have connection issues when using Default: |
|
The password this module should use to establish its PostgreSQL session. Default: |
|
Path to a Unix domain socket for local connections. Default: |
|
The username this module should use to establish its PostgreSQL session. Default: |
|
Database port to connect to. Default: |
|
Restrict the output by certain schema. |
|
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:
|
|
If It makes sense to use Choices:
|
Notes
Note
size
andtotal_size
returned values are presented in bytes.For tracking function statistics the PostgreSQL
track_functions
parameter must be enabled. See https://www.postgresql.org/docs/current/runtime-config-statistics.html for more information.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
- community.postgresql.postgresql_info
Gather information about PostgreSQL servers.
- community.postgresql.postgresql_ping
Check remote PostgreSQL server availability.
- PostgreSQL statistics collector reference
Complete reference of the PostgreSQL statistics collector documentation.
Examples
- name: Collect information about all supported user objects of the acme database
community.postgresql.postgresql_user_obj_stat_info:
db: acme
- name: Collect information about all supported user objects in the custom schema of the acme database
community.postgresql.postgresql_user_obj_stat_info:
db: acme
schema: custom
- name: Collect information about user tables and indexes in the acme database
community.postgresql.postgresql_user_obj_stat_info:
db: acme
filter: tables, indexes
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
User function statistics. Returned: always Sample: |
|
User index statistics. Returned: always Sample: |
|
User table statistics. Returned: always Sample: |
Collection links
Issue Tracker Repository (Sources) Report an issue Communication