モデル パラメータ

モデルファイルは、データベース接続を指定し、その接続を使用する一連の Explore を定義し、Explore と他のビューの関係を定義します。他の LookML 要素とは異なり、モデルは特定の「モデル」パラメーターによって宣言されるものではありません。代わりに、LookML デベロッパーは、ファイル拡張子 .model.lkml の LookML プロジェクト ファイルを作成してモデルを定義します。モデル名はファイル名から取得されます。

モデル名は、インスタンス上のすべてのプロジェクトで一意である必要があります。インスタンスに同じ名前の .model.lkml ファイルが 2 つ含まれている場合、LookML ダッシュボードは URL 形式（<hostname>/dashboard/model_name::<dashboard_name>）でモデル名を使用するため、[LookML プロジェクト] ページでモデル構成エラーが発生したり、LookML ダッシュボード エラーのレンダリング エラーが発生したりする可能性があります。

LookML Validator を使用すると、インスタンス全体でモデル名が重複しているかどうかを確認できます。ただし、LookML Validator がインスタンスで重複するモデル名を検出した場合でも、コードを本番環境に push できます。そのため、LookML プロジェクトを本番環境にデプロイする前に、重複するモデル名のエラーを必ず修正してください。

モデルファイルには、通常、explore 宣言が、多数のモデルレベルの設定とともに含まれます。

このページには、モデルレベルの LookML パラメーターへのリンクが含まれます。これらは、通常、モデルファイルの先頭に記述されるものです。他のパラメーター内にネストしないでください。

使用例

パラメーター名の上にポインタを置くと、簡単な説明が表示されます。パラメーターをクリックすると、そのリファレンス ページに移動します。パラメーターをいくつかの特定のオプションのいずれかに設定できる場合は、デフォルト値が最初にリストされています。

## STRUCTURAL PARAMETERS
include:"filename_or_pattern"
## Possibly more include declarations

explore: explore_name {
  # Desired explore parameters (described on Explore Parameters page)
}
## Possibly more explore declarations

access_grant: access_grant_name{
  user_attribute: user_attribute_name
  allowed_values: ["value_1", "value_2", ...]
}
## Possibly more access_grant declarations

test: test_name{
  explore_source: explore_name {
    # Desired subparameters (described on test page)
  }
  assert: assert_statement {
    expression:Looker expression ;;
  }
  # Possibly more assert declarations
}
## Possibly more test declarations

## DISPLAY PARAMETERS
label: "desired label"

## FILTER PARAMETERS
case_sensitive: yes | no

## QUERY PARAMETERS
connection: "connection_name"
datagroup: datagroup_name{
  label: "desired label"
  description: "desired description"
  max_cache_age: "N (minutes | hours | days)"
  sql_trigger: SQL query ;;
}
## Possibly more datagroup declarations
fiscal_month_offset: N
persist_for: "N (seconds | minutes | hours)"
persist_with: datagroup_name
week_start_day: monday | tuesday | wednesday | thursday | friday | saturday | sunday

## VISUALIZATION AND FORMATTING PARAMETERS
map_layer: map_name{
  extents_json_url: "URL to JSON extents file"
  feature_key: "Name of TopoJSON object"
  file: "TopoJSON or GeoJSON filename" # or use the url subparameter
  format: topojson | vector_tile_region
  label: "desired label"
  max_zoom_level: number indicating max zoom
  min_zoom_level: number indicating min zoom
  projection: Preferred geographic projection
  property_key: "TopoJSON property"
  property_label_key: "Label for TopoJSON property"
  url: "URL that contains map file" # or use the file subparameter
}
## Possibly more map layer declarations

named_value_format: desired_name {
  value_format: "excel formatting string"
  strict_value_format: yes | no
 }
## Possibly more named value format declarations

パラメータの定義

パラメータ名	説明
構造的パラメーター
access_grant	承認されたユーザー属性値が割り当てられたユーザーのみに LookML 構造へのアクセスを限定するアクセス付与を作成します。このパラメーターには、user_attribute サブパラメーターと allowed_values サブパラメーターがあります。
explore	Explore メニューでビューを公開します。Explore とそのパラメーターの詳細については、Explore パラメーター リファレンス ページをご覧ください。
include	モデルにファイルを追加します。
test	モデルのロジックを検証するためのデータテストを作成します。プロジェクト設定には、データテストを必須にするオプションがあります。プロジェクトでこのオプションが有効になっていると、そのプロジェクトの開発者は変更内容を実動環境にデプロイする前にデータテストを実行する必要があります。このパラメーターには、explore_source サブパラメーターと assert サブパラメーターがあります。
表示パラメーター
label （モデルの場合）	Explore メニューでのモデルの表示方法を変更します。
フィルタパラメーター
case_sensitive （モデルの場合）	モデルでフィルターの大文字と小文字を区別するかどうかを指定します。
クエリ パラメータ
connection	モデルのデータベース接続を変更します。
datagroup	モデルのデータグループ キャッシング ポリシーを作成します。このパラメーターには、label、description、max_cache_age、sql_trigger サブパラメーターがあります。
fiscal_month_offset	会計年度が始まる月を指定します（暦年と異なる場合）。
persist_for （モデルの場合）	モデルのキャッシュ設定を変更します。
persist_with （モデルの場合）	モデルのキャッシング ポリシーに使用するデータグループを指定します。
week_start_day	週に関連したディメンションが開始する曜日を指定します。
ビジュアリゼーションおよび書式設定パラメーター
map_layer （モデルの場合）	map_layer_name で使用するカスタムマップを作成します。
named_value_format	value_format_name で使用するカスタムの値書式を作成します。このパラメーターには、value_format サブパラメーターと strict_value_format サブパラメーターがあります。
避けるべきパラメーター
scoping	3.52 で削除されました。 不要になりました。
template	3.30 で削除されました。 不要になりました。