Mig2schema

🚀 mig2schema

mig2schema是一款實用工具，它藉助MCP從PostgreSQL遷移文件中提取數據庫模式。通過運行臨時數據庫來發現模式，特別適用於處理包含大量遷移文件的項目。

🚀 快速開始

mig2schema能夠讀取包含PostgreSQL遷移文件（.up.sql和.down.sql）的目錄，並在運行遷移後提取最終的數據庫模式。它利用testcontainers啟動一個臨時的PostgreSQL實例，運行遷移，然後提取模式信息。

✨ 主要特性

• 多模式支持：支持信息模式和提取模式，滿足不同場景下對數據庫模式信息的獲取需求。
• 多提供者支持：支持多種模式提取提供者，如native和pg_dump，可根據需求選擇合適的提供者。
• MCP集成：可作為MCP（Model Context Protocol）服務器在Claude Code中使用，方便進行數據庫模式的提取和遷移文件的驗證。

📦 安裝指南

go build -o mig2schema

💻 使用示例

基礎用法

信息模式（默認）

顯示人類可讀的模式信息：

./mig2schema /path/to/migrations

提取模式

輸出可用於重新創建模式的SQL CREATE語句：

./mig2schema -e /path/to/migrations
./mig2schema --extract /path/to/migrations

模式提取提供者

該工具支持多種模式提取提供者：

• native（默認）：使用SQL查詢information_schema的內置提供者。
• pg_dump：使用PostgreSQL的pg_dump實用工具進行完整的DDL提取。

# 列出可用的提供者
./mig2schema --list-providers

# 使用native提供者（默認）
./mig2schema -p native -e /path/to/migrations

# 使用pg_dump提供者（需要將pg_dump添加到PATH中，僅支持提取模式）
./mig2schema -p pg_dump -e /path/to/migrations

⚠️ 重要提示

pg_dump提供者僅適用於提取模式（-e），並能提供更完整的模式信息，包括外鍵、序列和所有約束。

高級用法

遷移文件格式示例

該工具期望遷移文件遵循以下命名約定：

• 001_create_users.up.sql - 遷移上文件
• 001_create_users.down.sql - 遷移下文件（可選）

文件按文件名的字母順序執行。

示例輸出

信息模式示例

./mig2schema examples/migrations

# 輸出:
# === DATABASE SCHEMA ===
# Table: users
# Columns:
#   - id integer NOT NULL (PRIMARY KEY)
#   - email character varying NOT NULL
#   - username character varying NOT NULL
# Indexes:
#   - idx_users_email on (email)
#   - users_email_key on (email) (UNIQUE)

提取模式示例

使用native提供者：

./mig2schema -e examples/migrations

# 輸出:
# create table users (
#     id integer not null default nextval('users_id_seq'::regclass),
#     email varchar(255) not null,
#     username varchar(255) not null,
#     primary key (id)
# );
# 
# create index idx_users_email on users (email);
# create unique index users_email_key on users (email);

使用pg_dump提供者（輸出更完整）：

./mig2schema -p pg_dump -e examples/migrations

# 輸出包括:
# - 完整的CREATE TABLE語句
# - 用於序列的ALTER TABLE語句
# - 外鍵約束
# - 所有具有正確語法的索引
# - 默認值和約束

🔧 技術細節

運行要求

• Docker：用於testcontainers。
• Go 1.24.2+：程序運行的基礎環境。
• PostgreSQL客戶端工具：（可選，pg_dump提供者需要）。

與Claude Code集成

該工具可作為MCP（Model Context Protocol）服務器在Claude Code中使用：

claude mcp add mig2schema -- {path}/mig2schema --mcp

其中{path}是mig2schema二進制文件的完整路徑（例如，/Users/username/go/bin/mig2schema）。

集成後，Claude Code可以使用以下工具：

extract_schema

使用pg_dump從遷移文件中提取數據庫模式以獲得完整的DDL輸出。

參數：

• migration_directory（必需）：包含遷移文件的目錄路徑。
• format（可選）：輸出格式 - "sql"（默認且唯一選項）。

在Claude Code中的示例用法：

Use the extract_schema tool with migration_directory="./migrations"

⚠️ 重要提示

MCP模式始終使用pg_dump提供者，並輸出SQL DDL以進行最完整、最準確的模式提取，包括外鍵、序列和所有約束。

validate_migrations

在不運行遷移文件的情況下驗證它們。

參數：

• migration_directory（必需）：包含遷移文件的目錄路徑。