community.general.mssql_db 模块 – 在远程主机上添加或删除 MSSQL 数据库

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

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

要在剧本中使用它，请指定：community.general.mssql_db。

概要

  • 在远程主机上添加或删除 MSSQL 数据库。

要求

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

  • pymssql

参数

参数

注释

autocommit

布尔值

仅当导入成功时才自动提交更改。有时需要使用 autocommit=true，因为某些内容无法在事务中更改。

选项

  • false ← (默认)

  • true

login_host

字符串 / 必需

运行数据库的主机

login_password

字符串

用于身份验证的密码

默认值： ""

login_port

字符串

MSSQL 服务器的端口。如果使用 login_port，则需要将 login_host 定义为 localhost 以外的值

默认值： "1433"

login_user

字符串

用于身份验证的用户名

默认值： ""

name

别名：db

字符串 / 必需

要添加或删除的数据库名称

state

字符串

数据库状态

选项

  • "present" ← (默认)

  • "absent"

  • "import"

target

字符串

远程主机上要从中读取或写入的转储文件的位置。支持未压缩的 SQL 文件（.sql）文件。

属性

属性

支持

描述

check_mode

支持：不支持

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

diff_mode

支持：不支持

在差异模式下，将返回有关更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

注释

注意

  • 需要远程主机上的 pymssql Python 包。对于 Ubuntu，这很简单，只需 pip install pymssql（参见 ansible.builtin.pip）。

示例

- name: Create a new database with name 'jackdata'
  community.general.mssql_db:
    name: jackdata
    state: present

# Copy database dump file to remote host and restore it to database 'my_db'
- name: Copy database dump file to remote host
  ansible.builtin.copy:
    src: dump.sql
    dest: /tmp

- name: Restore the dump file to database 'my_db'
  community.general.mssql_db:
    name: my_db
    state: import
    target: /tmp/dump.sql

作者

  • Vedit Firat Arig (@vedit)