설명 (필드용)

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

description는 description (탐색용) 매개변수 문서 페이지에 설명된 탐색의 일부로 사용할 수도 있습니다.

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에서 설명을 표시합니다.

또한 사용자가 탐색, 대시보드 또는 Look의 표 또는 표 차트 시각화에서 열 이름 위로 마우스를 가져가면 Looker가 설명을 표시합니다.

description 매개변수에 Liquid 변수 사용

필드의 description 매개변수와 함께 유동 변수를 사용할 수 있습니다. 예를 들어 Looker에서 사용자 속성 또는 쿼리가 실행되는 탐색을 기반으로 필드에 다른 설명을 표시할 때 유용합니다.

예를 들어 쿼리가 실행되는 탐색에 따라 필드 설명을 다르게 하려면 Liquid {% dynamic if %} {% dynamic else %} {% dynamic endif %} 구조 내에서 Liquid 변수 _explore._name를 사용하면 됩니다.


dimension: user_id {
  description:
   "{% dynamic 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
    {% dynamic else %}
      The user ID
    {% dynamic endif %}"
}

이 예에서 주문 항목 탐색에서 쿼리가 실행되면 사용자 ID 측정기준에 대한 설명은 주문 항목 탐색의 사용자 ID가 됩니다. 인벤토리 항목 탐색에서 설명은 인벤토리 항목 탐색의 사용자 ID입니다. 다른 탐색 분석에서는 사용자 ID에 대한 설명이 표시됩니다.

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


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

이 예에서 총 마진 측정기준에 표시되는 설명은 사용자가 마케팅팀, 영업팀, 기타 팀의 일부인지에 따라 다릅니다.

_model._name, _view._name, _explore._name, _field._name, _user_attributes['name_of_attribute'] 등의 Liquid 변수를 description 매개변수와 함께 사용할 수 있습니다. LookML과 Liquid 매개변수를 사용하는 방법 및 description 매개변수와 함께 사용할 수 있는 Liquid 변수를 자세히 알아보려면 Liquid 변수 참조 문서를 참고하세요.

알아두어야 할 사항

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

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