flcdrg/wait-for-mssql

SQL Server就绪等待工具镜像

镜像概述和主要用途

本Docker镜像是一个轻量级脚本工具，用于等待Microsoft SQL Server实例完全准备好接受连接。当SQL Server运行在容器环境中时，容器可能显示"已启动"状态，但SQL Server实际仍在后台加载数据库，此时连接数据库会失败。该工具通过检查数据库上线状态，确保在SQL Server及所有数据库完全就绪后才允许后续操作。

核心功能和特性

• 就绪状态验证：不仅检查SQL Server服务是否启动，还验证所有数据库是否已上线
• 解决"假就绪"问题：避免因容器显示启动但SQL Server未完全加载数据库导致的连接失败
• 轻量级设计：脚本化实现，资源占用低，可快速集成到容器化部署流程
• 数据库状态确认：确保目标数据库（或所有数据库）处于可用状态后才退出等待

使用场景和适用范围

• 容器化SQL Server部署：当SQL Server运行在Docker容器中，需确保依赖服务在连接前数据库已就绪
• CI/CD流程：自动化部署中，作为前置检查步骤确保数据库服务可用
• 多容器协作：在Docker Compose等多容器环境中，控制服务启动顺序（如应用服务等待数据库就绪）
• 数据库迁移/初始化：在执行数据库迁移或初始化脚本前，确保SQL Server完全就绪

详细使用方法和配置说明

基本使用方式

通过docker run命令运行镜像，需提供连接SQL Server的必要参数（如主机地址、认证信息等）。镜像会持续检查SQL Server状态，直至所有数据库上线或超时退出。

环境变量配置

Docker Run示例

bash
docker run --rm \
  -e SQLSERVER_HOST=sqlserver-container \
  -e SQLSERVER_PORT=1433 \
  -e SQL_USER=sa \
  -e SQL_PASSWORD=YourStrong!Passw0rd \
  -e DATABASE_NAME=MyAppDB \
  -e WAIT_TIMEOUT=600 \
  your-registry/wait-for-mssql:latest

Docker Compose集成示例

在多容器环境中，可作为依赖服务的前置检查：

yaml
version: '3.8'
services:
  # SQL Server容器
  sqlserver:
    image: mcr.microsoft.com/mssql/server:latest
    environment:
      - ACCEPT_EULA=Y
      - SA_PASSWORD=YourStrong!Passw0rd
    ports:
      - "1433:1433"

  # 等待SQL Server就绪
  wait-for-sql:
    image: your-registry/wait-for-mssql:latest
    depends_on:
      - sqlserver
    environment:
      - SQLSERVER_HOST=sqlserver
      - SQLSERVER_PORT=1433
      - SQL_USER=sa
      - SQL_PASSWORD=YourStrong!Passw0rd
      - DATABASE_NAME=MyAppDB
      - WAIT_TIMEOUT=600

  # 依赖数据库的应用服务
  app-service:
    build: ./app
    depends_on:
      wait-for-sql:
        condition: service_completed_successfully
    environment:
      - DB_HOST=sqlserver
      - DB_NAME=MyAppDB

退出码说明

• 0：SQL Server及目标数据库已成功就绪
• 1：等待超时（超过WAIT_TIMEOUT仍未就绪）
• 2：连接SQL Server失败（如认证错误、网络不可达）
• 3：参数配置错误（如缺少必填环境变量）