Spec-Zone.ru › Ansible 2.10

community.postgresql.postgresql_query – Выполнение запросов PostgreSQL

Примечание

Этот плагин входит в коллекцию community.postgresql (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.postgresql.

Чтобы использовать его в книге задач, укажите: community.postgresql.postgresql_query.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Выполняет произвольные запросы PostgreSQL.
  • Может выполнять запросы из файлов скриптов SQL.
  • Не выполняет запросы к файлам резервных копий. Используйте community.postgresql.postgresql_db с параметром state=restore для выполнения запросов к файлам, созданным утилитами pg_dump/pg_dumpall.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

  • psycopg2

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
autocommit
boolean
    Варианты:
  • нет ←
  • да
Выполнять запросы в режиме autocommit, когда запрос нельзя выполнить внутри блока транзакций (например, VACUUM).
Взаимоисключительно с check_mode.
ca_cert
строка
Указывает имя файла, содержащего сертификат(ы) центра сертификации (CA).
Если файл существует, сертификат сервера будет проверен на соответствие одному из этих сертификатов.

алиасы: ssl_rootcert
db
строка
Имя базы данных для подключения и выполнения запросов.

алиасы: login_db
encoding
строка
добавлен в 0.2.0 версии community.postgresql
Установите кодировку клиента для текущей сессии (например, UTF-8).
По умолчанию используется кодировка, определенная в базе данных.
login_host
строка
Хост, на котором работает база данных.
login_password
строка
Пароль, используемый для аутентификации.
login_unix_socket
строка
Путь к сокету Unix-домена для локальных подключений.
login_user
строка
По умолчанию:
"postgres"
Имя пользователя, используемое для аутентификации.
named_args
словарь
Словарь пар ключ-значение, которые нужно передать в запрос. Если значение является списком, оно будет преобразовано в массив PostgreSQL.
Взаимоисключительно с positional_args.
path_to_script
путь
Путь к скрипту SQL на целевой машине.
Если скрипт содержит несколько запросов, они должны быть разделены точкой с запятой.
Взаимоисключительно с query.
port
целое число
По умолчанию:
5432
Порт базы данных для подключения.

алиасы: login_port
positional_args
список / элементы=сырые
Список значений, которые должны быть переданы как позиционные аргументы в запрос. Если значение является списком, оно будет преобразовано в массив PostgreSQL.
Взаимоисключительно с named_args.
query
строка
SQL-запрос для выполнения. Переменные могут быть экранированы с помощью синтаксиса psycopg2 http://initd.org/psycopg/docs/usage.html.
search_path
список / элементы=строка
добавлен в 1.0.0 версии community.postgresql
Список имен схем для поиска.
session_role
строка
Переключиться на роль session_role после подключения. Указанная роль session_role должна быть ролью, членом которой является текущий login_user.
Проверка разрешений для SQL-команд выполняется так, как если бы роль session_role была той, которая первоначально вошла в систему.
ssl_mode
строка
    Варианты:
  • разрешить
  • отключить
  • предпочитать ←
  • требовать
  • проверять-ca
  • проверять-полностью
Определяет, будет ли и с какой приоритетностью устанавливаться защищенное SSL TCP/IP-соединение с сервером.
См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах.
Значение по умолчанию prefer соответствует значению по умолчанию libpq.
trust_input
boolean
добавлен в 0.2.0 версии community.postgresql
    Варианты:
  • нет
  • да ←
Если no, проверять, является ли значение session_role потенциально опасным.
Использовать no имеет смысл только тогда, когда возможны SQL-инъекции через session_role.

Примечания

Примечание

  • По умолчанию аутентификация предполагает, что вы входите в систему или используете sudo от учетной записи postgres на хосте.
  • Чтобы избежать ошибки «Проверка подлинности участника не удалась для пользователя postgres», используйте пользователя postgres в качестве become_user.
  • Этот модуль использует psycopg2, адаптер Python для базы данных PostgreSQL. Вы должны убедиться, что psycopg2 установлен на хосте перед использованием этого модуля.
  • Если удаленный хост — это сервер PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удаленном хосте.
  • Для систем на основе Ubuntu установите пакеты postgresql, libpq-dev и python-psycopg2 на удаленном хосте перед использованием этого модуля.
  • Параметр ca_cert требует как минимум версии Postgres 8.4 и версии psycopg2 2.4.3.

См. также

См. также

community.postgresql.postgresql_db

Официальная документация модуля community.postgresql.postgresql_db.

Справочник по схемам PostgreSQL

Полное руководство по документации схем PostgreSQL.

Примеры

- name: Simple select query to acme db
  community.postgresql.postgresql_query:
    db: acme
    query: SELECT version()

- name: Select query to db acme with positional arguments and non-default credentials
  community.postgresql.postgresql_query:
    db: acme
    login_user: django
    login_password: mysecretpass
    query: SELECT * FROM acme WHERE id = %s AND story = %s
    positional_args:
    - 1
    - test

- name: Select query to test_db with named_args
  community.postgresql.postgresql_query:
    db: test_db
    query: SELECT * FROM test WHERE id = %(id_val)s AND story = %(story_val)s
    named_args:
      id_val: 1
      story_val: test

- name: Insert query to test_table in db test_db
  community.postgresql.postgresql_query:
    db: test_db
    query: INSERT INTO test_table (id, story) VALUES (2, 'my_long_story')

- name: Run queries from SQL script using UTF-8 client encoding for session
  community.postgresql.postgresql_query:
    db: test_db
    path_to_script: /var/lib/pgsql/test.sql
    positional_args:
    - 1
    encoding: UTF-8

- name: Example of using autocommit parameter
  community.postgresql.postgresql_query:
    db: test_db
    query: VACUUM
    autocommit: yes

- name: >
    Insert data to the column of array type using positional_args.
    Note that we use quotes here, the same as for passing JSON, etc.
  community.postgresql.postgresql_query:
    query: INSERT INTO test_table (array_column) VALUES (%s)
    positional_args:
    - '{1,2,3}'

# Pass list and string vars as positional_args
- name: Set vars
  ansible.builtin.set_fact:
    my_list:
    - 1
    - 2
    - 3
    my_arr: '{1, 2, 3}'

- name: Select from test table by passing positional_args as arrays
  community.postgresql.postgresql_query:
    query: SELECT * FROM test_array_table WHERE arr_col1 = %s AND arr_col2 = %s
    positional_args:
    - '{{ my_list }}'
    - '{{ my_arr|string }}'

# Select from test table looking into app1 schema first, then,
# if the schema doesn't exist or the table hasn't been found there,
# try to find it in the schema public
- name: Select from test using search_path
  community.postgresql.postgresql_query:
    query: SELECT * FROM test_array_table
    search_path:
    - app1
    - public

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

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

Ключ Возвращаемое значение Описание
query
строка
всегда
Выполненный запрос.
При чтении нескольких запросов из файла содержит только последний.

Пример:
SELECT * FROM bar
query_all_results
список / элементы=список
всегда
Список, содержащий результаты всех выполненных запросов (один подсписок для каждого запроса). Полезно при чтении нескольких запросов из файла.

Пример:
[[{'Столбец': 'Значение1'}, {'Столбец': 'Значение2'}], [{'Столбец': 'Значение1'}, {'Столбец': 'Значение2'}]]
query_list
список / элементы=строка
всегда
Список выполненных запросов. Полезно при чтении нескольких запросов из файла.

Пример:
['SELECT * FROM foo', 'SELECT * FROM bar']
query_result
список / элементы=словарь
всегда
Список словарей в формате столбец:значение, представляющих возвращенные строки.
При выполнении запросов из файла возвращает результат последнего запроса.

Пример:
[{'Столбец': 'Значение1'}, {'Столбец': 'Значение2'}]
rowcount
целое число
изменилось
Количество созданных или затронутых строк.
При использовании скрипта с несколькими запросами содержит общее количество созданных или затронутых строк.

Пример:
5
statusmessage
строка
всегда
Атрибут, содержащий сообщение, возвращенное командой.
При чтении нескольких запросов из файла содержит сообщение последнего запроса.

Пример:
ВСТАВКА 0 1


Авторы

  • Felix Archambault (@archf)
  • Andrew Klychkov (@Andersson007)
  • Will Rouesnel (@wrouesnel)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API