【ITニュース解説】Kyrage: A TypeScript-First Database Migration Tool for Modern Development

システム開発において、データベースはアプリケーションのデータを保存する基盤として非常に重要である。アプリケーションの機能を追加したり改善したりする過程では、データの構造、つまり「データベーススキーマ」を変更する必要が頻繁に発生する。例えば、ユーザー情報を保存するテーブルに新しい項目を追加したり、既存の項目を削除したり、データ型を変更したりする作業である。これらの変更を安全に、そして一貫性をもって管理する仕組みが「データベースマイグレーション」と呼ばれる。

これまでの多くのデータベースマイグレーションツールでは、開発者がデータベースの変更内容をSQL（Structured Query Language）という言語で手動で記述し、そのSQLファイル（マイグレーションファイル）を管理することが一般的であった。新しいカラムを追加する際には「ALTER TABLE ADD COLUMN」、削除する際には「ALTER TABLE DROP COLUMN」といった具体的なSQL文を開発者自身が書く必要があった。しかし、このような手動でのSQL記述は、書き間違いによるエラーを引き起こしやすく、また手間と時間がかかる作業でもある。特に、複数の開発者が一つのプロジェクトで作業するチーム開発においては、それぞれの開発者が異なるスキーマ変更を行うことで、変更内容が衝突したり、特定の環境でのみ問題が発生したりする「環境依存」の問題が起こりがちであった。

また、Node.jsやTypeScriptといった現代的な開発環境において、CockroachDBのような特定の高機能データベースを使用する際、人気の既存マイグレーションツール（DrizzleやPrismaなど）が十分なサポートを提供していなかったり、予期せぬ問題に直面することがあった。これらのツールは便利である一方、TypeScriptのエコシステムと完全に統合されていなかったり、データベースの「理想の状態」を宣言的に（「こうあるべき」と記述するだけでツールが差分を判断する）定義できるような、より進んだアプローチを提供するツールが求められていた。このような課題を解決し、データベーススキーマの管理をよりシンプルに、より安全に、そしてTypeScript開発者が慣れ親しんだ環境で実現するための新しいツールとして「Kyrage（キラージュ）」が開発された。

Kyrageは、「TypeScriptファースト」という考え方を核としたデータベースマイグレーションツールである。これは、データベースのスキーマ（構造）をTypeScriptのコードとして定義し、そのTypeScriptで定義された「理想の状態」と、実際にデータベースに存在する「現在の状態」を比較することで、データベースを理想の状態に近づけるために必要な変更（マイグレーション）を自動的に生成し、適用するというものである。開発者は手動でSQL文を記述する代わりに、TypeScriptで理想のスキーマを記述するだけでよいため、手作業によるミスを減らし、開発効率を大幅に向上させることができる。

Kyrageの基本的な動作原理は、いくつかの段階を経て行われる。まず、開発者はアプリケーションのデータベーススキーマを、TypeScriptの直感的な構文を使って記述する。次に、Kyrageは指定されたデータベースに接続し、現在のデータベースのスキーマ構造を詳細に調査する（これを「イントロスペクション」と呼ぶ）。この調査結果（現在のデータベースの状態）と、開発者がTypeScriptで定義した理想のスキーマ定義を比較し、両者の間にどのような差分があるかを検出する。この差分に基づいて、Kyrageはデータベースを理想の状態に移行させるためのマイグレーションファイル（JSON形式）を自動的に生成する。最後に、開発者が専用のコマンドを実行するだけで、生成されたマイグレーションファイルがデータベースに適用され、スキーマが更新される。この一連の処理は、内部でKyselyという別の強力なデータベースツールの一部を活用しており、特にCockroachDBのような特定のデータベース方言（データベースごとのSQLの書き方の違い）にも対応できるよう設計されている。

