lowlydba.sqlserver.restore 模块 – 执行还原操作

注意

此模块是 lowlydba.sqlserver 集合（版本 2.3.4）的一部分。

如果您使用的是 ansible 包，您可能已经安装了这个集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install lowlydba.sqlserver。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：lowlydba.sqlserver.restore。

lowlydba.sqlserver 0.9.0 中的新增功能

概要

  • 执行数据库还原操作。

要求

在执行此模块的主机上需要以下要求。

参数

参数

注释

azure_credential

字符串

如果使用存储访问密钥从 Azure 托管的备份还原，则要使用的 SQL Server 凭据的名称。

block_size

字符串

指定要使用的块大小。

选项

  • "0.5kb"

  • "1kb"

  • "2kb"

  • "4kb"

  • "8kb"

  • "16kb"

  • "32kb"

  • "64kb"

buffer_count

整数

要使用的 I/O 缓冲区数。

默认值： 0

database

字符串

要处理的数据库。

destination_data_directory

字符串

目标实例上还原 SQL Server 备份的路径。

如果仅指定此选项，则所有数据库文件（数据和日志）都将还原到此位置

destination_file_prefix

字符串

此值将作为前缀添加到所有还原的文件（日志和数据）。

destination_file_suffix

字符串

此值将作为后缀添加到所有还原的文件（日志和数据）。

destination_filestream_directory

字符串

还原 FileStream 数据的路径。

此选项只能与 destination_data_directory 一起指定。

destination_log_directory

字符串

还原数据库日志文件的路径。

此选项只能与 destination_data_directory 一起指定。

directory_recurse

布尔值

如果指定，则会递归到指定的目录中（覆盖默认行为）。

选项

  • false ← (默认)

  • true

ignore_diff_backup

布尔值

指示跳过还原任何差异备份。

选项

  • false ← (默认)

  • true

ignore_log_backup

布尔值

指示跳过还原任何日志备份。

选项

  • false ← (默认)

  • true

keep_cdc

布尔值

指示是否应将 CDC 信息作为数据库的一部分还原。

选项

  • false

  • true

keep_replication

布尔值

指示是否应将复制配置作为数据库还原操作的一部分还原。

选项

  • false ← (默认)

  • true

maintenance_solution_backup

布尔值

切换以指示备份文件是否位于 Ola Hallengreen 的维护脚本创建的文件夹结构中。

这样可以更快地解析文件。

选项

  • false ← (默认)

  • true

max_transfer_size

整数

设置传输单元的大小。 值必须是 64kb 的倍数。

默认值： 0

no_recovery

布尔值

指示是否应在上次还原后恢复数据库。

选项

  • false ← (默认)

  • true

no_xp_dir_recurse

布尔值

如果指定，则会阻止 XpDirTree 进程递归（其默认行为）。

选项

  • false ← (默认)

  • true

path

字符串 / 必需

SQL Server 备份文件的路径。

作为字符串传入的路径将使用所需的方法进行扫描，默认是递归文件夹扫描。

接受以 , 分隔的多个路径。

replace_db_name_in_file

布尔值

如果设置了此开关，则数据或日志文件中任何出现的原始数据库名称都将替换为 database_name 选项中指定的名称。

选项

  • false

  • true

restore_time

字符串

指定要将数据库还原到的日期时间字符串 HH:MM:SS MM/DD/YYYY。

默认值是指定备份中可用的最新点。

restored_database_name_prefix

字符串

将作为前缀添加到还原数据库名称开头的字符串。

reuse_source_folder_structure

布尔值

默认情况下，数据库将迁移到目标 SQL Server 的默认数据和日志目录。

您可以使用 reuse_source_folder_structure 来覆盖此设置。

选项

  • false

  • true

sql_instance

字符串 / 必需

要修改的 SQL Server 实例。

sql_password

字符串

SQL 身份验证的密码。

sql_username

字符串

SQL 身份验证的用户名。

standby_directory

字符串

如果指定了目录，则数据库将还原到备用状态，备用文件将放置到此目录中（该目录必须存在，并且目标 SQL Server 实例可写入）。

stop_after_date

字符串

默认情况下，还原将在链中找到的第一个 stop_mark 处停止，传递日期时间字符串 HH:MM:SS MM/DD/YYYY 将导致它在该日期时间之后的第一个 stop_mark 处停止。

stop_before

布尔值

切换以指示还原应在 stop_mark 出现之前停止，默认是在创建标记时停止。

选项

  • false ← (默认)

  • true

stop_mark

字符串

事务日志中停止还原的标记点。

use_destination_default_directories

布尔值

此开关指示还原操作使用目标服务器上的默认数据和日志位置。

如果这些位置不存在，该函数将尝试创建它们。

选项

  • false

  • true

verify_only

布尔值

指示只应验证还原操作。

选项

  • false ← (默认)

  • true

with_replace

布尔值

指示是否允许还原操作替换现有数据库。

选项

  • false ← (默认)

  • true

xp_dirtree

布尔值

此开关指示应由 SQL Server 实例使用 xp_dirtree 执行文件扫描。

这将从传入的路径递归扫描。

您必须具有该实例上的 sysadmin 角色成员资格才能使其工作。

选项

  • false

  • true

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 下运行并返回更改状态预测，而无需修改目标。

platform

平台: 全部

可以对其进行操作的目标操作系统/系列。

示例

- name: Restore a Database
  lowlydba.sqlserver.restore:
    sql_instance: sql-01.myco.io
    database: LowlyDB

- name: Restore a Database and allow future T-Log restores
  lowlydba.sqlserver.restore:
    sql_instance: sql-01.myco.io
    database: LowlyDB1
    no_recovery: true

- name: Verify backup files, no restore
  lowlydba.sqlserver.restore:
    sql_instance: sql-01.myco.io
    database: LowlyDB2
    verify_only: true

返回值

常见的返回值记录在此处，以下是此模块特有的字段

键

描述

data

字典

来自 Restore-DbaDatabase 函数的修改后的输出。

返回: 成功，但在 check_mode 下不返回。

作者

  • John McCall (@lowlydba)