LookML Diagram は、Looker 拡張フレームワークを使用して開発され、Looker Marketplace を通じてデプロイされた拡張機能(Looker コンポーネントを使用して構築されたウェブ アプリケーション)です。
LookML Diagram は、LookML モデルのエンティティ関係図であり、LookML オブジェクトの LookML オブジェクト間の関係を視覚的に表現します。この拡張機能を使用すると、次のことを行えます。
- LookML モデルの構造を評価し、LookML を統合できる領域を特定し、モデルに追加する最善の方法を決定する
- 誤ったロジックを特定し、誤った計算やクエリのパフォーマンス低下を防ぐ
- コードベース(LookML)のデータ モデリングを行う方法を学習する
このドキュメントでは、LookML Diagram バージョン 2.0.0 以降の使用方法について説明します。Looker 管理者は、LookML Diagram の拡張機能の構成ドキュメント ページで、Looker ユーザーに対してこの拡張機能を有効にする方法を確認してください。
このページでは、次のことについて説明します。
- LookML Diagram に移動
- LookML Diagram で LookML オブジェクトの関係を確認する
- 図の設定を構成する
- データ探索の表示オプションを構成する
- 図のキャンバスを解釈する
- Object Profiler を使用したオブジェクト情報の監視
LookML Diagram に移動する
LookML Diagram をインストールしたら、左側のナビゲーション パネルで [Blocks] をクリックし、[LookML Diagram] タイルを選択して、LookML Diagram に移動できます。
LookML Diagram で LookML オブジェクトの関係を観察する
Looker 管理者から、lookml_diagram
モデルと、拡張機能に表示するモデルの権限が付与されている必要があります。
LookML Diagram の拡張機能は、次の要素で構成されています。
- モデル、Git ブランチ、Explore を選択する [Diagram Settings] パネル
- 表示するフィールドを絞り込む [View Options] パネル
- 図の要素に関する追加の説明を提供する [Diagram Help] セクション
- 選択した Explore で LookML オブジェクトを操作する図キャンバス
- 選択した Explore のフィールドのリスト(ビュー別にグループ化)
- ズームや位置のオプションがあるツールバーと、キャンバスのミニマップの表示と非表示を切り替えるためのアイコンが表示されます。これにより、より大きな図の中での自身の位置を確認するのに役立ちます。
- LookML オブジェクト に関する情報を表示し、該当する場合は LookML または Explore に移動するための Object Profiler
[図の設定] アイコンまたは [ビューの設定] アイコンをダブルクリックして、左側のパネルを閉じます。
図の設定を構成する
図のナビゲーション バーの図のアイコンをクリックして、[図の設定] を表示します。
[Choose a Model] プルダウン リストには、表示権限があるすべてのモデルが一覧表示されます。モデルを選択すると、次の 2 つのオプションが表示されます。
[現在のブランチ] プルダウンには、そのモデルの Git ブランチのリストが表示されます。モデルに 1 つのブランチ(通常は production ブランチ)しかない場合は、そのブランチが表示されます。本番環境モードの場合、または Git ブランチを変更する権限がない場合、[Current Branch] プルダウン メニューは無効になります。
LookML Diagram の Git ブランチを変更する権限が管理者から付与されている場合は、開発モードをオンにし、モデルと Explore の両方が選択されていることを確認して、モデルの設定方法に応じて図を表示するブランチを選択します。
[Explore の選択] リストには、そのモデルの Explore のリストが表示されます。Explore の名前をクリックすると、ページ キャンバスにフィールドがビューごとにグループ化されて表示されます。
視聴オプションを確認する
Explore を選択した状態で、[表示オプション] パネルを使用すると、キャンバスに表示するフィールドとビューを制限できます。
表示するフィールドの制限
[Fields to Display] で [All fields] を選択すると、Explore の各ビューのすべてのフィールドを表示できます。または、他のフィールドに結合されたフィールドを持つビューのみを表示するには、[Fields with joins] を選択します。
[Hide hidden fields] を有効にすると、基盤となる LookML に hidden: yes
を含むフィールドがすべて非表示になります。[Hide hidden fields] はデフォルトで有効になっています。
表示されるビューを制限する
[ビュー オプション] パネルの [ビュー] セクションには、選択した Explore に存在するビューのリストが表示されます。デフォルトでは、すべてのビューが図形キャンバスに表示されます。ビューを非表示にすると、そのビュー オブジェクトと、そのビュー オブジェクトを Explore 内の他のオブジェクトに接続する結合が図キャンバスから非表示になります。
[すべてを非表示] をクリックすると、Explore のビューがすべて図キャンバスから非表示になります。[Show all] をクリックすると、その Explore のすべてのビューが再表示されます。
ビュー名の右側にある目のアイコンの選択を解除すると、個々のビューをキャンバスから非表示にすることもできます。ビューが非表示になっている場合、ビュー名はグレー表示になり、目のアイコンには斜線が表示されます。非表示の個別のビューを再表示するには、スラッシュ付きの目のアイコンをクリックします。
図形キャンバスの解釈
LookML Diagram のキャンバスには、特定の Explore のすべてのエンティティと関係が表示されます。Looker の用語では、LookML Diagram は、LookML オブジェクトが特定のモデルの Explore でどのように結合されているかと考えることができます。
キャンバスの上部にあるオブジェクトのタイトルバーには、キャンバスに表示されているビューの Explore の名前が表示されます。オブジェクト タイトル バーにある Explore 情報アイコン(丸で囲まれた「i」)をクリックして Object Profiler を開き、選択した Explore の詳細を確認します。時計回りの矢印をクリックして、拡張機能を再読み込みします。
エンティティ
Explore の各ビューは、独自のエンティティセットとして表され、ビュー名がセットの上部に表示されます。
- Explore のベースビューは、濃い青色の背景で示されます。
- Explore の結合ビューには、水色の背景が表示されます。
結合、ビュー、フィールドを選択すると、明るい青色でハイライト表示されます。
各ビューの下に、そのビューに属するフィールドのリストが表示されます。
一番上にはディメンションが表示されます。
指標は下部に表示され、薄いオレンジ色でハイライト表示されます。
フィールドが主キーの場合は、フィールド名の右側に鍵アイコンが表示されます。
各フィールドの左側には、そのフィールドのタイプを示すアイコンが表示されます。
- A:
type: string
のディメンション - #:
type: number
のディメンションまたはメジャー - 段階的バー:
type: tier
のディメンション - チェックマーク:
type: yesno
のディメンション - カレンダー:
type: date
、type: date_time
、type: time
のディメンション - 地図上の地点:
type: location
、type: distance
、type: zipcode
のディメンション
フィールド名をクリックして Object Profiler を開き、選択したフィールドの詳細を確認します。
関係
この図では、選択したモデル内の個々のオブジェクトと他のオブジェクトとの関係が線で示されています。ビューまたはフィールドに添付する線の形状によって、2 つのオブジェクト間の関係のカーディナリティが示されます。フォークされた線は「多」カーディナリティを示し、1 本の線は「1 つ」のカーディナリティを示します。関係は、ベースビューからと、結合ビューへ読み取ります。例:
order_items
からinventory_items
への 1 対 1 の結合(id
フィールドで結合)order_items
からrepeat_purchase_facts
への多対 1 の結合
線上にカーソルを合わせると、2 つのオブジェクトを接続する結合タイプも確認できます。
線をクリックして Object Profiler を開き、結合の詳細を表示します。
キャンバスの表示オプション
キャンバスの右上にミニマップがあれば、より大きな図でプレースメントの位置を設定できます。キャンバス上で現在表示されている図の部分がグレー表示されます。キャンバスの空白部分をクリックしてドラッグすると、図の他の部分に移動できます。
キャンバスの左下に、図の表示を制御するアイコンが縦長のツールバーに表示されます。
- 図で(+)をクリックしてズームインし、(-)をクリックしてズームアウトします。
- 四角いアイコンをクリックすると、図のデフォルトの開始位置に戻ります。
- ミニアイコンをクリックして有効または無効にします。
Object Profiler を使用したオブジェクト情報の表示
オObject Profiler に、選択したオブジェクトの情報が表示されます。図キャンバスで Explore、ビュー、フィールド、結合のいずれかをクリックすると、キャンバスの右側に Object Profiler が開きます。キャンバスをクリックして Object Profiler を閉じます。
Explore
オブジェクト タイトルバーの右側の Explore アイコン(丸で囲まれた「i」)をクリックします。
[図の設定] パネルで選択した Explore の場合、Object Profiler に以下が表示されます。
- ラベル: Explore
label
の値。 - グループラベル:
group_label
パラメータの値。Looker の [Explore] メニューで Explore をカスタム グループに結合します。Explore でグループ ラベルが定義されていない場合、デフォルトはモデル名です。 - Project Name: プロジェクト設定で定義されている LookML プロジェクトの名前。
- 接続名:
connection
パラメータの値。モデルがデータを取得するデータベース接続を指定します。
LookML を表示する権限がある場合は、Object Profiler の左下にある [LookML に移動] をクリックして、Explore が定義されたファイルを開くことができます。新しいブラウザタブでファイルが開き、explore
の行がハイライト表示されます。
ビュー
図キャンバスでビューをクリックします。
ビューの LookML で定義されている場合は、Object Profiler で [SQL Table Name] が表示されます。ビューに sql_table_name
が定義されていない場合、SQL Table Nameは unknown
として表示されます。
LookML を表示する権限がある場合は、Object Profiler の左下にある [Go to LookML] をクリックして、ビューが結合されている Explore が定義されたファイルを開きます。新しいブラウザタブでファイルが開き、explore
の行がハイライト表示されます。
フィールド
図のキャンバスでフィールドをクリックします。
Object Profiler には、フィールド名、型、型の値、およびフィールドが主キーであるかどうかがパネル上部に表示されます。プロファイラの 2 つのタブ([詳細] と [コード])に、フィールドに関する追加情報が表示されます。
[Details] タブでは、次の情報を確認できます。
- View Name: フィールドが属するビューの名前。
- Label: Explore の [Data] セクションにフィールドを表示する方法(ビューの名前またはラベルに続けてフィ0ルドの名前またはラベル)。
- Distribution:
type: count
を含むメジャーがあるビューの数値ディメンションの場合、[Calculate] をクリックすると、カウント値の分布を示す棒グラフのプレビューが表示されます。また、[Distribution] セクションには数値ディメンションの最小値、最大値、平均値も表示されます。 - Values:
type: count
を含むメジャーがあるビューの数値ディメンションの場合、[Calculate] をクリックしてカウント値のプレビューを表示します。[Explore More] をクリックして、このフィールドが属する Explore を開きます。
[コード] タブで、フィールド パラメータとサブパラメータを表示できます。
LookML を表示する権限がある場合は、Object Profiler の左下にある [Go to LookML] をクリックして、結合が定義されたファイルを開くことができます。新しいブラウザタブ内の結合の Explore の行でファイルが開きます。
データを探索する権限がある場合は、Object Profiler の右下にある [Explore with Field] をクリックし、Explore フィールド ピッカーで、そのフィールドが事前に選択された Explore を開きます。
結合
図のキャンバスで結合をクリックします。
Object Profiler は、結合関係と、結合のタイプとカーディナリティを記述する join ステートメントを表示します。
LookML を表示する権限がある場合は、Object Profiler の左下にある [Go to LookML] をクリックして、結合が定義されたファイルを開くことができます。新しいブラウザタブ内の結合の Explore の行でファイルが開きます。