Compass を使用して、単一のデータベース内のコレクション、フィールド、データ型、関係を視覚化するエンティティ関係図を作成します。
図のクイックスタート
Compass で最初のエンティティ関係図を作成するには、次の手順に従います。
詳細な手順と構成オプションについては、「 Compass でのエンティティ関係図の生成 」を参照してください。
ユースケース
次のシナリオについて、Compass でのデータ モデリング エクスペリエンスを考慮してください。
データ可視化: 現在のデータモデルのエンティティ関係図を生成します。データモデルを視覚化すると、関連するコレクション全体に対する潜在的なスキーマ変更の影響を特定できます。
データモデル プランニング:アプリケーションが大きくなるにつれて、データ構造の変更を追跡および計画します。新しいコレクションと関係を実装する前にモデル化し、設計上の決定を早期に検証します。
クロスチーム コラボレーション: データモデルの視覚的表現をデータエンジニア、製品マネージャー、その他の関係者と共有し、データベース構造の現在の状態を全てのユーザーが理解できるようにします。データモデルは、イメージ、 JSONファイル、または Compass で直接開くことができる
.mdmファイルとして共有できます。アプリケーション開発: 開発プロセス中にデータモデル内の不整合、関係の欠落、または最適化の機会を特定します。
チームノードのオンボーディング: 新しいプロジェクトにオンボードしたり、他のチームが作成したコレクションを操作したりするときに、既存のデータモデルをすばやく理解します。
Considerations
注釈
ドキュメント定義やデータ モデリングの決定に、図のコレクション、フィールド、および関係にコメントを追加できます。
関係
エンティティ関係図で、異なるコレクション内のフィールド間の関係を定義できます。エンティティ関係図を作成するときに、Compass が関係を自動的に推論するように選択できます。関係を手動で追加することもできます。
注意
関係は注釈のみを目的としています。Compass は関係情報をMongoDBデータベースに保存しません。
共有図
Compass のエンティティ関係図はエクスポートできます。図を共有することで、さまざまなチームと連携し、フィードバックを受け取り、スキーマ設計の最終的な決定で一致することができます。
図は次の形式でエクスポートできます。
.mdmDiagram File.PNG イメージ。
JSON ファイル。
また、.mdmファイルとしてエクスポートされたエンティティ関係図を Compass でインポートすることもできます。エンティティ関係図をインポートすると、照合者が共有する図を表示または編集できるようになります。
サイド パネル
図に関する次の一般的な情報は、Data Model Overview のサイド パネルで表示できます。
図の生成に使用したデータベース
図を最初に生成したとき
図を最後に更新したとき
コレクションをクリックすると、サイド パネルには、名前、関係、カスタム ノートなど、コレクションに関する情報が表示されます。
フィールドをクリックすると、サイド パネルには、名前、データ型、関係など、フィールドに関する情報が表示されます。
注意
コレクションまたはフィールドビューから Data Model Overview に戻るには、図内の空白をクリックしてコレクションまたはフィールドの選択を解除します。
サイド パネルを開くには、 アイコンをクリックします。