description (Explore)

이 페이지에서는 탐색에 포함된 description 매개변수를 참조합니다.

description은 description (필드의 경우) 매개변수 문서 페이지에 설명된 대로 필드의 일부로 사용할 수도 있습니다.

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

사용

explore: explore_name {
  description: "Description I Want"
}

계층 구조 모델 파일 explore description

기본값 없음 수락 문자열

정의

description를 사용하면 Explore에 대한 정보를 UI에 추가할 수 있으므로 사용자는 Explore 쿼리를 만드는 동안 추가 정보를 얻을 수 있습니다. 예를 들어 description 매개변수는 다음과 같습니다.

explore: order_items {
  description: "Based on the individual items that comprise customer orders"
}

description가 Explore에 추가되면 사용자는 필드 선택 도구 상단에 있는 Explore 이름 옆의 정보 아이콘 위로 마우스를 가져가 설명을 볼 수 있습니다.

사용자는 Explore의 드롭다운 목록에서 동일한 정보 아이콘 위로 마우스를 가져가 설명을 볼 수도 있습니다.

Explore에 description을 명시적으로 추가하지 않으면 설명이 표시되지 않습니다.

예시

User라는 Explore에 설명을 추가합니다.

explore: user {
  description: "All customer users, staff users are excluded"
}