cilerler/microsoft-mssql-tools

Microsoft MSSQL Tools with PowerShell Docker镜像

镜像概述

本Docker镜像基于mcr.microsoft.com/mssql-tools:latest构建，整合了Microsoft SQL Server命令行工具与PowerShell 7+，提供统一的容器环境用于执行SQL操作和PowerShell脚本，简化数据库相关任务的自动化与部署流程。

基础镜像组件

该镜像包含以下核心组件：

• sqlcmd - SQL Server命令行实用工具
• bcp - 批量复制程序工具
• PowerShell 7+ - 跨平台PowerShell环境

核心功能与特性

• 集成SQL Server命令行工具与PowerShell脚本环境
• 支持交互式PowerShell会话与非交互式命令执行
• 提供文件挂载功能，可运行本地SQL脚本
• 支持环境变量注入，简化连接参数配置
• 兼容CI/CD管道集成，实现数据库自动化部署
• 支持批量数据导入导出(bcp)操作

使用场景

• 通过PowerShell执行sqlcmd命令运行SQL脚本
• 数据库迁移与部署自动化
• CI/CD管道中的数据库操作集成
• 批量数据导入/导出(bcp)任务
• 结合PowerShell脚本逻辑实现复杂SQL操作流程

前提条件

• Windows系统安装Docker Desktop
• 可访问的SQL Server实例（本地或远程）

快速入门

拉取镜像

powershell
docker pull cilerler/microsoft-mssql-tools:latest

基础用法 - 交互式PowerShell会话

powershell
docker run -it --rm cilerler/microsoft-mssql-tools:latest pwsh

进入容器后，可直接使用sqlcmd：

powershell
sqlcmd -S your-server.database.windows.net -U your-username -P your-password -d your-database -Q "SELECT @@VERSION"

常见使用模式

从PowerShell执行SQL查询

powershell
docker run --rm cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "sqlcmd -S 'your-server' -U 'your-username' -P 'your-password' -d 'your-database' -Q 'SELECT GETDATE()'"

运行SQL脚本文件

首先挂载包含SQL脚本的本地目录：

powershell
docker run --rm -v ${PWD}:/scripts cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "sqlcmd -S 'your-server' -U 'your-username' -P 'your-password' -d 'your-database' -i /scripts/your-script.sql"

使用环境变量配置连接

powershell
docker run --rm `
    -e SQL_SERVER='your-server' `
    -e SQL_USER='your-username' `
    -e SQL_PASSWORD='your-password' `
    -e SQL_DATABASE='your-database' `
    cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "sqlcmd -S `$env:SQL_SERVER -U `$env:SQL_USER -P `$env:SQL_PASSWORD -d `$env:SQL_DATABASE -Q 'SELECT DB_NAME()'"

执行包含SQL操作的PowerShell脚本

创建PowerShell脚本（db-operations.ps1）：

powershell
# db-operations.ps1
$server = $env:SQL_SERVER
$user = $env:SQL_USER
$password = $env:SQL_PASSWORD
$database = $env:SQL_DATABASE

Write-Host "连接到 $server..."

$result = sqlcmd -S $server -U $user -P $password -d $database -Q "SELECT COUNT(*) FROM sys.tables" -h -1

Write-Host "表数量: $result"

运行脚本：

powershell
docker run --rm `
    -v ${PWD}:/scripts `
    -e SQL_SERVER='your-server' `
    -e SQL_USER='your-username' `
    -e SQL_PASSWORD='your-password' `
    -e SQL_DATABASE='your-database' `
    cilerler/microsoft-mssql-tools:latest pwsh /scripts/db-operations.ps1

批量复制(bcp)操作

导出数据到文件：

powershell
docker run --rm -v ${PWD}:/data cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "bcp 'SELECT * FROM YourTable' queryout /data/output.dat -S 'your-server' -U 'your-username' -P 'your-password' -d 'your-database' -c"

从文件导入数据：

powershell
docker run --rm -v ${PWD}:/data cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "bcp YourTable in /data/input.dat -S 'your-server' -U 'your-username' -P 'your-password' -d 'your-database' -c"

连接到本地SQL Server

若在Windows主机上运行本地SQL Server，从容器连接方法：

powershell
# 使用host.docker.internal引用Windows主机
docker run --rm cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "sqlcmd -S 'host.docker.internal' -U 'sa' -P 'YourPassword' -Q 'SELECT @@SERVERNAME'"

连接到其他容器中的SQL Server

若SQL Server运行在Docker容器中：

powershell
# 创建网络
docker network create sql-network

# 运行SQL Server（示例）
docker run -d --name sqlserver --network sql-network `
    -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=YourStrong@Password" `
    mcr.microsoft.com/mssql/server:2022-latest

# 在同一网络中运行mssql-tools容器
docker run --rm --network sql-network cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "sqlcmd -S 'sqlserver' -U 'sa' -P 'YourStrong@Password' -Q 'SELECT @@VERSION'"

Docker Compose配置

