조직 목록 매니페스트 참조¶
공급자는 조직 목록을 사용하여 조직 내에서 데이터 제품을 안전하게 공유할 수 있습니다. 프로그래밍 방식으로 조직 목록을 생성하려면 YAML (https://yaml.org/spec/)로 작성된 매니페스트가 필요합니다. 여기에 제공된 정보를 사용하여 적하 목록 형식과 개별 필드에 대해 알아보십시오.
조직 목록 필드는 더 큰 목록 매니페스트 참조 의 일부입니다. 조직 목록 필드를 추가하거나 수정하려면 DESCRIBE LISTING 및 ALTER LISTING 명령을 사용하여 목록 매니페스트의 위치를 프로그래밍 방식으로 찾아 수정했습니다.
조직 목록 매니페스트¶
참고
조직 목록 필드는 다음 중 하나가 될 수 있습니다.
선택 사항 - 조직 목록의 경우 선택 사항입니다.
필수 - 조직 목록에 필수입니다.
조직 목록 매니페스트의 일반적인 형식은 다음과 같습니다.
#
# Organization listing manifest
#
title: <Required listing title>
description: <listing description>
resources: <optional listing resources>
listing_terms: <optional listing terms>
data_dictionary: <optional data dictionary>
usage_examples: <optional usage examples>
data_attributes: <optional data attributes>
organization_profile: <Optional custom organization profile. Default "INTERNAL">
organization_targets:
- # Required
support_contact: "<support email address>"
- # Required
approver_contact: "<approver email address"
- # Required when the organization_targets includes the organization_targets.discover field
locations:
- # Optional list of regions to share into.
auto_fulfillment:
- # Required when the target accounts are outside the provider's region, otherwise optional.
조직 목록 필드¶
조직 목록 매니페스트에는 접두사와 필수 및 선택 사항 필드 세트가 포함됩니다.
조직 목록 접두사¶
각 조직 목록 매니페스트는 다음 필드로 시작됩니다.
title
(문자열, 필수, 최대 길이 110): 목록 제목입니다.description
(String, 선택 사항, 최대 길이 7500): 목록 설명입니다. 마크다운 구문이 지원됩니다.resources
(String, 선택 사항): 목록에 대한 리소스입니다.listing_terms
(하위 필드가 있는 상위 항목, 선택 사항): 목록에 대한 약관입니다.organization_profile
(String, 선택 사항): 선택 사항인 사용자 지정 조직 프로필입니다. 지정하지 않으면 기본값은 “INTERNAL”입니다.
resources
¶
목록에 대한 리소스입니다.
선택 사항 resources
필드에는 다음과 같은 이름 값 쌍이 포함됩니다.
resources.documentation
(문자열, 필수): 목록에 대한 자세한 설명서가 있는 웹사이트 페이지로 연결되는 정규화된 링크입니다.http
또는https
로 시작해야 합니다.resources.media
(문자열, 선택 사항): 목록에 대한 비공개 또는 공개 YouTube 비디오에 대한 정규화된 링크입니다.
이 필드에 포함할 수 있는 정보 유형에 대한 자세한 내용은 목록 세부 정보 섹션을 참조하십시오.
resources
예제¶
. . .
resources:
documentation: https://www.example.com/documentation/
media: https://www.youtube.com/watch?v=MEFlT3dc3uc
. . .
listing_terms
¶
목록의 서비스 약관을 정의합니다.
선택 사항 listing_terms
필드에는 다음과 같은 이름 값 쌍이 포함됩니다.
listing_terms.type
CUSTOM
-CUSTOM
만 지원되며listing_terms.link
값을 지정해야 합니다.
listing_terms.link
: 공급자의 목록 약관에 대한 정규화된 링크로,http
또는https
로 시작해야 합니다.
자세한 내용은 기본 정보 의 테이블에서 서비스 약관 을 참조하십시오.
참고
컨슈머는 목록 약관을 프로그래밍 방식으로 수락할 수 있습니다. 자세한 내용은 Snowflake 지원팀 에 문의하십시오.
listing_terms
예제¶
. . .
listing_terms:
type: "CUSTOM"
link: "http://example.com/my/listing/terms"
. . .
data_dictionary
¶
선택 사항 data_dictionary
필드는 목록 내의 오브젝트에 대한 데이터 미리 보기 및 열 유형에 대한 정보를 제공합니다.
data_dictionary
필드에는 최대 5개의 데이터 사전 항목 목록이 있습니다.
data_dictionary.featured
(data_dictionary
사용 시 필수): ‘featured’이어야 함.data_dictionary.featured.database
(data_dictionary
사용 시 필수): 데이터베이스 이름입니다.data_dictionary.featured.objects
(data_dictionary
사용 시 필수): 다음 이름 값 쌍의 목록입니다.name
(문자열, 필수): 오브젝트 이름입니다.schema
(문자열, 필수): 데이터 사전과 연관된 스키마입니다.domain
(필수):다음 중 하나:
DATABASE
SCHEMA
TABLE
VIEW
EXTERNAL_TABLE
MATERIALIZED_VIEW
DIRECTORY_TABLE
FUNCTION
COLUMN
자세한 내용은 데이터 제품 - 데이터 사전 을 참조하십시오.
data_dictionary
예제¶
. . .
data_dictionary:
featured:
database: "WEATHERDATA"
objects:
- name: "GLOBAL_WEATHER"
schema: "PUBLIC"
domain: "TABLE"
- name: "GLOBAL_WEATHER_REPORT"
schema: "PUBLIC"
domain: "TABLE"
. . .
usage_examples
¶
선택 사항 usage_examples
필드에는 다음 이름 값 쌍의 목록이 포함됩니다.
usage.title
(문자열, 필수): 사용 예제 제목입니다. 최대 길이는 110자입니다.usage.description
(String, 선택 사항): 사용 예제에 대한 설명입니다. 최대 길이는 300자입니다.usage.query
(문자열, 필수): 사용 예제와 연관된 쿼리입니다. 최대 길이는 30000자입니다.
자세한 내용은 샘플 SQL 쿼리 섹션을 참조하십시오.
usage_examples
예제¶
. . .
usage_examples:
- title: "Return all weather for the US"
description: "Example of how to select weather information for the United States"
query: "select * from weather where country_code='USA'";
. . .
data_attributes
¶
데이터 특성은 컨슈머에게 목록 정보를 제공합니다.
선택 사항 data_attributes
필드에는 다음과 같은 이름 값 쌍이 포함됩니다.
data_attributes.refresh_rate
(필수)다음 중 하나: Snowflake에서 데이터 제품을 업데이트하는 빈도를 지정합니다.
CONTINUOUSLY
HOURLY
DAILY
WEEKLY
MONTHLY
QUARTERLY
ANNUALLY
STATIC
data_attributes.geography
(필수):데이터 제품에 대한 지리적 정보를 지정합니다.
granularity
(문자열, 필수)데이터 세트의 지리적 범위.
다음 중 하나:
LATITUDE_LONGITUDE
ADDRESS
POSTAL_CODE
CITY
COUNTY
STATE
COUNTRY
REGION_CONTINENT
geo_option
(문자열, 필수)다음 중 하나:
NOT_APPLICABLE
GLOBAL
COUNTRIES
coverage
(geo_option
선택에 따라 필수):states
(문자열 목록), 유효한 미국 주 이름 목록 포함.
Or
continents
(문자열 목록):다음 중 하나에 해당합니다.
ASIA
EUROPE
AFRICA
NORTH AMERICA
SOUTH AMERICA
OCEANIA
ANTARCTICA
time
(필수):데이터 제품의 기간을 지정합니다.
granularity
(필수)
다음 중 하나:
EVENT_BASED
HOURLY
DAILY
WEEKLY
MONTHLY
YEARLY
time_range
(필수), 다음 이름/값 페어 포함:time_frame
(필수)다음 중 하나:
NEXT
LAST
BETWEEN
unit
(필수)다음 중 하나:
DAYS
WEEKS
MONTHS
YEARS
value
(time_frame
이 NEXT/LAST 인 경우 필수, 정수). 범위는 1~100입니다.start_time
(time_frame
이 BETWEEN 인 경우 필수, 문자열 날짜). 데이터 제품의 시작 시간입니다. 형식은 MM-DD-YYYY 입니다.end_time
(time_frame
이 BETWEEN인 경우 필수, 문자열 날짜), MM-DD-YYYY 형식.
데이터 제품 특성에 대한 자세한 내용은 데이터 제품 - 특성 섹션을 참조하십시오.
data_attributes
예제¶
. . .
data_attributes:
refresh_rate: DAILY
geography:
granularity:
- REGION_CONTINENT
geo_option: COUNTRIES
coverage:
continents:
ASIA:
- INDIA
- CHINA
NORTH AMERICA:
- UNITED STATES
- CANADA
EUROPE:
- UNITED KINGDOM
time:
granularity: MONTHLY
time_range:
time_frame: LAST
unit: MONTHS
value: 6
organization_targets
¶
필수 organization_targets
필드는 목록을 검색하고 액세스할 수 있는 사용자를 정의합니다.
discovery
및 access
필드를 포함하며, 이 중 하나를 지정해야 합니다.
discovery
access
지정 시 필수, 그렇지 않은 경우 선택 사항. 목록을 검색할 수 있는 사용자를 정의합니다. 존재하지 않으면 어떤 계정도 목록을 검색할 수 없습니다.access
discovery
지정 시 필수, 그렇지 않은 경우 선택 사항. 목록에 액세스할 수 있는 사용자를 정의합니다.
discovery
및 access
모두, 동일한 하위 필드를 포함합니다.
다음 중 하나를 수행합니다.
all_accounts : {true | false}
true
인 경우, 모든 계정이 목록을 찾거나 액세스할 수 있습니다.false
인 경우, 어떤 계정도 목록을 찾거나 액세스할 수 없습니다.- 또는 계정 배열을 입력한 후 지정된 계정 내에
roles
배열(선택 사항)을 입력합니다. - account: "<계정_이름>"
roles
이 있으면 계정 내에서 목록에 액세스하거나 목록을 검색할 수 있는 역할 목록을 지정합니다. 예:
…
roles: [ 'role1','role2']
…
organization_target
예¶
다음 예제는 discovery
및 access
필드의 다양한 조합을 보여줍니다.
조직의 모든 계정이 목록을 검색하고 액세스할 수 있습니다¶
. . .
organization_targets:
discovery:
- all_accounts : true
access:
- all_accounts : true
. . .
검색 가능하지만 제한된 계정으로만 액세스 가능¶
조직 내의 모든 계정이 목록을 검색할 수 있지만 finance
계정만 목록에 액세스할 수 있습니다.
. . .
organization_targets:
discovery:
- all_accounts : true
access:
- account: 'finance'
. . .
검색 가능하지만 일부 계정만 액세스 가능¶
조직 내의 모든 계정이 목록을 검색할 수 있지만 finance
또는 credit
계정의 계정만 목록에 액세스할 수 있습니다.
. . .
organization_targets:
discovery:
- all_accounts : true
access:
- account: 'finance'
- account: 'credit'
. . .
검색 가능하지만 제한된 계정과 특정 역할로만 액세스 가능¶
조직 내의 모든 계정이 목록을 검색할 수 있지만, accounting
또는 debit
역할이 있는 finance
계정의 계정만 목록에 액세스할 수 있습니다.
. . .
organization_targets:
discovery:
- all_accounts : true
access:
- account: 'finance'
roles: [ 'accounting','debit']
. . .
support_contact
¶
목록과 관련된 지원 정보에 대한 이메일 주소입니다.
: discovery
필드가 지정된 경우 필수 입니다.
. . .
support_contact: "support@exampledomain.com"
. . .
approver_contact
¶
목록 승인자의 이메일 주소입니다.
: discovery
필드가 지정된 경우 필수 입니다.
. . . approver_contact: "approver@exampledomain.com" . . .
locations
¶
목록을 검색하거나 액세스할 수 있는 선택 사항 locations
을 지정합니다.
access_regions
필드는 :code: locations
지정 시 필수 이며 다음 하위 필드 중 하나를 포함해야 합니다.
ALL
- 모든 리전에서 목록을 검색하거나 액세스할 수 있습니다.목록을 검색하거나 액세스할 수 있는
PUBLIC
접두사가 붙은 리전 이름의 배열입니다. 예:access_regions: - name: PUBLIC.AWS_US_WEST_2
.. . . locations: access_regions: - name: "<names | ALL>" . . .
전체 리전 목록은 SHOW REGIONS 섹션을 참조하십시오.