Kyrageの主要な機能の一つは、その「スキーマ定義」方法にある。TypeScriptの強力な型システムを活かし、データベースのテーブルやカラム、そのデータ型、主キー、ユニーク制約、外部キーといった制約をコードで明確に定義できる。これにより、IDE（統合開発環境）のコード補完機能が利用できるようになり、開発者はデータベースの構造を間違えずに迅速に記述できるほか、定義段階で型に関するエラーを検出できるため、高い型安全性を確保できる。例えば、あるカラムが数値型であるべきなのに文字列として扱おうとすると、TypeScriptがエラーを教えてくれるのである。さらに、複合主キーや複合ユニーク制約、特定のカラムにインデックスを設定するといった、より複雑なデータベース構造もTypeScriptのコードで表現できる。

もう一つの画期的な機能が「開発データベースのサポート」である。チームでの開発では、各開発者が個別のクリーンなデータベース環境を持つことが理想的だが、これを手動で準備・管理するのは手間がかかる。KyrageはDockerコンテナの技術を活用し、一時的でクリーンな開発用データベース（PostgreSQLなど）を自動で起動・停止できる。これにより、各開発者は他の開発者の変更に影響されることなく、自分専用のデータベース環境で安心してスキーマ変更やテストを行うことができる。これは、データベースの接続情報やスキーマが、開発者の環境ではなくDockerコンテナ内で完結するため、環境依存の問題を解消し、同時に本番データへの誤操作のリスクも低減する。この機能はTestcontainersという技術を内部で利用しており、GitHub ActionsなどのCI/CD（継続的インテグレーション／継続的デリバリー）環境でもシームレスに動作するため、自動テストにおいても非常に有用である。また、開発中に起動したデータベースコンテナをセッション間で永続化させることで、アプリケーションが継続的に同じ開発用データベースに接続して作業を進めることも可能である。

さらに、Kyrageは開発中に生成された複数のマイグレーションファイルを、一つのクリーンなマイグレーションファイルにまとめる「マイグレーションのスカッシュ」機能を備えている。開発中は、細かなスキーマ変更を頻繁に行い、それに伴って複数のマイグレーションファイルが生成されがちである。しかし、これらすべてをそのまま本番環境に適用すると、マイグレーション履歴が複雑になり管理が難しくなる。スカッシュ機能を使うことで、例えば一つの新機能開発のために行った複数のデータベース変更を、最終的に「ユーザー管理機能追加」といった一つのまとまった変更として本番環境に適用できるため、履歴を整理し、管理を簡素化できる。また、環境ごとに異なる設定（例えば、開発環境と本番環境で異なるデータベース接続情報）を扱うための機能も充実しており、柔軟なプロジェクト運用を可能にする。

Kyrageは、既存の堅牢なツール（Kysely）の上に構築されつつ、現代のTypeScript開発者が直面する課題を解決するために独自の価値を提供している。特に、既存のツールがサポートに苦労しているCockroachDBに対して、Kyselyの優れた方言拡張性のおかげで完全に動作するという点が大きな強みである。Kyrageはスキーマ管理に特化しており、データベースへのクエリ（データの取得や更新など）を直接ビルドする機能は持たない。この設計は、Kyselyのような型安全なクエリビルダーと組み合わせることで、最大限の効果を発揮する。Kyrageでスキーマを管理し、kysely-codegenのようなツールでそのスキーマから型情報を生成することで、アプリケーションのあらゆる部分で型安全性を保ちながら、効率的なデータベース操作が可能になる。

将来的には、既存のデータベースからTypeScriptのスキーマ定義を自動生成する「Export API」や、PostgreSQL以外の多様なデータベース（DuckDB、SQLite、MySQLなど）への対応、マイグレーションの実行前後にカスタムロジック（データのバックアップや通知など）を組み込む「Hooks API」、開発用データベースにテストデータを自動的に投入する機能など、さらなる機能拡張が計画されている。これにより、Kyrageは単なるマイグレーションツールに留まらず、データベース開発の全体的なワークフローを強力にサポートするソリューションへと進化していく予定である。

Kyrageはオープンソースプロジェクトであり、手動マイグレーションの手間から解放されたい、CockroachDBの互換性に悩んでいる、またはより洗練されたTypeScriptファーストのデータベースワークフローを求めている開発者にとって、試してみる価値のあるツールである。このプロジェクトは、コミュニティからの貢献やフィードバック、実際の利用事例を歓迎しており、共に成長していくことを目指している。