创建docker-compose.yml：

yaml
version: '3.8'

services:
  sqlserver:
    image: mcr.microsoft.com/mssql/server:2022-latest
    environment:
      ACCEPT_EULA: "Y"
      SA_PASSWORD: "YourStrong@Password"
    ports:
      - "1433:1433"

  sql-tools:
    image: cilerler/microsoft-mssql-tools:latest
    depends_on:
      - sqlserver
    environment:
      SQL_SERVER: sqlserver
      SQL_USER: sa
      SQL_PASSWORD: "YourStrong@Password"
      SQL_DATABASE: master
    volumes:
      - ./scripts:/scripts
    command: pwsh -Command "Start-Sleep -Seconds 10; sqlcmd -S $env:SQL_SERVER -U $env:SQL_USER -P $env:SQL_PASSWORD -i /scripts/init.sql"

运行：

powershell
docker-compose up

CI/CD集成

Azure DevOps管道示例

yaml
steps:
- task: Docker@2
  displayName: '运行数据库迁移'
  inputs:
    command: 'run'
    arguments: >
      --rm
      -v $(Build.SourcesDirectory)/database:/scripts
      -e SQL_SERVER=$(SqlServer)
      -e SQL_USER=$(SqlUser)
      -e SQL_PASSWORD=$(SqlPassword)
      -e SQL_DATABASE=$(SqlDatabase)
      cilerler/microsoft-mssql-tools:latest
      pwsh /scripts/migrate.ps1

GitHub Actions示例

yaml
- name: 运行数据库脚本
  run: |
    docker run --rm `
      -v ${{ github.workspace }}/database:/scripts `
      -e SQL_SERVER=${{ secrets.SQL_SERVER }} `
      -e SQL_USER=${{ secrets.SQL_USER }} `
      -e SQL_PASSWORD=${{ secrets.SQL_PASSWORD }} `
      -e SQL_DATABASE=${{ secrets.SQL_DATABASE }} `
      cilerler/microsoft-mssql-tools:latest `
      pwsh /scripts/deploy.ps1
  shell: pwsh

高级PowerShell场景

使用SqlServer PowerShell模块

可在运行时安装SqlServer模块：

powershell
docker run -it --rm cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "Install-Module -Name SqlServer -Force -AllowClobber; Import-Module SqlServer; Invoke-Sqlcmd -ServerInstance 'your-server' -Username 'your-username' -Password 'your-password' -Query 'SELECT @@VERSION'"

PowerShell脚本错误处理

powershell
# check-database.ps1
$ErrorActionPreference = "Stop"

try {
    $result = sqlcmd -S $env:SQL_SERVER -U $env:SQL_USER -P $env:SQL_PASSWORD -Q "SELECT 1" -h -1
    
    if ($LASTEXITCODE -eq 0) {
        Write-Host "连接成功!"
        exit 0
    } else {
        Write-Error "连接失败，退出码: $LASTEXITCODE"
        exit 1
    }
} catch {
    Write-Error "错误: $_"
    exit 1
}

sqlcmd常用选项

• -S - 服务器名称或IP地址
• -U - 用户名（SQL Server身份验证）
• -P - 密码（SQL Server身份验证）
• -E - 使用Windows身份验证（Linux容器中不适用）
• -d - 数据库名称
• -Q - 执行查询后退出
• -i - 输入文件（SQL脚本）
• -o - 输出文件
• -h -1 - 移除输出中的标题
• -s - 列分隔符
• -W - 移除尾随空格
• -C - 信任服务器证书（用于加密连接）

安全注意事项

切勿在脚本或命令历史中硬编码密码，应使用环境变量或安全的密钥管理：

powershell
# 从环境变量读取
$password = $env:SQL_PASSWORD

# 或在Swarm模式中使用Docker Secrets
docker run --rm `
    --secret sql-password `
    cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "sqlcmd -S 'your-server' -U 'your-username' -P (Get-Content /run/secrets/sql-password) -Q 'SELECT 1'"

故障排除

连接问题

若连接失败，验证连接字符串：

powershell
docker run --rm cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "sqlcmd -S 'your-server' -U 'your-username' -P 'your-password' -Q 'SELECT 1' -C"

使用-C参数信任服务器证书（适用于加密连接）。

检查已安装版本

powershell
docker run --rm cilerler/microsoft-mssql-tools:latest pwsh -Command `
    "sqlcmd -?; Write-Host '---'; pwsh --version"

本地构建镜像

如需本地构建该镜像：

powershell
# 克隆或创建Dockerfile后执行
docker build -t cilerler/microsoft-mssql-tools:latest .

许可证

本镜像基于Microsoft官方SQL Server工具镜像构建。有关sqlcmd和bcp实用工具的许可条款，请参阅Microsoft的许可条款。

贡献

欢迎提交issue和拉取请求以改进此镜像和文档。

链接

• Microsoft SQL Server工具文档
• sqlcmd实用工具
• bcp实用工具
• PowerShell文档