Looker データ ディクショナリ拡張機能を使用する

Looker データ ディクショナリは、Looker 拡張フレームワークを使用して開発され、Looker Marketplace を通じてデプロイされた拡張機能(Looker コンポーネントを使用して構築されたウェブ アプリケーション)です。

Looker データ ディクショナリ拡張機能は、すべての Looker フィールドと説明を検索するための専用の一元化されたインターフェースを提供します。この拡張機能を使用して、次のタスクを実行します。

  • すべての指標と説明を検索可能なディレクトリに提供し、ユーザーが分析に適したディメンションやメジャーを特定できるようにする。
  • 外部の関係者がそれぞれの固有の指標を簡単に識別し場所を特定できるようにする。
  • LookML モデルを監査して、一貫した命名規則に従っているか、冗長なフィールドがあるか、フィールドに説明がアノテーションされているかを評価します。
  • 特定のフィールドに関するコメントを追加して共有する(Looker データ ディクショナリ アプリケーションのバージョンが 2.0.0 以降の場合)。Looker Marketplace に移動して [管理] を選択し、拡張機能の横にある [更新] ボタンを選択すると、データ ディクショナリが最新バージョンであることを確認できます。

データ ディクショナリのワークフロー

ユーザーが Looker データ ディクショナリにアクセスして使用できるようにするには、Looker 管理者が次の手順を行う必要があります。

  1. 適切な機能を有効にする。
  2. Looker データ ディクショナリ拡張機能をインストールする
  3. Looker データ ディクショナリにアクセスするための権限を付与する

拡張機能がユーザーに提供されると、次の操作を行うことができます。

  1. Looker データ ディクショナリ拡張機能に移動します
  2. モデルのメタデータを表示する

始める前に

Marketplace から Looker データ ディクショナリをインストールする前に、Looker 管理者は以下の機能を有効にする必要があります。

  • Marketplace: Looker Marketplace にアクセスするため(デフォルトで有効)
  • 拡張フレームワーク: Looker 拡張フレームワークを使用して開発された拡張機能をデプロイするため(デフォルトで有効)

Looker Marketplace からアプリケーションやツール(拡張機能など)をインストールするには、developmanage_modelsdeploy権限が必要です。

Looker データ ディクショナリのインストール

Looker Marketplace からツールをインストールする手順については、Looker Marketplace の使用に関するドキュメントをご覧ください。データ ディクショナリをインストールしたら、Looker 管理者は次のタスクを実行する権限をユーザーに付与する必要があります。

Looker データ ディクショナリ拡張機能にアクセスするための権限を付与する

Looker データ ディクショナリをインストールすると、data-dictionary というモデルが、[管理] パネルの [ロール] ページからアクセスできる [新しいモデルセット] ページと [モデルセットの編集] ページの使用可能なモデルのリストに自動的に追加されます。

Looker 管理者がユーザーに、data-dictionary モデルと、データ ディクショナリで探索する必要があるすべてのモデルにアクセスするための explore または develop 権限を付与する必要があります。ユーザーへの拡張機能へのアクセスと使用権限の付与については、Looker 拡張機能の権限の設定ドキュメント ページをご覧ください。

フィールド コメントを操作する権限を付与

フィールドのコメントを使用すると、LookML を更新することなく、フィールド定義にコンテキストを追加できます。デフォルトでは、データ ディクショナリの拡張機能にアクセスできるすべてのユーザーが、すべてのコメントを表示したり、自分のコメントの追加編集、削除を行ったりできます。できます。

Looker 管理者は、[管理] パネルの [グループ] ページで特定のユーザー グループを作成し、ユーザーをそのグループに割り当てることで、フィールド コメント機能の操作方法を管理できます。ユーザーをグループに割り当てる方法について詳しくは、グループのドキュメント ページをご覧ください。

ユーザー グループは、次の表の [グループ名] 列に示されている事前定義済みの名前で作成する必要があります。この表には、各グループに割り当てられたユーザーが有する事前定義された権限も示されています。

