community.general.odbc – Выполнение SQL-запросов через ODBC
Примечание
Этот плагин входит в состав коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать его в книге задач, укажите: community.general.odbc.
Введено в версии 1.0.0: коллекции community.general
Обзор
- Чтение/запись информации через драйверы ODBC.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- pyodbc
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| commit логический тип добавлен в 1.3.0 коллекции community.general |
| Выполнить подтверждение после выполнения SQL-запроса. Некоторые базы данных позволяют подтверждение после запроса SELECT, в то время как другие генерируют исключение. Значение по умолчанию true для поддержки поведения старого модуля. |
| dsn строка / обязательно | Строка подключения, передаваемая в ODBC. | |
| params список / элементы=строка | Параметры для передачи в SQL-запрос. | |
| query строка / обязательно | SQL-запрос для выполнения. |
Примечания
Примечание
- Как и модуль command, этот модуль всегда возвращает changed = yes, независимо от того, изменил ли запрос базу данных.
- Чтобы изменить это поведение, можно использовать
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: no
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description список / элементы=словарь | успех | Список словарей, содержащих информацию о столбцах, выбранных из курсора, скорее всего, пуст для операторов DDL. См. Примечания. |
| results список / элементы=список | успех | Список списков строк, содержащих выбранные строки, скорее всего, пуст для операторов DDL. |
| row_count строка | успех | Количество выбранных или изменённых строк, в соответствии с настройками курсора, по умолчанию -1. См. Примечания. |
Авторы
- John Westcott IV (@john-westcott-iv)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/odbc_module.html
