はじめに
erd-editor は ER 図(Entity-Relationship Diagram)エディタです。
Web アプリ、VSCode 拡張機能、IntelliJ プラグイン、そして自分のページに埋め込める <erd-editor> カスタム要素として提供しています。
どれも同じエディタで、ドキュメント形式も共通です。
入手方法
| プラットフォーム | インストール | 提供内容 |
|---|---|---|
| Web アプリ | erd-editor.io | インストール可能な PWA、オフライン動作、リアルタイム共同編集 |
| VS Code | Marketplace | .erd.json ファイルを開く専用エディタ |
| IntelliJ | JetBrains Marketplace | IntelliJ ベースの IDE で使える同じエディタ |
| 自分のページ | npm install @dineug/erd-editor | フレームワークに依存しない <erd-editor> カスタム要素 — インストールを参照 |
IDE で試すには、拡張子が .erd.json の空ファイルを作成して開きます。
できること
- キャンバスにテーブル、カラム、メモを描き、
Zero One、Zero N、One Only、One Nの 4 種類のリレーションシップでつなぎます。編集を始めるを参照してください。インデックスはテーブルのプロパティパネルで定義します。インデックスを参照してください。 - 既存のスキーマを
json、Schema SQL、GraphQL、DBML、AMLから読み込めます。ファイルの読み込みと書き出しを参照してください。 - ダイアグラムを
json、Schema SQL、pngとして書き出します。 - Databricks、MSSQL、MariaDB、MySQL、Oracle、PostgreSQL、Snowflake、SQLite の 8 つのデータベースベンダーの構文で Schema SQL を記述します。テーブル関連機能を参照してください。
- C#、Go、Java、Kotlin、Scala、TypeScript、Drizzle、JPA、Sequelize、SQLAlchemy、TypeORM、AML、DBML、GraphQL の 14 種類のターゲット向けにコードを生成します。コード生成を参照してください。
- 可視化では、スキーマを力学モデルのグラフとして読み取れます。
- クイック検索を使うと、どこからでもテーブルを探したりコマンドを実行したりでき、Undo, Redo では編集履歴をたどれます。
- リアルタイムで一緒に編集できます(実験的機能)。セッションはピアツーピアかつエンドツーエンドで暗号化されるため、スキーマがサーバーに保持されることはなく、参加者は互いのマウスカーソル、フォーカス、選択範囲を確認できます。自分のページでは、
getSharedStore()が同じアクションストリームを任意のトランスポート上で提供します。
まずは編集ガイドから始めてください。
このプロジェクトを始めた理由
既存のモデリングツールは、私が求めていた水準のユーザー体験を提供してくれませんでした。
そこで、最高のユーザー体験を届けるためにこのプロジェクトを立ち上げました。
このプロジェクトの最優先事項は、ユーザーの編集体験です。
編集において、驚くような体験をお届けします。