Модуль community.general.odbc — выполнение SQL с помощью ODBC

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 string / обязательный	Строка подключения, передаваемая в ODBC.
params list / элементы типа string	Параметры, передаваемые SQL-запросу.
query string / обязательный	Выполняемый SQL-запрос.

Атрибуты

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

Примечания

Примечание

Как и модуль command, этот модуль всегда возвращает changed=true независимо от того, приведет ли запрос к изменению базы данных.
Чтобы изменить это поведение, можно использовать changed_when: [true или false].
Подробные сведения о возвращаемых значениях (description и 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 list / элементы типа dictionary	Список словарей со сведениями о столбцах, выбранных из курсоров; для операторов DDL, вероятно, будет пустым. См. примечания. Возвращается: при успехе
results list / элементы типа list	Список списков строк, содержащих выбранные строки; для операторов DDL, вероятно, будет пустым. Возвращается: при успехе
row_count string	Количество выбранных или измененных строк согласно настройкам курсора; по умолчанию `-1`. См. примечания. Возвращается: при успехе

Авторы

John Westcott IV (@john-westcott-iv)

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

© 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/general/odbc_module.html