Mig2schema

🚀 mig2schema

mig2schemaは、MCPを使用してPostgreSQLのマイグレーションファイルからデータベーススキーマを抽出するツールです。一時的なデータベースを実行することでスキーマを発見します。多数のファイルが含まれるマイグレーションフォルダを持つプロジェクトで作業する際に便利です。

🚀 クイックスタート

mig2schemaは、PostgreSQLのマイグレーションファイル（.up.sql と .down.sql）が含まれるディレクトリを指定すると、マイグレーションを実行した後のデータベーススキーマを抽出します。testcontainersを使用して一時的なPostgreSQLインスタンスを起動し、マイグレーションを実行し、その後スキーマ情報を抽出します。

✨ 主な機能

• マイグレーションファイルからデータベーススキーマを抽出する
• 複数のスキーマ抽出プロバイダをサポートする
• Claude CodeのMCPサーバーとして使用できる

📦 インストール

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プロバイダを使用する（PATHにpg_dumpが必要で、抽出モードのみサポート）
./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での使用方法

このツールは、Claude CodeのMCP（Model Context Protocol）サーバーとして使用できます。

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（必須）: マイグレーションファイルが含まれるディレクトリのパス