модуль community.postgresql.postgresql_user_obj_stat_info — сбор статистики об объектах PostgreSQL

Примечание

Этот модуль входит в коллекцию community.postgresql (версия 4.2.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 строка	Задаёт имя файла, содержащего сертификат(ы) центра сертификации (CA) для SSL. Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров сертификации.
connect_params словарь добавлен в community.postgresql 2.3.0	Любые дополнительные параметры, передаваемые в libpg. Эти параметры имеют приоритет. По умолчанию: `{}`
filter список / элементы=строка	Ограничивает собираемую информацию с помощью строки со значениями, разделёнными запятыми, или списка YAML. Допустимые значения: `functions`, `indexes`, `tables`. По умолчанию собираются все подмножества. Неподдерживаемые значения игнорируются.
login_db псевдонимы: db строка	Имя базы данных для подключения. Псевдоним `db` устарел и будет удалён в версии 5.0.0.
login_host псевдонимы: host строка	Узел, на котором работает база данных. Если при использовании `localhost` возникают проблемы с подключением, попробуйте вместо него использовать `127.0.0.1`. По умолчанию: `""`
login_password строка	Пароль, который модуль должен использовать для установки сеанса PostgreSQL. По умолчанию: `""`
login_port псевдонимы: port целое число	Порт базы данных для подключения. Псевдоним `port` устарел и будет удалён в следующем основном выпуске. Вместо него используйте `login_port`. По умолчанию: `5432`
login_unix_socket псевдонимы: unix_socket строка	Путь к сокету домена Unix для локальных подключений. По умолчанию: `""`
login_user псевдонимы: login строка	Имя пользователя, которое модуль должен использовать для установки сеанса PostgreSQL. По умолчанию: `"postgres"`
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://www.postgresql.org/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 представлять опасность. Использовать `false` имеет смысл только в том случае, если возможны SQL-инъекции через session_role. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой узел.

Примечания

Примечание

Возвращаемые значения size и total_size представлены в байтах.
Для сбора статистики функций необходимо включить параметр PostgreSQL track_functions. Дополнительные сведения см. на странице https://www.postgresql.org/docs/current/runtime-config-statistics.html.
По умолчанию предполагается, что вы входите в систему как учётная запись postgres на узле либо переключаетесь на неё с помощью sudo.
Чтобы избежать ошибки «Peer authentication failed for user postgres», используйте пользователя postgres в качестве become_user.
Этот модуль использует psycopg — адаптер баз данных PostgreSQL для Python. Перед использованием модуля необходимо убедиться, что на узле установлен 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:
    login_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:
    login_db: acme
    schema: custom

- name: Collect information about user tables and indexes in the acme database
  community.postgresql.postgresql_user_obj_stat_info:
    login_db: acme
    filter: tables, indexes

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
functions словарь	Статистика пользовательских функций. Возвращается: success Пример: `{"public": {"inc": {"calls": 1, "funcid": 26722, "self_time": 0.23, "total_time": 0.23}}}`
indexes словарь	Статистика пользовательских индексов. Возвращается: success Пример: `{"public": {"test_id_idx": {"...": null, "idx_scan": 0, "idx_tup_fetch": 0, "idx_tup_read": 0, "relname": "test", "size": 8192}}}`
tables словарь	Статистика пользовательских таблиц. Возвращается: success Пример: `{"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)

Ссылки коллекции

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