Модуль community.general.odbc – Выполнение SQL-запросов через ODBC

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные зависимости, подробнее см. Требования.

Для использования в книге задач укажите: community.general.odbc.

Добавлен в community.general 1.0.0

Описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Описание

Чтение/запись данных через драйверы ODBC.

Требования

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

pyodbc

Параметры

Параметр	Комментарии
commit boolean добавлено в community.general 1.3.0	Выполнить фиксацию изменений после выполнения SQL-запроса. Некоторые базы данных позволяют выполнять фиксацию после запроса SELECT, в то время как другие генерируют исключение. По умолчанию `true` для поддержки поведения старого модуля. Варианты: `false` `true` ← (по умолчанию)
dsn строка / требуется	Строка подключения, передаваемая в ODBC.
params список / элементы=строка	Параметры для передачи в SQL-запрос.
query строка / требуется	SQL-запрос для выполнения.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Модуль может работать в режиме `check_mode` и возвращать прогноз о внесенных изменениях без модификации целевого объекта.
diff_mode	Поддержка: нет	В режиме сравнения модуль вернет информацию о том, что изменилось (или, возможно, должно измениться в `check_mode`).

Примечания

Примечание

Подобно модулю command, этот модуль всегда возвращает changed = да, независимо от того, изменятся ли данные в базе данных.
Чтобы изменить это поведение, используйте changed_when: [да или нет].
Подробнее о возвращаемых значениях (описание и row_count) см. https://github.com/mkleehammer/pyodbc/wiki/Cursor.

Примеры

- name: Set some values in the test db
  community.general.odbc:
    dsn: "DRIVER={ODBC Driver 13 for SQL Server};Server=db.ansible.com;Database=my_db;UID=admin;PWD=password;"
    query: "Select * from table_a where column1 = ?"
    params:
      - "value1"
    commit: false
  changed_when: false

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

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

Ключ	Описание
description список / элементы=словарь	Список словарей о выбранных столбцах из курсоров, вероятно, пустой для DDL-запросов. См. примечания. Возвращается: успех
results список / элементы=список	Список списков строк, содержащих выбранные строки, вероятно, пустой для DDL-запросов. Возвращается: успех
row_count строка	Количество выбранных или измененных строк, по умолчанию -1. См. примечания. Возвращается: успех

Авторы

John Westcott IV (@john-westcott-iv)

Ссылки на коллекцию

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