ongres/babelfish-compass

babelfish-compass Docker 镜像文档

镜像概述

babelfish-compass 是专为 Babelfish for PostgreSQL 设计的数据库迁移工具镜像，旨在简化从 SQL Server 到支持 Babelfish 的 PostgreSQL 数据库的迁移过程。该镜像集成了迁移全流程所需的工具链，帮助用户完成迁移评估、模式转换、数据迁移及兼容性验证，降低数据库迁移的技术门槛和复杂度。

核心功能和特性

• 迁移评估：扫描 SQL Server 数据库结构与 workload，生成迁移可行性报告，识别潜在兼容性问题
• 模式转换：自动将 SQL Server 数据库对象（表、视图、存储过程、函数等）转换为 Babelfish 兼容的 PostgreSQL 语法
• 数据迁移：支持全量数据迁移与增量数据同步，确保数据一致性与完整性
• 兼容性验证：迁移后自动验证对象兼容性、数据一致性及查询兼容性，提供修复建议
• 轻量级部署：基于 Alpine 构建，体积小巧，支持命令行与配置文件两种使用方式，易于集成到自动化流程

使用场景和适用范围

• 企业级迁移项目：SQL Server 数据库向 PostgreSQL (Babelfish) 的生产环境迁移
• 迁移前期评估：在正式迁移前评估工作量、风险及兼容性问题
• 开发测试环境：快速搭建迁移测试环境，验证迁移方案
• 自动化流程：集成到 CI/CD 管道，实现迁移评估、测试的自动化

使用方法和配置说明

前提条件

• Docker 引擎 20.10 及以上版本
• 源 SQL Server 数据库网络可访问，且具备读写权限
• 目标 Babelfish 实例（PostgreSQL with Babelfish）网络可访问，且具备管理员权限
• 本地工作目录（用于挂载输出报告和脚本）

基本使用（docker run）

1. 迁移评估

bash
docker run --rm -v $(pwd)/output:/workspace \
  -e SOURCE_CONN_STR="sqlserver://sa:YourStrong!Passw0rd@sqlserver-host:1433?database=AdventureWorks" \
  -e TARGET_CONN_STR="postgresql://postgres:postgres@babelfish-host:5432/babelfish_db" \
  docker.xuanyuan.run/babelfish-compass:latest evaluate

执行后，评估报告将生成在 ./output/evaluation_report.json

2. 模式转换

bash
docker run --rm -v $(pwd)/output:/workspace \
  -e SOURCE_CONN_STR="sqlserver://sa:YourStrong!Passw0rd@sqlserver-host:1433?database=AdventureWorks" \
  -e TARGET_CONN_STR="postgresql://postgres:postgres@babelfish-host:5432/babelfish_db" \
  -e EXCLUDE_OBJECTS="dbo.table1,dbo.view2" \
  docker.xuanyuan.run/babelfish-compass:latest convert-schema

转换后的模式脚本将生成在 ./output/schema/ 目录

3. 数据迁移

bash
docker run --rm -v $(pwd)/output:/workspace \
  -e SOURCE_CONN_STR="sqlserver://sa:YourStrong!Passw0rd@sqlserver-host:1433?database=AdventureWorks" \
  -e TARGET_CONN_STR="postgresql://postgres:postgres@babelfish-host:5432/babelfish_db" \
  -e BATCH_SIZE=10000 \
  docker.xuanyuan.run/babelfish-compass:latest migrate-data

环境变量配置

docker-compose 示例

yaml
version: '3.8'

services:
  babelfish-compass:
    image: docker.xuanyuan.run/babelfish-compass:latest
    volumes:
      - ./migration-output:/workspace
    environment:
      - SOURCE_CONN_STR=sqlserver://sa:YourStrong!Passw0rd@sqlserver:1433?database=AdventureWorks
      - TARGET_CONN_STR=postgresql://postgres:postgres@babelfish:5432/babelfish_db
      - LOG_LEVEL=DEBUG
      - BATCH_SIZE=20000
    command: migrate-data
    depends_on:
      - sqlserver
      - babelfish

  sqlserver:
    image: ***-mcr.xuanyuan.run/mssql/server:2019-latest
    environment:
      - ACCEPT_EULA=Y
      - SA_PASSWORD=YourStrong!Passw0rd
    ports:
      - "1433:1433"

  babelfish:
    image: docker.xuanyuan.run/edb/babelfish:latest
    environment:
      - POSTGRES_PASSWORD=postgres
      - BABELFISH_PASSWORD=postgres
    ports:
      - "5432:5432"

注意事项

1. 数据备份：迁移前务必备份源数据库和目标数据库，避免数据丢失
2. 权限要求：源数据库需具备 db_owner 权限，目标数据库需具备 SUPERUSER 权限
3. 复杂对象处理：部分复杂 SQL Server 特性（如 CLR 函数、扩展存储过程）需手动转换，工具会在报告中标记
4. 性能调优：大规模数据迁移时，建议调整 BATCH_SIZE 参数优化性能，并在非业务高峰期执行
5. 版本兼容性：确保目标 Babelfish 版本与源 SQL Server 版本兼容（参考 Babelfish 官方兼容性文档）