グループ名 権限
marketplace_data_dictionary_comments_disabled ユーザーがコメントを表示または操作することはできません。すべてのコメント機能は無効になっています。このグループの権限は常に他のグループの権限よりも優先されます。disabled グループに含まれるユーザーは、より高い権限を持つ別のグループに属している場合でも、コメントを表示したり、コメントを投稿したりすることはできません。
marketplace_data_dictionary_comments_reader ユーザーは既存のコメントは表示できますが、追加することはできません。
marketplace_data_dictionary_comments_writer ユーザーはすべてのコメントの表示、新しいコメントの追加、自分のコメントの編集と削除を行うことができます。これはデフォルトの権限です。
marketplace_data_dictionary_comments_manager ユーザーはすべてのコメントの表示、新しいコメントの追加、すべてのコメントの編集と削除を行うことができます。

ユーザーがこれらのグループのいずれにも属していない場合、デフォルトで writer になります。ユーザーが複数のグループ(marketplace_data_dictionary_comments_disabled を除く)に割り当てられている場合は、より高い権限が優先されます。

左側のサイドバーにあるインストール済みのアプリケーションと拡張機能のリストから、データ ディクショナリに移動できます。

Looker データ ディクショナリを使用したモデル メタデータの表示

Looker データ ディクショナリでは、モデルに対する explore 権限を持つユーザーが、このモデルを選択し、そのメタデータ(Explores や各 Explore のビューでグループ化された フィールドのリストなど)を表示できます。Looker データ ディクショナリでは、選択したモデルの Explore が左側のサイドバーに表示され、選択した Explore のビューとフィールドがページのメイン部分に表示されます。

ユーザーは < アイコンを選択して、サイドバーを折りたたむことができます。

Looker データ ディクショナリには、次の情報が表示されます。

  1. 選択したモデルの名前
  2. 選択したモデルに含まれる Explore のリスト
  3. 選択した Explore
  4. Explore のフィールドをフィルタリングするためのテキスト フィールド
  5. 選択した特性に基づいて表示されるフィールドを絞り込むクイック フィルタ
  6. ビュー名
  7. 各フィールドに関するメタデータ。[表示オプション] ボタンを選択して、表示するメタデータを選択します。フィールドのフィールド プロファイラでメタデータの完全なセットを確認してください。
  8. 特定のビューの各フィールドのメタデータを含む行
  9. Looker UI で Explore に移動する

モデルと Explore の選択

[モデルの選択] プルダウンには、ユーザーが explore 権限を持っているすべてのモデルが一覧表示されます。[モデルの選択] プルダウン メニューからモデルを選択すると、左側のサイドバーにそのモデルの Explore のリストが表示されます。

[モデルの検索] 検索ボックスに入力して、特定のモデルの特定のモデルを検索することもできます。検索キーワードに一致する結果のみが表示されるように、Explore のリストがフィルタされます。

Explore の名前を選択すると、フィールドがビュー別にグループ化されて、ページのメイン部分に表示されます。

また、右上隅の Explore ボタンをクリックすると、直接 Locker の Explore ページに進めます。

Explore のフィールドのフィルタリング

表示されているフィールドをフィルタリングするには、[Filter fields in this Explore] ボックスにテキストを入力して、フィールドの [フィールド ラベル] または [説明] のリストと照合します。

特定のメタデータ属性を選択してフィルタすることもできます。たとえば、フィールドが次のいずれであるかなどです。

フィールド メタデータの表示

Looker データ ディクショナリでは、Explore のフィールドのメタデータがビューごとにグループ化されて表示されます。

表示されるメタデータをカスタマイズする

各フィールドに表示するメタデータを指定するには、右上の [表示オプション] ボタンを選択し、表示するメタデータのチェックボックスをオンまたはオフにします。

フィールド コメントの使用

