community.postgresql.postgresql_user_obj_stat_info 模块 – 收集 PostgreSQL 用户对象统计信息

注意

此模块是 community.postgresql 集合 (版本 3.9.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.postgresql。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定： community.postgresql.postgresql_user_obj_stat_info。

community.postgresql 0.2.0 中新增

摘要 

收集有关 PostgreSQL 用户对象的统计信息。

要求 

执行此模块的主机需要以下要求。

psycopg2 >= 2.5.1

参数 

参数	注释
ca_cert 别名：ssl_rootcert 字符串	指定包含 SSL 证书颁发机构 (CA) 证书的文件的名称。如果文件存在，则服务器的证书将被验证是否由这些机构之一签署。
connect_params 字典 community.postgresql 2.3.0 中新增	要传递给 libpg 的任何其他参数。这些参数具有优先级。默认值： `{}`
db 别名：login_db 字符串	要连接的数据库的名称。
filter 列表 / 元素=字符串	通过逗号分隔的字符串或 YAML 列表限制收集的信息。允许的值为 `functions`、`indexes`、`tables`。默认情况下，收集所有子集。不支持的值将被忽略。
login_host 别名：host 字符串	运行数据库的主机。如果您在使用 `localhost` 时遇到连接问题，请尝试使用 `127.0.0.1` 代替。默认值： `""`
login_password 字符串	此模块应用于建立其 PostgreSQL 会话的密码。默认值： `""`
login_unix_socket 别名：unix_socket 字符串	本地连接的 Unix 域套接字的路径。默认值： `""`
login_user 别名：login 字符串	此模块应用于建立其 PostgreSQL 会话的用户名。默认值： `"postgres"`
port 别名：login_port 整数	要连接到的数据库端口。默认值： `5432`
schema 字符串	按特定模式限制输出。
session_role 字符串	连接后切换到 session_role。指定的 session_role 必须是当前 login_user 属于的角色。 SQL 命令的权限检查将像 session_role 是最初登录的角色一样进行。
ssl_cert 路径 community.postgresql 2.4.0 中新增	指定客户端 SSL 证书的文件名。
ssl_key 路径 community.postgresql 2.4.0 中新增	指定客户端证书使用的密钥的位置。
ssl_mode 字符串	确定是否以及以什么优先级与服务器协商安全的 SSL TCP/IP 连接。有关模式的更多信息，请参阅 https://postgresql.ac.cn/docs/current/static/libpq-ssl.html。 `prefer` 的默认值与 libpq 默认值匹配。选项 `"allow"` `"disable"` `"prefer"` ← (默认) `"require"` `"verify-ca"` `"verify-full"`
trust_input 布尔值 community.postgresql 0.2.0 中新增	如果为 `false`，则检查 session_role 的值是否可能存在危险。只有当可能通过 session_role 进行 SQL 注入时，使用 `false` 才有意义。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 `check_mode` 下运行，并在不修改目标的情况下返回更改状态预测。

备注 

注意

返回的值 size 和 total_size 以字节为单位。
要跟踪函数统计信息，必须启用 PostgreSQL 的 track_functions 参数。更多信息请参见 https://postgresql.ac.cn/docs/current/runtime-config-statistics.html。
默认身份验证假设您以主机上的 postgres 帐户登录或使用 sudo 命令登录。
为避免出现“Peer authentication failed for user postgres”错误，请使用 postgres 用户作为 _become_user_。
此模块使用 psycopg，这是一个 Python PostgreSQL 数据库适配器。在使用此模块之前，必须确保主机上安装了 psycopg2 >= 2.5.1 或 psycopg3 >= 3.1.8。
如果远程主机是 PostgreSQL 服务器（默认情况），则远程主机上也必须安装 PostgreSQL。
对于基于 Ubuntu 的系统，在使用此模块之前，请在远程主机上安装 postgresql、libpq-dev 和 python3-psycopg2 包。

另请参阅 

另请参阅

community.postgresql.postgresql_info: 收集有关 PostgreSQL 服务器的信息。
community.postgresql.postgresql_ping: 检查远程 PostgreSQL 服务器的可用性。
PostgreSQL 统计信息收集器参考: PostgreSQL 统计信息收集器文档的完整参考。

示例 

- 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

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
functions 字典	用户函数统计信息。返回：成功示例： `{"public": {"inc": {"calls": 1, "funcid": 26722, "self_time": 0.23, "total_time": 0.23}}}`
indexes 字典	用户索引统计信息。返回：成功示例： `{"public": {"test_id_idx": {"...": null, "idx_scan": 0, "idx_tup_fetch": 0, "idx_tup_read": 0, "relname": "test", "size": 8192}}}`
tables 字典	用户表统计信息。返回：成功示例： `{"public": {"test": {"...": null, "analyze_count": 3, "n_dead_tup": 0, "n_live_tup": 0, "seq_scan": 2, "size": 0, "total_size": 8192}}}`

作者

Andrew Klychkov (@Andersson007)
Thomas O’Donnell (@andytom)

community.postgresql.postgresql_user_obj_stat_info 模块 – 收集 PostgreSQL 用户对象统计信息

作者

集合链接