More than 1 year has passed since last update.

LookerAdvent Calendar 2022

@hanon52_(ucchi-)

分厚いjoinを複数のexploreに継承して保守性を高める

Looker

Last updated at 2022-12-18Posted at 2022-12-18

TL;DR

以下の手順を踏むと、元のexploreの全てのjoinを継承し、ベーステーブルのみを差し替えられる

いずれかを選択する
a. 継承元のexploreにおいて、ベーステーブルをview_nameで指定する
b. 継承元のexploreにおいて、ベーステーブルをfromで指定し、独自のview_name名を定義する
継承先のexploreにおいて、extendsで継承元のexploreを指定し、fromでベーステーブルのみを差し替える

はじめに

Lookerでは、「ベーステーブル」（Exploreのベースとなる、最初に指定するテーブル）に様々なテーブルをjoinしてExploreを作ります。
似たようなベーステーブルが複数存在することはよくあります。例えば、分析のユースケースに従って似たようなサマリーテーブルを複数作成する場合などです。

大量のテーブルによる分厚いjoinがある場合、それぞれのベーステーブルに同じjoinを書いてExploreを作るのは冗長なので、extendsを使ってコードを継承させることを検討します。

課題

viewでデータソースを差し替える場合、以下のように適用できます。

view: summary_table_alike {
  extends: [summary_table] # ← 継承元のview定義を引っ張ってきて
  sql_table_name: `summary_table_alike` # ← viewのデータソースを差し替えるだけ
}

しかし、exploreでベーステーブルを差し替えても、join > sql_onのコードは差し変わりません。
joinの際に参照されるベーステーブル名をそのままにしないと、sql_onのkeyが見つからないというエラーが出てしまいます。

# 継承元のexplore
explore: summary_table {
  join: dimension_table {
      relationship: many_to_one
      # ベーステーブルは${summary_table}で参照される
      sql_on: ${summary_table.dimension_key} = ${dimension_table.key} ;;
  }
}

# NGパターン1
# ベーステーブルは${summary_table_alike}で参照されるので、sql_onの${summary_table.dimension_key}が見つからない
explore: summary_table_alike {
  extends:[summary_table]
}

# NGパターン2
# ベーステーブルは${summary_table_alike2}で参照されるので、sql_onの${summary_table.dimension_key}が見つからない
explore: summary_table_alike2 {
  extends:[summary_table]
  from: summary_table_alike
}

# NGパターン3
# ベーステーブルは${summary_table_alike}で参照されるので、sql_onの${summary_table.dimension_key}が見つからない
explore: summary_table_alike3 {
  extends:[summary_table]
  view_label: summary_table_alike
}

仕様の整理

exploreにおける「explore名」「from」「view_name」の仕様を整理します。

explore名

fromやview_nameが未指定な場合、Lookerはexploreのベーステーブルにexplore自体の名前（explore名）と同名のviewを使います。
以下の例では、customerviewをベーステーブルに使い、joinの際には${customer.some_key}という形式で参照します。

explore: customer {}

from

fromが指定されている場合、ベーステーブルにfromで指定されたviewを使います。
joinの際にはベーステーブルをexplore名で参照します。
以下の例では、userviewをベーステーブルに使い、joinの際には${customer.some_key}という形式で参照します。

explore: customer {
  from: user
}

SQLにおけるFROM句の書き換えに相当します。AS句にはexplore名を使います。

view_name

view_nameが指定されている場合、ベーステーブルにview_nameで指定されたviewを使います。
joinの際にはview_nameで参照します。
以下の例では、userviewをベーステーブルに使い、joinの際には${user.some_key}という形式で参照します。

explore: customer {
  view_name: user
}

SQLにおけるFROM句とAS句の両方の書き換えに相当します。

from と view_name を両方使う

fromとview_nameが両方使われている場合、Lookerは以下の挙動をします。

fromで指定したviewをベーステーブルとして用いる
joinの際には、ベーステーブルをview_nameで参照する。view_nameに独自の名前を定義できる

以下の例では、userviewをベーステーブルとして使い、joinの際には${customer.some_key}という形式で参照し、explore自体をcustomer_analysisで参照します。

explore: customer_analysis {
  from: user
  view_name: customer
}

整理

まとめると、以下のようになります。

	何も指定しない	fromを指定	view_nameを指定	fromを指定、view_nameを定義
ベーステーブル名	explore名	from名	view_name名	from名
joinの参照名	explore名	explore名	view_name名	view_name名

exploreを継承するためには、ベーステーブル名を差し替えつつ、joinの参照名をそのままにする必要がありました。
joinの参照名をview_nameとし、継承によってfromのみを差し替えればこれを達成できます。

解決策１

具体的な手順は以下です。

継承元のexploreにおいて、fromを用いてソーステーブルを指定し、任意のview_nameを定義する
継承先のexploreにおいて、extendsで元のコードを継承し、fromを上書きしてベーステーブルを差し替える

explore: summary_table_explore { # わかりやすいようにexplore名を変えておく
  label: "サマリ"
  from: summary_table
  view_name: summary_table_view # explore内はview_nameで参照できるようになる
  # 以下分厚いjoinが並ぶ
  join: dimension_table{
   # view_nameで参照している ↓
  　　sql_on: ${summary_table_view.dimension_key} = ${dimension_table.key} ;;
  }
  ...
}

explore: summary_table_alike_explore {
  label: "サマリ（類似）"
  extends: [summary_table_explore] # 元のコードを継承
  from: summary_table_alike # ベーステーブルを差し替え
}

	継承元	継承先
explore名	summary_table_explore	summary_table_alike_explore
ベーステーブル名	summary_table	summary_table_alike
joinの参照名	summary_table_view	summary_table_view

joinの参照名が変わらないため、継承後のexploreも元のjoinコードを使えます

解決策２

fromを削っても動きます。

継承元のexploreにおいて、view_nameを用いてソーステーブルを指定する
継承先のexploreにおいて、extendsで元のコードを継承し、fromを上書きしてベーステーブルを差し替える

explore: summary_table_explore {
  label: "サマリ"
  view_name: summary_table
  join: dimension_table{
  　　sql_on: ${summary_table.dimension_key} = ${dimension_table.key} ;;
  }
  ...
}

explore: summary_table_alike_explore {
  label: "サマリ(類似)"
  extends: [summary_table_explore]
  from: summary_table_alike
}

	継承元	継承先
explore名	summary_table_explore	summary_table_alike_explore
ベーステーブル名	summary_table	summary_table_alike
joinの参照名	summary_table	summary_table

感想

新たなテーブルをjoinする際、継承元のexploreにjoinを追加するだけで全てに適用できるようになりました。
冗長なコードが減って保守が楽になりました。

参考

https://cloud.google.com/looker/docs/reference/param-explore-extends
https://cloud.google.com/looker/docs/reusing-code-with-extends?hl=ja

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up