-
Notifications
You must be signed in to change notification settings - Fork 3
JP‐1. Introduction
Note
本マニュアルは作成中のため、誤った記載が含まれている可能性があります。
ERD Designer(Entity Relationship Diagram Designer)は、データベースのエンティティ関係図(ER図)を設計するための Web ベースのツールです。このツールを使用することで、データベースのテーブル構造とテーブル間のリレーションシップを、グラフィカルなインターフェースを通じて直感的に設計することができます。
本ツールは、Eclipse 用の ER モデリングツールとして広く使用されていた ERMaster からインスピレーションを得て開発されており、現代的な Web 技術を活用してより使いやすく進化させたものです。アプリケーション開発プロジェクトの初期段階において、データベース設計を効率的かつ正確に行うことを主な目的としています。
グラフィカルな設計環境
ERD Designer では、マウス操作によってテーブルを配置し、ドラッグ&ドロップでリレーションシップを作成できます。これにより、複雑なデータベース構造でも視覚的に理解しやすい形で設計を進めることができます。
多様な出力形式への対応
設計した ER 図は、以下の形式で出力できます:
- PNG 画像ファイル: ER 図を画像として保存し、ドキュメントやプレゼンテーションに活用できます。
- DDL(Data Definition Language)ファイル: 選択したデータベース向けの CREATE TABLE 文を自動生成できます。テーブル定義、インデックス、外部キー制約、コメント、スキーマなど、必要な要素を選択して出力可能です。
- テーブル定義書: 設計内容を出力し、仕様書作成に活用できます。オンラインツールの場合は Excel ファイルに出力し、Google Drive Appの場合は Google Spreadsheet としてホームディレクトリに出力します。
-
ERD ファイル(
.erd): 設計データをファイルとして保存し、バックアップや他の環境への移行に利用できます。
DDL インポート機能 (Experimental)
既存のデータベースから生成された DDL を読み込んで、自動的に ER 図を作成することができます。PostgreSQL、MySQL、MS SQL Server の DDL に対応しており、リバースエンジニアリングやデータベースの可視化に活用できます。
Note
DDL インポート機能は実験的機能(Experimental)です。複雑な DDL 構文や一部の高度な機能には対応していない場合があります。
スキーマ管理機能
PostgreSQL や MS SQL Server で使用されるスキーマ(Schema)の管理に対応しています。テーブルごとにスキーマを割り当てることができ、DDL 出力時には適切なスキーマ名が含まれます。
カラムモデルの再利用機能
カラムの定義内容は自動的にカラムモデルとして登録され、複数のテーブル間で再利用することができます。これにより、設計の一貫性を保ちながら、作業効率を向上させることができます。
ローカル保存 (オンラインツールの場合のみ)
作成した ER 図のデータは、すべてブラウザのローカルストレージに保存されます。データがオンライン上のサーバーに送信されることはないため、機密性の高いプロジェクトでも安心してご利用いただけます。
Important
ブラウザのローカルストレージに保存するため、作成した ER 図のデータを異なるブラウザ間や異なるマシン間で共有されません。作成元から erd ファイルを出力して、別のブラウザにてインポートすることで、ブラウザ間やマシン間で引き渡すことは可能です。
Caution
ブラウザのローカルストレージに保存するため、ブラウザのキャッシュをクリアすると、作成した ER 図のデータは削除されます。キャッシュクリアの操作にはご注意ください。
Tip
下記で説明する Google Drive App モードを利用する場合は、事前に指定されたファイルのみ Google Drive 上のファイルを更新します。作成した ER 図のデータを Google Drive 以外の外部のサーバに送信することはありません。
利用可能なモード
ERD Designer は、用途や環境に応じて2つの利用モードを提供しています:
-
オンラインツール: kajitiluna.github.io/erd-designer にアクセスすることで、ブラウザ上ですぐに利用を開始できます。インストール作業は不要で、最も手軽に始められる方法です。
- データはブラウザの IndexedDB に保存されます
- テーブル定義書は Excel ファイルとして出力されます
-
Google Drive App: ERD Designer - Google Workspace Marketplace からインストールすることで、Google Drive 上で ERD Designer の作業内容を記録する
.erdファイルを保存・管理できます。- Google Drive 上でのファイル管理が可能です
- テーブル定義書は Google Spreadsheet として出力されます
- チームでの共有やバックアップが容易になります
Important
Google Drive App モードでは、複数のユーザーが同時に同じファイルを編集することはできません。
前提条件とターゲットユーザー
-
技術的前提条件:
- モダンな Web ブラウザ(Chrome, Firefox 等)
- JavaScript の有効化
- IndexedDB 対応(オンラインツールの場合)
- Google Drive へのアクセス権限(Google Drive App の場合)
- 知識的前提条件: データベース設計の基礎知識(テーブル、カラム、主キー、外部キー、正規化、リレーションシップ等)をお持ちのソフトウェアエンジニアを対象としています。
- 利用場面: 新規アプリケーション開発におけるデータベース設計フェーズでの利用を想定しています。