LookML デベロッパーは、フィールドレベルの description パラメータにモデルのフィールドに関する追加情報や説明を含めることがよくあります。ただし、これらの説明は、すべてのユーザーにとって必ずしも有意または有用であるとは限りません。フィールドレベルのコメントを使用すると、特定のフィールドにコンテキストを追加できます。これらのコメントは他のユーザーに表示されますが、モデルの基盤となる LookML には影響しません。

Looker 管理者は、[管理] パネルの [グループ] ページでコメントを特定のグループに追加して、そのコメントを操作するための機能をユーザーに付与する必要があります。デフォルトでは、データ ディクショナリの拡張機能にアクセスできるすべてのユーザーが、すべてのコメントを表示したり、自分のコメントの追加編集、削除を行ったりできます。できます。

フィールド コメントの追加

フィールドにコメントを追加するには:

  1. フィールド行にカーソルを合わせると、+ アイコン(既存のフィールド コメントがない場合)またはメモ帳アイコン(フィールドに既存のコメントがある場合)が表示されます。アイコンをクリックすると、フィールド プロファイラ パネルの [コメント] タブが開きます。
  2. [Add Comment](コメントを追加)ボタンをクリックします。
  3. コメントを入力して [コメント] ボタンを選択し、エントリを保存します。[キャンセル] をクリックして、フィールド プロファイラを閉じます。コメント ボックスの右下隅を選択してドラッグすると、コメント ボックスを拡大できます。

コメントが追加されると、フィールド プロファイラの [コメント] タブに表示され、他のユーザーから閲覧可能になります。

フィールド コメントの表示

フィールドにコメントが含まれている場合、メモ帳アイコンと、そのフィールドに存在するコメントの数が表示されます。メモ帳アイコンをクリックすると、フィールド プロファイラの [コメント] タブに表示されるフィールドのコメントが表示されます。

このフィールドのコメント件数も、[コメント] タブにかっこ付きで表示されます。各コメント エントリには、次の情報が表示されます。

  • コメント投稿者の名前
  • コメントが追加された日時を示すタイムスタンプ
  • コメントのプレビュー

フィールド コメントの編集または削除

自分のフィールド コメントを編集または削除するには、以下の手順を行います。

  1. フィールドのメモ帳アイコンを選択します。
  2. [コメント] タブで、編集または削除するコメントにカーソルを合わせます。
  3. その他メニューをクリックし、[コメントを編集] を選択してコメントを編集するか、[コメントを削除] を選択してコメントを削除します。コメントを削除する場合は、本当に削除するかを確認します。
  4. コメントを編集する場合、変更を加えたら [保存] を選択します。

フィールド コメントの共有

各フィールドの [コメント] タブの URL は一意であり、Looker データ ディクショナリでコピーして、そのモデルにアクセスできる他のユーザーと共有できます。

フィールド プロファイラを使用する

特定のフィールド行をクリックすると、フィールド プロファイラ パネルが開き、フィールドのメタデータ セット全体が表示されます。また、数値ディメンション値をプレビューするオプションと、[Looker IDE] ページまたは [Explore] ページにアクセスするボタンが表示されます。

Looker データ ディクショナリ拡張機能のバージョン 2.0.0 以降を使用している場合は、デフォルトでフィールド プロファイラの [詳細] タブが開きます。

分布セクションで、計算を選択すると、type: count を持つメジャーを含むビュー上の数値ディメンションのカウント値の分布を示す縦棒グラフのプレビューが表示されます。また、[Distribution] セクションには数値ディメンションの最小値、最大値、平均値も表示されます。

[] で [計算] を選択すると、type: count があるメジャーでビューに数値ディメンションの数のプレビューが表示されます。[もっと見る] ボタンを選択すると、フィールド ピッカーで事前に選択された数値ディメンションとカウント メジャーとともに Explore UI が開きます。

[LookML に移動] を選択して、Looker IDE で選択したモデルに関連付けられている LookML プロジェクトからビューファイルを開きます。

[Explore with Field] ボタンを選択すると、[Explore] ページが開き、フィールド ピッカーからそのフィールドが自動的に選択されます。