Looker IDE(統合開発環境)を使用すると、LookML プロジェクト ファイルと LookML プロジェクトの設定にアクセスできます。
Looker IDE へのアクセス
LookML プロジェクトを表示するには、プロジェクト内の少なくとも 1 つのモデルに対する develop
権限が必要です。Looker IDE には、Looker のメイン ナビゲーション メニューの [Develop] パネルからアクセスできます。
- ナビゲーション パネルで [開発] を選択して、[開発] パネルを開きます。
- [開発] パネルで、アクセスするプロジェクトの名前を選択します。
選択した LookML プロジェクトの IDE が開きます。
また、Explore または オブジェクト ブラウザから特定の LookML オブジェクトに対して IDE を開くこともできます。詳細とその他のオプションについては、プロジェクト ファイルへのアクセスをご覧ください。
Looker IDE の要素
Looker IDE には次の要素があります。
- Development Mode バナー: このバナーは、Development Mode であることを示します。このモードでは、LookML ファイルを変更し、それらがインスタンスのコンテンツに与える影響をプレビューできます。バナーの [Development Mode を終了] をクリックすると、本番環境モードに移行できます。
- IDE ナビゲーション バー: ナビゲーション バーを使用して、Looker IDE のさまざまな機能にアクセスします。一部の機能は、Development Mode でのみ使用できます。IDE ナビゲーション バーから機能を選択したら、ナビゲーション バーのアイテムをもう一度選択して、機能パネルを閉じることができます。IDE ナビゲーション バーから、次の IDE 機能にアクセスできます。
- ファイル ブラウザ: ファイル ブラウザが開き、LookML プロジェクト内のファイルとフォルダにアクセスできます。
- オブジェクト ブラウザ: オブジェクト ブラウザを開きます。プロジェクト内の LookML オブジェクトと、オブジェクト間の階層関係が表示されます。
- 検索と置換: [プロジェクトで検索して置き換え] ページが表示されます。これを使用して、プロジェクト内のすべてのファイルでテキストを検索し、一括オペレーションですべてのインスタンスまたは選択したインスタンスを置き換えることができます。
- Git アクション: (Development Mode でのみ表示)プロジェクトの Git ブランチと、プロジェクトの Git ブランチで使用可能な Git コマンドが表示されます。LookML プロジェクトで Git を使用する方法については、バージョン管理機能の使用とデプロイのドキュメント ページをご覧ください。
- 設定: (Development Mode でのみ表示)プロジェクトのプロジェクト設定ページが表示されます。ここでは、プロジェクトのバージョン管理オプション、インポートされたプロジェクトの認証情報、プロジェクトで使用される Git ブランチ、IDE 設定を構成できます。
- デプロイ:(Development Mode でのみ表示)高度なデプロイモードで設定されているプロジェクトの場合、Deployment Manager が開きます。
deploy
権限を持つデベロッパーは、Looker 本番環境に commit またはタグをデプロイできます。
- 機能パネル: ファイル ブラウザとオブジェクト ブラウザの LookML ファイルとオブジェクトのナビゲーション、検索と置換機能の検索パラメータ、[Git アクション] パネルで使用可能な Git コマンド、プロジェクト設定パネルのさまざまな設定にアクセスするためのタブを提供します。
- IDE エディタパネル: LookML ファイルのエディタ。エディタは、IDE ナビゲーション バーで [ファイル ブラウザ] または [オブジェクト ブラウザ] を選択すると表示されます。エディタの詳細については、Looker IDE の編集機能をご覧ください。
- サイドパネル セレクタ: オプションをクリックして、IDE のサイドパネル機能を開きます。
- プロジェクトの健全性: [プロジェクトの健全性] パネルを開きます。
- クイックヘルプ: [クイックヘルプ] パネルを開きます。このパネルには、[メタデータ] パネルにアクセスするためのタブがあります。
- コーディング サポート:(Gemini が有効になっている Looker(Google Cloud コア)インスタンスの場合)、[コーディング サポート] パネルを開きます。サイドパネル セレクタ オプションをもう一度クリックして、IDE サイドパネルを非表示にします。
- IDE サイドパネル: 選択したサイドパネル機能を表示します。
- プロジェクトの健全性: ビルドされていない PDT を確認したり、LookML を検証したりできます。LookML デベロッパーがプロジェクトの LookML のロジックを検証するためのデータテストを定義している場合は、[プロジェクトの健全性] パネルからデータテストを実行することもできます。
- クイックヘルプ: LookML ファイル内のカーソルの位置に適用される LookML オプションが表示され、各 LookML パラメータの Looker リファレンス ドキュメントへのリンクが表示されます。
- メタデータ: カーソルの位置にある LookML オブジェクトに関するコンテキストに関連する情報を提供します。
- コーディング サポート:(Gemini が有効になっている Looker(Google Cloud コア)インスタンスの場合): Gemini in Looker を使用して LookML の作成を支援できます。
- Git ボタン: プロジェクトの状態に応じて、プロジェクトを本番環境に移行するために必要なアクション(LookML を検証、ブランチをリモートに push、commit など)が表示されます。ボタンをクリックしてアクションを実施します。ボタンで表示および実行できるコマンドについては、Git コマンドのリファレンスをご覧ください。
Looker IDE の設定
Looker IDE は次の方法でカスタマイズできます。
- テキスト エディタ モードを選択する
- 行の折り返しモードを有効または無効にする
- IDE サイドパネルのサイズを変更する
- ウィンドウ内のエディタの幅を最大化するために、IDE のサイドパネルを閉じる
テキスト エディタ モード
Looker IDE では次の 3 つのテキスト エディタ モードがサポートされています。
テキスト エディタ モードを変更する手順は次のとおりです。
- Looker IDE の左側のナビゲーション パネルで [設定] アイコンを選択します。
- [IDE 設定] から [エディタ] タブを選択します。
- [テキスト エディタ モード] プルダウン メニューを使用してオプションを選択します。
プルダウン メニューからオプションを選択すると、選択したテキスト エディタ モードを使用するように Looker IDE がすぐに更新されます。
行の折り返しモード
デフォルトでは、Looker IDE で行の折り返しが有効になっています。
行の折り返しを有効または無効にするには:
- Looker IDE の左側のナビゲーション パネルで [設定] アイコンを選択します。
- [IDE 設定] から [エディタ] タブを選択します。
- [行の折り返しモード] 切り替えボタンを使用して、IDE での行折り返しを有効または無効にします。
切り替えボタンを変更すると、更新が Looker IDE に適用されます。
IDE サイドパネルのサイズ変更
IDE のパネルの幅は、機能パネル([ファイル ブラウザ]、[オブジェクト ブラウザ]、[Git アクション] パネルを含む)とサイドパネル([プロジェクトの健全性]、[クイックヘルプ]、[メタデータ] パネルを含む)の両方で変更できます。
IDE パネルのサイズを変更するには、パネルの境界にカーソルを合わせ、ドラッグしてパネルのサイズを変更します。
Development Mode の場合、IDE はログインと更新をまたいでサイドパネルのサイズを保持します。
IDE サイドパネルを閉じる
IDE エディタパネルの幅を最大化するには、IDE サイドパネルを閉じます。
- IDE 機能パネルの表示と非表示を切り替えるには、キーボード ショートカットの Command-B(Mac)または Ctrl+B(Windows)を使用するか、IDE ナビゲーション バーですでに選択されているアイコンをクリックします。
- IDE サイドパネルを表示または非表示にするには、サイドパネル セレクタですでに選択されているアイコンをクリックします。
Looker IDE の編集機能
以降のセクションでは、LookML での開発に役立つ Looker IDE の編集機能について説明します。
自動候補
入力を開始すると、その内容に応じて使用可能なパラメータと値が IDE によって提案されます。たとえば、ディメンションの type
パラメータの候補には、そのパラメータで有効なオプションのみが含まれます。また、sql
パラメータのフィールドは ${...}
でマークする必要があるため、IDE はフィールドを提案する際にその構文を追加します。
自動提案は、表示できる場所に自動的に表示されます。自動提案の画面を閉じるには、キーボードの Esc キーを押します。任意のタイミングで表示するには、Ctrl+Space(Windows)または Control-Space(Mac)を押します。
アドホック エラーチェック
IDE は、入力中に構文エラーを検出します。行番号の横にある赤い X は、構文エラーを示し、エラー箇所は赤色の下線で示されます。赤い X にカーソルを合わせると、問題の簡単な説明が表示されます。たとえば、measure の type
パラメータの値に、誤って average
ではなく avrage
を入力した場合、IDE はエラー Invalid value for "type":avrage
を表示します。
完全なモデル検証を行うには、LookML バリデータが引き続き必要です。結合の欠落による無効なフィールド参照などの一部のエラーは、モデルの全体像の確認を必要とし、LookML バリデータが実行されているときにのみ表示されます。
自動フォーマット
Development Mode では、ファイルのフォーマット キーボード ショートカットを使用して、LookML ファイルを自動的にインデントできます。インデントはパラメータとサブパラメータの階層を示すため、LookML を読んで理解することが容易になります。
折り畳み式
ファイル内の最上位の LookML パラメータの先頭の横にあるガターに小さな矢印が表示されます。この矢印を選択すると、LookML の対象のセクションが折りたたみ / 展開され、特定のセクションのみにフォーカスできます。
LookML ファイルの [See file actions] メニューには、すべての LookML セクションを展開する、または現在のファイル内の最上位のパラメータに折りたたむための [Fold LookML] と [Unfold LookML] オプションもあります。
キーボード ショートカットを使用して LookML の折りたたみと展開を行うこともできます。
コメント
LookML には、コメントを追加して読みやすくできます。コメントを 1 つ追加するには、#
文字を使用します。
dimension: name {
sql: ${TABLE}.name ;; # This is the customer's full name
}
キーボード ショートカットを使用してコードのブロック全体をコメントアウトするには、次の操作を行います。
- コメントアウトする行を選択します。
- Command+ / キー(Mac)または Ctrl+ / キー(Windows)を押します。
IDE によって選択した各行に #
文字が追加されます。
SQL ブロックのコメントアウト
完全に SQL コードブロック内に収まっている行をコメントアウトする場合は、手動で SQL コメント表記を追加します。
SQL コメント ブロックを使用する場合は、コメントアウトされたセクションも LookML コードとして解釈されます。そのため、LookML によって生成された SQL 内にコメントが表示されますが、コメントはクエリ結果には影響しません。
追加、変更、削除の確認
LookML IDE では、開発モードで commit されていない変更がある場合、いくつかのインジケーターが常に表示されます。
- ファイル名がウィンドウの左側に青い点を付した状態で表示されます。これは、ファイルが新規作成、変更された、または名前を変更されたことを示しています。
- 新しいファイルまたは変更されたファイルを開くと、ファイル内の行番号が緑色でハイライト表示されて、新しい行または変更された行が表示されます。赤い水平線は削除された行を示します。
IDE の状態の永続性
Development Mode の場合、Looker IDE は更新とログイン間で IDE の状態を保持します。IDE の状態には次のものがあります。
- IDE ナビゲーション バーで選択されているアイテム(ファイル ブラウザ、Git アクション、オブジェクト ブラウザ、プロジェクト設定など)
- ファイル ブラウザに表示された LookML ファイルを開く
- ファイル ブラウザとオブジェクト ブラウザのアイテムの展開または閉じた状態
- IDE サイドパネルの幅
- IDE の右側のサイドバーで選択されているアイテム(クイックヘルプ パネル、メタデータ パネル、プロジェクトの健全性パネルなど)
- エディタの行の折り返しモード
IDE をデフォルト設定にリセットするには、Looker IDE の左側のナビゲーション パネルで [設定] アイコンを選択し、[IDE 設定] セクションで [エディタ] タブを選択して、[IDE レイアウトをリセット] ボタンをクリックします。ファイルを開いて選択を続けると、IDE は状態を再び保持します。
オブジェクトまたはファイルにジャンプ
Looker IDE では、オブジェクトまたはファイルにジャンプ機能を使用して、LookML オブジェクトやプロジェクト ファイルに直接移動してすばやく検索できます。ファイル ブラウザまたはオブジェクト ブラウザからオブジェクトまたはファイルにジャンプ アイコンをクリックするか、キーボード ショートカット Command-J(Mac)または Ctrl+J(Windows)を使用します。
詳細については、LookML プロジェクト ファイルへのアクセスに関するドキュメント ページをご覧ください。
クイックヘルプ パネル
[クイックヘルプ] アイコンを選択すると、[クイックヘルプ] パネルが開きます。パネルには、コード内の現在の場所の説明とオプションが表示されます。サイドバーのパラメータ名を選択して、対象パラメータの Looker ドキュメント ページを開きます。
コーディング サポート パネル
Gemini が有効になっている Looker(Google Cloud コア)インスタンスがある場合は、Gemini in Looker を使用して LookML の作成を支援できます。
詳細については、Gemini in Looker アシスタントを使用して LookML を記述するをご覧ください。
ファイルとフォルダのオプション メニュー
ファイル ブラウザの左側のパネルにある各ファイルまたはフォルダには、そのアイテムで利用可能なアクションを表示するメニューがあります。ファイルとフォルダの上にカーソルを合わせ、3 つの点の [フォルダ オプション] メニュー(フォルダの場合)または [ファイル オプション] メニュー(ファイルの場合)を選択してメニューを開きます。名前が長いアイテムや複数のフォルダにネストされているアイテムの場合は、ファイル ブラウザ パネルで横方向にスクロールしてメニューにアクセスできます。
オプション メニューから、フォルダやファイルを作成したり、ファイルをアップロードしたり、ファイル ブラウザを使用してファイルやフォルダを削除したり移動したりできます。詳細については、LookML ファイルとフォルダの管理ドキュメント ページをご覧ください。
フォルダを使用して LookML ファイルを整理する場合は、他の Looker デベロッパーに表示される前に、変更を commit して本番環境にデプロイする必要があります。これは、LookML プロジェクトに加える変更と同様です。
プロジェクト内のテキストの検索と置換
Looker IDE には検索と置換の機能があるため、すべてのプロジェクト ファイルを対象にテキストの検索と、一括オペレーションですべてのインスタンスまたは選択したインスタンスを置き換えることができます。
Looker IDE の検索機能を使用する手順は次のとおりです。
- IDE の検索パネルに移動します。
- [検索] フィールドにキーワードを入力します。
- 必要に応じて、[大文字と小文字を区別] を選択して、大文字と小文字の表記が [検索] フィールドに入力した内容と一致するインスタンスのみを検索できます。または、[正規表現] を選択して、正規表現検索を実行することもできます。
- [検索] をクリックします。
- 必要に応じて、ファイル名を選択してそのファイルを IDE で開くことができます。
開発モードの場合は、[置換] フィールドも表示されます。プロジェクト内のテキストを置き換える手順は次のとおりです。
[置換] フィールドに置換テキストを入力します。[検索] フィールドのテキストを置き換えるのではなく削除する場合は、[置換] フィールドを必要に応じて空白にします。
[選択して置換] を選択して、プロジェクト内のテキストがどのように置換されるかをプレビューします。
結果には、プロジェクト内の全インスタンスが置換に向けてハイライト表示されます。次のオプションを使用して、置換するインスタンスをカスタマイズできます。
- 結果の概要の横にあるチェックボックスを使用して、プロジェクト全体のすべてのインスタンスを選択または選択解除します。
- 単一インスタンスの横にあるチェックボックスを使用して、インスタンスを選択または選択解除します。
[選択したものを置換] ボタンを選択して、選択したインスタンスに置換を適用します。IDE により、変更された内容が表示されます。
新しいフィールドの作成とテスト
LookML の編集の例として、いくつかのフィールドを追加してテストします。
ディメンションを作成する
まず、ユーザーがカリフォルニア州またはニューヨーク州のいずれに居住しているかを判断する新しいディメンションを users
ビューに追加します。ディメンションは type: yesno
です。つまり、ユーザーがカリフォルニアまたはニューヨークにいる場合は [Yes] を返し、それ以外の場合は [No] を返します。
新しいディメンションの LookML は次のようになります。
dimension: from_ca_or_ny {
type: yesno
sql: ${TABLE}.state = "California" OR ${TABLE}.state = "New York" ;;
}
このディメンションを user
ビューファイルに追加して、ファイルの [変更を保存] ボタンをクリックします。
${TABLE}.state
の詳細については、置換演算子をご覧ください。
measure の作成
次に、ユーザーの平均年齢を表す新しい measure を user
ビューに追加します。このメジャーは、type: average
であり列 age
で集計されます。
この新しい measure の LookML は次のようになります。
measure: average_age {
type: average
sql: ${TABLE}.age ;;
}
この measure を user
ビューファイルに追加して、ファイルの [変更を保存] ボタンをクリックします。
Explore のフィールドのテスト
新しいディメンションと measure は、それらをクエリすることでテストできます。変更を保存すると、これらのフィールドが Explore のフィールド ピッカーに表示されます。ビューのファイル名の横にある [ファイル アクションを表示] プルダウン メニューを使用して、現在のビューの Explore にアクセスします。[ファイル アクションを表示] プルダウン メニューには、ビューに基づく Explore がすべて一覧表示されます(ビューが結合されている Explore も含みます)。たとえば、users
というビューの Explore にアクセスするには、[ファイル アクションを表示] プルダウン メニューから [ユーザーを探索] オプションを選択します。
[Users] の Explore で、新しいフィールドを選択してクエリに追加できます。たとえば、新しいフィールドで、カリフォルニアまたはニューヨークのユーザーの平均年齢と、それ以外のユーザーの平均年齢の両方を示すクエリを作成できます。