Модуль lowlydba.sqlserver.install_script — выполняет сценарии миграции для базы данных

Примечание

Этот модуль входит в коллекцию lowlydba.sqlserver (версия 2.8.1).

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

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

Чтобы использовать модуль в плейбуке, укажите: lowlydba.sqlserver.install_script.

Добавлено в lowlydba.sqlserver 0.11.0

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

Краткое описание

Использует модуль DBOps для выполнения Dbo-InstallScript в целевой базе данных SQL Server.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

Модуль PowerShell dbatools
Модуль PowerShell dbops

Параметры

Параметр	Комментарии
connection_timeout целое число	Время ожидания подключения к серверу базы данных в секундах. Влияет только на попытки подключения, но не на время ожидания выполнения. По умолчанию: `30`
create_database логическое значение	Создаст пустую базу данных, если она отсутствует. Варианты: `false` ← (по умолчанию) `true`
database строка / обязательный	Имя целевой базы данных.
deployment_method строка	`SingleTransaction` — оборачивает все сценарии развертывания в одну транзакцию и отменяет всё развертывание при ошибке. `TransactionPerScript` — оборачивает каждый сценарий в отдельную транзакцию; при ошибке отменяется развертывание только этого сценария. `NoTransaction` — выполняет развертывание без изменений. `AlwaysRollback` — отменяет транзакцию. Варианты: `"NoTransaction"` ← (по умолчанию) `"SingleTransaction"` `"TransactionPerScript"` `"AlwaysRollback"`
execution_timeout целое число	Время ожидания выполнения сценария. Сценарий будет прерван, если его выполнение займет больше указанного числа секунд. По умолчанию: `0`
match строка	Проверяет имена предоставленных файлов на соответствие регулярному выражению, заданному этой строкой.
no_log_version логическое значение	Если параметр задан, сведения о развертывании не будут записываться в базу данных. Это также означает, что все сценарии и все сборки из пакета будут развернуты независимо от истории предыдущих развертываний. Варианты: `false` ← (по умолчанию) `true`
no_recurse логическое значение	Обрабатывает только первый уровень целевого пути. Варианты: `false` ← (по умолчанию) `true`
output_file строка	Записывает вывод в указанный файл.
path строка / обязательный	Каталог, в котором хранятся целевые SQL-сценарии.
schema_version_table строка	Таблица, в которой хранится история выполнения сценариев. Эта таблица используется для выбора сценариев, которые нужно запустить при развертывании, и предотвращает повторное выполнение сценариев.
sql_instance строка / обязательный	Экземпляр SQL Server, который требуется изменить.
sql_password строка	Пароль для аутентификации SQL.
sql_username строка	Имя пользователя для аутентификации SQL.

Атрибуты

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

Примеры

- name: Migrate a database
  lowlydba.sqlserver.install_script:
    sql_instance: test-server.my.company.com
    database: AdventureWorks
    path: migrations

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

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

Ключ	Описание
data словарь	Измененный вывод функции `Install-DboScript`. Возвращается: при успешном выполнении, но не в режиме check_mode.

Авторы

John McCall (@lowlydba)

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

© 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/lowlydba/sqlserver/install_script_module.html