템플릿 사양

공동 작업에서 사용할 단일 템플릿을 정의합니다. 템플릿은 템플릿 사양과 REGISTER_TEMPLATE을 호출하여 등록됩니다.

스키마:

api_version: 2.0.0              # Required: Must be "2.0.0"
spec_type: template             # Required: Must be "template"
name: <template_name>           # Required: Unique name (max 75 chars)
version: <version_string>       # Required: Version identifier (max 20 chars)
type: <template_type>           # Required: sql_analysis or sql_activation
description: <template_description>  # Optional: High-level description (max 1,000 chars)
methodology: <methodology_description>  # Optional: Detailed description (max 1,000 chars)

parameters:                     # Optional: User-provided parameters
  - name: <parameter_name>      # One or more parameter items...
    description: <parameter_description>  # Optional: Description (max 500 chars)
    required: <true_or_false>   # Optional: Whether required (default: false)
    default: <default_value>    # Optional: Default value
    type: <data_type>           # Optional: String, integer, number, Boolean, array, or object

code_specs:             # Optional: List of code bundles used by this template
  - <code_spec_id>        # One or more code spec IDs.

template: |                     # Required: JinjaSQL template content
  <template_content>
api_version

사용되는 Collaboration API의 버전입니다. 2.0.0 여야 합니다.

spec_type

사양 유형 식별자입니다. template 여야 합니다.

name: template_name

이 템플릿의 고유한 사용자 친화적인 이름입니다. Snowflake 식별자 규칙 </sql-reference/identifiers-syntax>`(최대 75자)을 따라야 합니다. :samp:`{name}_{version} 쌍은 이 계정의 모든 템플릿에 대해 고유해야 합니다.

version: version_string

이 템플릿의 버전 식별자입니다(최대 20자). Snowflake 식별자 규칙 </sql-reference/identifiers-syntax>`을 따라야 합니다. VIEW_TEMPLATES 및 VIEW_REGISTERED_TEMPLATES에 대한 응답에서 버전 문자열에 별도의 열이 제공되므로 오름차순으로 정렬할 수 있는 값을 사용합니다. 예: ``V0`

type

템플릿 유형입니다. 다음 값 중 하나입니다.

  • sql_analysis: 데이터 분석 작업을 위한 템플릿입니다.

  • sql_activation: 데이터 활성화 작업을 위한 템플릿입니다.

:samp:`description: {template_description}`(선택 사항)

이 템플릿의 기능에 대한 간략한 설명입니다(최대 1,000자).

:samp:`methodology: {methodology_description}`(선택 사항)

이 템플릿의 작동 방식에 대한 자세한 설명입니다(최대 1,000자).

``parameters``(선택 사항)

이 템플릿의 모든 사용자 제공 매개 변수 목록입니다. 각 항목에는 다음 필드가 있을 수 있습니다.

  • name: 유효한 Snowflake 식별자 (최대 255자) 형식의 매개 변수 이름입니다.

  • ``description``(선택 사항): 사람이 읽을 수 있는 매개 변수 설명입니다(최대 500자).

  • ``required``(선택 사항): 매개 변수가 필수인지 여부입니다. 기본값은 false 입니다.

  • ``default``(선택 사항): 매개 변수의 기본값으로, 모든 데이터 타입이 될 수 있습니다.

  • ``type``(선택 사항): 매개 변수의 예상 데이터 타입입니다. string, integer, number, boolean, array, object 중 하나입니다.

``code_specs``(선택 사항)

이 템플릿에서 참조하는 함수를 정의하는 하나 이상의 코드 번들입니다. 템플릿이 사용자 지정 함수 를 호출할 때 필요합니다. 코드 사양 IDs는 버전 지정됩니다. 함수의 새 버전에 액세스하려면 버전 지정되지 않은 함수 이름을 호출하는 템플릿 자체가 아닌 여기에 코드 사양 ID를 업데이트해야 합니다. 코드 사양 이름에는 밑줄이 있어야 하며 정규식 패턴 [A-Za-z]\w{0,74}_\w{1,20} 과 일치해야 합니다.

template

템플릿 내용입니다. SQL 템플릿의 경우 여기에는 JinjaSQL 템플릿 </user-guide/cleanrooms/custom-templates>`이 포함됩니다. 자세한 내용은 :ref:`label-dcr_design_collaboration_template 섹션을 참조하십시오.

템플릿에 노출되는 열 이름은 데이터 오퍼링 사양 에 명시된 열의 category 및 column_type 값에 의해 결정됩니다. 자세한 내용은 소스 열 이름 바꾸기 섹션을 참조하십시오.

예

api_version: 2.0.0
spec_type: template
name: trivial_template
version: V1
type: sql_analysis
description: Simple one-row template.
methodology: Always returns "1". Requires one source table.

parameters:
  - name: row_count
    description: Count of rows
    required: true

template: |
    SELECT 1 FROM IDENTIFIER( {{ source_table[0] }} ) LIMIT {{ row_count }};