설명 (필드)

이 페이지에서는 필드의 일부인 description 매개변수를 설명합니다.

description은 Explore의 일부로도 사용할 수 있으며, 이에 대한 설명은 description (Explore용) 매개변수 문서 페이지를 참고하세요.

description는 대시보드 매개변수 문서 페이지에 설명된 대로 대시보드의 일부로도 사용할 수 있습니다.

사용

view: view_name {
  dimension: field_name {
    description: "description string"
  }
}
계층 구조
view
필드 유형
description
가능한 필드 유형
측정기준, 측정기준 그룹, 측정값, 필터, 매개변수

수락
문자열

정의

필드에 설명을 추가할 수 있습니다. BigQuery 연결의 경우 데이터베이스에서 LookML 프로젝트를 생성하면 Looker는 BigQuery 열 메타데이터의 설명(있는 경우)으로 필드 설명을 자동으로 채웁니다.

사용자는 여러 위치에서 필드 설명을 볼 수 있습니다.

예를 들어 다음과 같은 LookML로 정의된 측정기준의 경우

dimension: id {
  primary_key: yes
  description: "Unique ID for the order"
  type: string
  sql: ${TABLE}.id ;;

사용자가 필드 선택 도구에서 필드 이름 오른쪽에 있는 정보 아이콘을 선택하면 Looker에 설명이 표시됩니다.

또한 사용자가 Explore, 대시보드 또는 Look의 테이블이나 테이블 차트 시각화에서 열 이름 위로 마우스를 가져가도 Looker에 설명이 표시됩니다.

description 매개변수에서 Liquid 변수 사용

필드의 description 매개변수와 함께 Liquid 변수를 사용할 수 있습니다. 예를 들어 사용자 속성 또는 쿼리가 실행되는 Explore에 따라 필드에 다른 설명을 표시하려는 경우에 유용합니다.

예를 들어 쿼리가 실행되는 Explore에 따라 필드의 설명이 달라지도록 하려면 Liquid {% if %} {% else %} {% endif %} 구조 내에서 Liquid 변수 _explore._name를 사용하면 됩니다.


dimension: user_id {
  description:
   "{% if _explore._name == 'order_items' %}
      The user ID for the Order Items Explore
    {% elsif _explore._name == 'inventory_items' %}
      The user ID for the Inventory Items Explore
    {% else %}
      The user ID
    {% endif %}"
}

이 예에서 주문 항목 Explore에서 쿼리를 실행하면 사용자 ID 측정기준의 설명은 주문 항목 Explore의 사용자 ID가 됩니다. 인벤토리 항목 Explore에서 설명은 인벤토리 항목 Explore의 사용자 ID입니다. 다른 Explore에서는 사용자 ID라는 설명이 표시됩니다.

또 다른 예로, 부서에 따라 사용자에게 다른 설명을 표시한다고 가정해 보겠습니다. Department라는 사용자 속성을 정의한 경우 Liquid {% if %} {% else %} {% endif %} 구조 내에서 Liquid 변수 _user_attributes['name_of_attribute']를 사용하여 Department 사용자 속성의 값에 따라 다른 설명을 지정할 수 있습니다.


dimension: gross_margin {
  description:
   "{% if _user_attributes['department'] == 'Marketing' %}
      The standard margin for a field
    {% elsif _user_attributes['department'] == 'Sales' %}
      The operating margin for a field
    {% else %} The gross margin for a field {% endif %}"
  type: number
  value_format_name: usd
  sql: ${sale_price} - ${inventory_items.cost} ;;
}

이 예에서 Gross Margin 측정기준에 표시되는 설명은 사용자가 마케팅팀, 영업팀 또는 기타 팀에 속해 있는지에 따라 다릅니다.

description 매개변수와 함께 _model._name, _view._name, _explore._name, _field._name, _user_attributes['name_of_attribute']과 같은 Liquid 변수를 사용할 수 있습니다. LookML과 함께 Liquid 매개변수를 사용하는 방법과 description 매개변수와 함께 사용할 수 있는 Liquid 변수를 확인하려면 Liquid 변수 참조 문서 페이지를 참고하세요.

알아 두어야 할 사항

설명은 측정기준 그룹당 한 번 표시됩니다.

측정기준 그룹의 경우 Looker는 그룹 내 각 기간 측정기준이 아닌 전체 그룹에 대해 설명을 한 번만 표시합니다.