Snowflake Data Clean Rooms Collaboration API¶

语法¶

REGISTER_TEMPLATE( ['<registry_name>' ,] <template_spec> )

实参¶

registry_name （可选）

自定义注册表 的名称在其中注册此模板。如果未指定，则在默认账户注册表中注册模板。

template_spec

模板定义 采用 YAML 格式，以字符串形式呈现。

返回¶

在协作规范中使用的模板 ID。

示例¶

在默认注册表中注册模板：

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.REGISTER_TEMPLATE(
  $$
  api_version: 2.0.0
  spec_type: template
  name: my_test_template
  version: 2026_01_12_V1
  type: sql_analysis
  description: A test template
  template:
    SELECT * FROM IDENTIFIER({{ source_table[0] }}) LIMIT 10;
$$);

在自定义注册表中注册模板：

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.REGISTER_TEMPLATE(
  'my_custom_registry',
  $$
  api_version: 2.0.0
  spec_type: template
  name: my_test_template
  version: 2026_01_12_V1
  type: sql_analysis
  description: A test template
  template:
    SELECT * FROM IDENTIFIER({{ source_table[0] }}) LIMIT 10;
$$);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下过程获得权限的角色。

要在默认注册表中注册对象，请执行以下操作：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('REGISTER TEMPLATE', 'role name')

要在自定义注册表中注册项目，请执行以下操作：

• 您对自己创建的任何自定义注册表都具有读写权限。

• 要访问其他用户创建的自定义注册表，您需要 GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('REGISTER', 'REGISTRY', 'MY_REGISTRY', 'role name')。

语法¶

VIEW_REGISTERED_TEMPLATES( [ '<registry_name>' ] )

实参¶

registry_name （可选）

要列出模板的 自定义注册表 名称。如果未指定，则列出默认账户注册表中的模板。

返回¶

一个表，其中列出了您在此账户中注册的所有模板的详细信息。该表包括以下各列：

• TEMPLATE_ID：模板的 ID。

• NAME：选择使用 时默认使用的角色和仓库。模板名称。

• VERSION：选择使用 时默认使用的角色和仓库。模板版本。

• TEMPLATE_SPEC：选择使用 时默认使用的角色和仓库。模板的完整 YAML 规范。

• REGISTRY：选择使用 时默认使用的角色和仓库。在其中注册模板的注册表。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.VIEW_REGISTERED_TEMPLATES();

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

要查看默认注册表中的项目，请执行以下操作：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('VIEW REGISTERED TEMPLATES', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

要查看自定义注册表中的项目，请执行以下操作：

• 您对自己创建的任何自定义注册表都具有读写权限。

• 要访问其他用户创建的自定义注册表，您需要 GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'REGISTRY', 'MY_REGISTRY', 'role name')。

语法¶

ADD_TEMPLATE_REQUEST( <collaboration_name>, <template_id>, <share_with> )

实参¶

collaboration_name

要链接模板的协作的名称。

template_id

要链接到协作的模板的 ID。注册模板以获取此值。

share_with

要与之共享此模板的分析运行器的 别名 数组。除了与此模板关联的任何其他协作者之外，还将添加此处列出的协作者。此处列出的所有协作者都必须是分析运行者，否则在不与任何人共享此模板的情况下，过程将失败。

返回¶

字符串成功消息。

示例¶

-- Ask to link the template only for Collaborator3 in this collaboration.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.ADD_TEMPLATE_REQUEST(
  $collaboration_name,
  $template_alias,
  ['Collaborator3']
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• 以下任一权限：

  • GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')，加上必须手动授予角色的所有其他账户级权限。

  • GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')，加上必须手动授予角色的所有其他账户级权限。

• 如果模板位于自定义注册表中，您还必须拥有 GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE( 'READ', 'registry name', 'role name')

语法¶

REMOVE_TEMPLATE( <collaboration_name>, <template_id>, <remove_for> )

实参¶

collaboration_name

要从中移除模板的协作的名称。

template_id

要从协作中移除的模板的 ID。

remove_for

此协作中一个或多个分析执行器的 别名 数组，这些分析执行器应该无法再看到或使用此模板。

返回¶

字符串成功消息。要查看协作者的模板是否已移除，请查看协作规范。

示例¶

-- Prevent collaborator_1234 from using the specified template
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.REMOVE_TEMPLATE(
  $collaboration_name,
  $template_id,
  ['collaborator_1234']
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• 以下任一权限：

  • GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')，加上必须手动授予角色的所有其他账户级权限。

  • GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')，加上必须手动授予角色的所有其他账户级权限。

• 如果模板位于自定义注册表中，或者引用了自定义注册表中的代码样式，则还必须拥有 GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE( 'READ', 'registry name', 'role name')

语法¶

VIEW_TEMPLATES( <collaboration_name> )

实参¶

collaboration_name

协作的名称。您必须先查看或联接此协作，然后才能列出其模板。

返回¶

一个表，其中列出了有关您可以在此协作中运行的模板（包括您已注册的模板）的信息。该表包括以下各列：

• template_id：选择使用 时默认使用的角色和仓库。模板 ID。将其传入 RUN 命令的 template 字段或 template_id 参数中。

• template_spec：选择使用 时默认使用的角色和仓库。该模板的 模板规范，其中包含该模板完整的 JinjaSQL。

• parameters：选择使用 时默认使用的角色和仓库。该模板支持的所有实参说明，格式为 JSON。每个参数的信息包括名称、默认值、模板提供商编写的描述以及是否为必填项。将这些参数的值传入您的 RUN 命令中。

• shared_by：选择使用 时默认使用的角色和仓库。注册此模板的协作者。

• shared_with：选择使用 时默认使用的角色和仓库。此模板的共享对象（协作者）。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_TEMPLATES(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('VIEW TEMPLATES', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

ENABLE_TEMPLATE_AUTO_APPROVAL( <collaboration_name> )

实参¶

collaboration_name

协作的名称。

返回¶

字符串成功消息。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.ENABLE_TEMPLATE_AUTO_APPROVAL(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('MANAGE TEMPLATE AUTO APPROVAL', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

DISABLE_TEMPLATE_AUTO_APPROVAL( <collaboration_name> )

实参¶

collaboration_name

协作的名称。

返回¶

字符串成功消息。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.DISABLE_TEMPLATE_AUTO_APPROVAL(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('MANAGE TEMPLATE AUTO APPROVAL', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

REGISTER_DATA_OFFERING( ['<registry_name>' ,] <data_offering_spec> )

实参¶

registry_name （可选）

用于注册此数据产品的 自定义注册表 的名称。如果未指定，则在默认账户注册表中注册数据产品。

data_offering_spec

数据产品定义 采用 YAML 格式，用于描述此数据产品。

返回¶

在协作的 data_offerings.id 字段中使用的数据产品 ID。

示例¶

在默认注册表中注册数据产品：

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.REGISTER_DATA_OFFERING(
    $$
    api_version: 2.0.0
    spec_type: data_offering
    version: v1
    name: customers
    datasets:
     - alias: customers_1
       data_object_fqn: SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS
       allowed_analyses: template_only
       schema_and_template_policies:
         hashed_email:
           category: join_custom
         status:
           category: passthrough
    $$
  );

在自定义注册表中注册数据产品：

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.REGISTER_DATA_OFFERING(
    'my_custom_registry',
    $$
    api_version: 2.0.0
    spec_type: data_offering
    version: v1
    name: customers
    datasets:
     - alias: customers_1
       data_object_fqn: SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS
       allowed_analyses: template_only
       schema_and_template_policies:
         hashed_email:
           category: join_custom
         status:
           category: passthrough
    $$
  );

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下过程获得权限的角色。

要在默认注册表中注册数据产品，请执行以下操作：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('REGISTER DATA OFFERING', 'role name')

要在自定义注册表中注册项目，请执行以下操作：

• 您对自己创建的任何自定义注册表都具有读写权限。

• 要访问其他用户创建的自定义注册表，您需要 GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('REGISTER', 'REGISTRY', 'MY_REGISTRY', 'role name')。

语法¶

LINK_DATA_OFFERING( <collaboration_name>, <data_offering_id>, <share_with> )

实参¶

collaboration_name

协作的名称。

data_offering_id

要共享的数据集的 ID，在注册时生成。调用 VIEW_DATA_OFFERINGS 或 VIEW_REGISTERED_DATA_OFFERINGS 时，数据产品必须对您可见，才能将其链接。

share_with

要与之共享此数据集的分析执行器的字符串别名数组。除了与此数据产品或服务关联的任何其他协作者之外，还将添加此处列出的协作者。此处列出的所有协作者都必须是由您担任数据提供商的分析运行者，否则在不与任何人共享数据的情况下，过程将失败。

返回¶

字符串成功消息。

示例¶

此示例允许协作者 alice 在指定协作中使用指定的数据产品。

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.LINK_DATA_OFFERING(
  $collaboration_name,
  $my_data_id,
  ['alice']
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')，加上必须手动授予角色的所有其他账户级权限。

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')，加上必须手动授予角色的所有其他账户级权限。

如果数据产品或服务位于自定义注册表中，您还必须拥有 GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE( 'READ', 'registry name', 'role name')。

语法¶

UNLINK_DATA_OFFERING( <collaboration_name>, <data_offering_id>, <remove_for> )

实参¶

collaboration_name

协作的名称。

data_offering_id

要取消链接的数据集的 ID，在注册时生成。

remove_for

要移除访问权限的一个或多个分析执行器的字符串别名数组。此处列出的所有协作者都必须是当前有权访问此数据产品的分析执行者。

返回¶

字符串成功消息。

示例¶

-- Remove data offering access for specific analysis runners in this collaboration.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.UNLINK_DATA_OFFERING(
  $collaboration_name,
  $data_offering_id,
  ['AnalysisRunner_1', 'AnalysisRunner_2']
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

LINK_LOCAL_DATA_OFFERING( <collaboration_name>, <data_offering_id> )

实参¶

collaboration_name

协作的名称。

data_offering_id

数据集的 ID，在您注册该数据集时生成。在 VIEW_REGISTERED_DATA_OFFERINGS 和 VIEW_DATA_OFFERINGS 中也可见（仅对您可见）。

返回¶

字符串成功消息。

示例¶

此示例链接了一个已注册的数据产品，仅供当前账户使用，不会向其他协作者公开。

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.LINK_LOCAL_DATA_OFFERING(
  $collaboration_name,
  $my_private_data_offering_id
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('LINK LOCAL DATA OFFERINGS', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

UNLINK_LOCAL_DATA_OFFERING( <collaboration_name>, <data_offering_id> )

实参¶

collaboration_name

协作的名称。

data_offering_id

要取消关联的数据集的 ID，在您注册该数据集时生成。在 VIEW_REGISTERED_DATA_OFFERINGS 和 VIEW_DATA_OFFERINGS 中也可见（仅对您可见）。

返回¶

字符串成功消息。

示例¶

-- Unlink a local data offering from a collaboration.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.UNLINK_LOCAL_DATA_OFFERING(
  $collaboration_name,
  $my_private_data_offering_id
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UNLINK LOCAL DATA OFFERINGS', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

VIEW_REGISTERED_DATA_OFFERINGS( [ '<registry_name>' ] )

实参¶

registry_name （可选）

用于列出数据产品的 自定义注册表 的名称。如果未指定，则列出默认账户注册表中的数据产品。

返回¶

一个表，列出您在此账户中注册的所有数据产品详细信息。该表包括以下各列：

• DATA_OFFERING_ID：数据产品的 ID。

• NAME：选择使用 时默认使用的角色和仓库。数据产品名称。

• VERSION：选择使用 时默认使用的角色和仓库。数据产品版本。

• DATA_OFFERING_SPEC：选择使用 时默认使用的角色和仓库。数据产品的完整 YAML 规范。

• REGISTRY：选择使用 时默认使用的角色和仓库。在其中注册数据产品的注册表。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.VIEW_REGISTERED_DATA_OFFERINGS();

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

要查看默认注册表中的项目，请执行以下操作：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('VIEW REGISTERED DATA OFFERINGS', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

要查看自定义注册表中的项目，请执行以下操作：

• 您对自己创建的任何自定义注册表都具有读写权限。

• 要访问其他用户创建的自定义注册表，您需要 GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'REGISTRY', 'MY_REGISTRY', 'role name')。

语法¶

VIEW_DATA_OFFERINGS( <collaboration_name> )

实参¶

collaboration_name

要探索的协作的名称。

返回¶

有关指定协作中所有数据产品的信息。该表包括以下各列：

• template_view_name：选择使用 时默认使用的角色和仓库。在使用模板调用 RUN 进行查询时，用于引用产品的完全限定视图名称。将此名称传入 RUN 规范中的 source_tables 字段。

• template_join_columns：选择使用 时默认使用的角色和仓库。该表中可用于基于模板的查询联接的列名称。

• analysis_allowed_columns：选择使用 时默认使用的角色和仓库。该表中可用于基于模板的查询投影的列的名称。

• activation_allowed_columns：选择使用 时默认使用的角色和仓库。该表中可以激活的列名。

• freeform_sql_view_name：选择使用 时默认使用的角色和仓库。当数据集支持 自由格式 SQL 查询 时，自由格式 SQL 查询中使用的完全限定视图名称。如果数据集不提供自由格式 SQL 查询，则此单元格为空。

• freeform_sql_column_policies：选择使用 时默认使用的角色和仓库。此协作中所有 自由格式列策略 的 JSON 表示，按策略类型键入。

• shared_by：选择使用 时默认使用的角色和仓库。链接此数据产品或服务的协作者。

• shared_with：选择使用 时默认使用的角色和仓库。谁可以在分析中使用数据。如果此值为 LOCAL，这是一个本地数据集，除托管数据的一方外，不与任何协作者共享。

• data_offering_id：选择使用 时默认使用的角色和仓库。此数据产品的唯一 ID，在注册时生成。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_DATA_OFFERINGS(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('VIEW DATA OFFERINGS', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

REGISTER_CODE_SPEC( ['<registry_name>' ,] <code_spec> )

实参¶

registry_name （可选）

用于注册此代码规范的 自定义注册表 的名称。如果未指定，则在默认账户注册表中注册代码包。

code_spec

以字符串形式表示的 YAML 格式的代码包规范定义。

返回¶

生成的代码包规范 ID。

示例¶

在默认注册表中注册代码包：

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.REGISTER_CODE_SPEC(
  $$
  api_version: 2.0.0
  spec_type: code_spec
  name: custom_udf
  version: v1
  description: Custom UDF for data normalization

  functions:
    - name: normalize_value
      type: UDF
      language: PYTHON
      runtime_version: "3.10"
      handler: normalize
      arguments:
        - name: value
          type: FLOAT
        - name: min_val
          type: FLOAT
        - name: max_val
          type: FLOAT
      returns: FLOAT
      code_body: |
        def normalize(value, min_val, max_val):
            if max_val == min_val:
                return 0.0
            return (value - min_val) / (max_val - min_val)
  $$
);

在自定义注册表中注册代码包：

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.REGISTER_CODE_SPEC(
  'my_custom_registry',
  $$
  api_version: 2.0.0
  spec_type: code_spec
  name: custom_udf
  version: v1
  description: Custom UDF for data normalization

  functions:
    - name: normalize_value
      type: UDF
      language: PYTHON
      runtime_version: "3.10"
      handler: normalize
      arguments:
        - name: value
          type: FLOAT
        - name: min_val
          type: FLOAT
        - name: max_val
          type: FLOAT
      returns: FLOAT
      code_body: |
        def normalize(value, min_val, max_val):
            if max_val == min_val:
                return 0.0
            return (value - min_val) / (max_val - min_val)
  $$
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下过程获得权限的角色。

要在默认注册表中注册对象，请执行以下操作：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('REGISTER CODE SPEC', 'role name')

要在自定义注册表中注册项目，请执行以下操作：

• 您对自己创建的任何自定义注册表都具有读写权限。

• 要访问其他用户创建的自定义注册表，您需要 GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('REGISTER', 'REGISTRY', 'MY_REGISTRY', 'role name')。

语法¶

VIEW_REGISTERED_CODE_SPECS( [ '<registry_name>' ] )

实参¶

registry_name （可选）

要从中列出代码捆绑包的 自定义注册表 的名称。如果未指定，则列出默认账户注册表中的代码捆绑包。

返回¶

列出您在此账户中注册的所有代码包详细信息的表。该表包括以下各列：

• code_spec_id：代码包规范的 ID。

• name：选择使用 时默认使用的角色和仓库。代码包规范名称。

• version：选择使用 时默认使用的角色和仓库。代码包规范版本。

• code_spec：选择使用 时默认使用的角色和仓库。代码包规范的完整 YAML 规范。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.VIEW_REGISTERED_CODE_SPECS();

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

要查看默认注册表中的项目，请执行以下操作：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('VIEW REGISTERED CODE SPECS', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

要查看自定义注册表中的项目，请执行以下操作：

• 您对自己创建的任何自定义注册表都具有读写权限。

• 要访问其他用户创建的自定义注册表，您需要 GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'REGISTRY', 'MY_REGISTRY', 'role name')。

语法¶

VIEW_CODE_SPECS( <collaboration_name> )

实参¶

collaboration_name

协作的名称。

返回¶

列出指定协作中可用的代码包的表。该表包括以下各列：

• code_spec_id：此代码包规范的 ID。

• code_spec：选择使用 时默认使用的角色和仓库。代码包规范的完整 YAML 规范。

• shared_by：选择使用 时默认使用的角色和仓库。共享代码包规范的协作者别名。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_CODE_SPECS(
  $collaboration_id
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('VIEW CODE SPECS', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

VIEW_UPDATE_REQUESTS( <collaboration_name> )

实参¶

collaboration_name

协作的名称。

返回¶

在此协作中发送的更新请求表。信息包括

• id：请求的 ID。将其用于批准或拒绝请求。

• type：选择使用 时默认使用的角色和仓库。请求的类型。支持以下值：

  • 添加模板

  • 关联数据产品

  • 取消关联数据产品

  • 移除模板

• status：选择使用 时默认使用的角色和仓库。请求的当前状态。可以报告以下状态：

  • REQUESTED：选择使用 时默认使用的角色和仓库。请求已提交。

  • PENDING_MY_APPROVAL：选择使用 时默认使用的角色和仓库。该请求正在等待您的批准或拒绝。

  • PENDING_PARTNER_APPROVAL：选择使用 时默认使用的角色和仓库。您已批准该请求，但该请求仍需要得到一个或多个其他协作者的批准。

  • REJECTED：选择使用 时默认使用的角色和仓库。协作中有人拒绝了此请求。

  • APPROVED：选择使用 时默认使用的角色和仓库。所有必需的审批者都已批准该请求。

  • COMPLETED：选择使用 时默认使用的角色和仓库。更新操作已完成，变更已应用于协作。对于包含代码捆绑包的模板，您仍应 检查升级状态 以查看代码捆绑包何时可以调用。

  • FAILED：选择使用 时默认使用的角色和仓库。更新操作失败。请参阅 DETAILS 列了解故障详细信息。

• approval_log：选择使用 时默认使用的角色和仓库。该请求的所有批准和拒绝的日志。如果该请求被拒绝，此处还会提供拒绝方给出的原因。

• details：选择使用 时默认使用的角色和仓库。特定于请求类型的详细信息，例如模板名称、描述以及“添加模板”请求的共享对象。

• spec：选择使用 时默认使用的角色和仓库。正在更新的资源的详细信息，例如“添加模板”请求的模板规范。

• updated_on：选择使用 时默认使用的角色和仓库。上次对此请求采取操作（例如，批准或拒绝）的时间戳。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_UPDATE_REQUESTS(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('VIEW UPDATE REQUESTS', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

APPROVE_UPDATE_REQUEST( <collaboration_name>, <request_id> )

实参¶

collaboration_name

协作的名称。

request_id

请求的 ID。

返回¶

字符串成功消息。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.APPROVE_UPDATE_REQUEST(
  $collaboration_name,
  $request_id
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('MANAGE UPDATE REQUEST', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

REJECT_UPDATE_REQUEST( <collaboration_name>, <request_id>, <reason> )

实参¶

collaboration_name

协作的名称。

request_id

请求的 ID。

reason

人类可读的描述，说明请求被拒绝的原因。该实参是必需的，但您可以提交空字符串。

返回¶

字符串成功消息。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.REJECT_UPDATE_REQUEST(
  $collaboration_name,
  'request_1324f934457',
  'Needs more cowbell'
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('MANAGE UPDATE REQUEST', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

INITIALIZE( <collaboration_spec> [, '<auto_join_warehouse>'] )

实参¶

collaboration_spec

协作定义 采用 YAML 格式，以字符串形式呈现。

auto_join_warehouse （可选）

将仓库名称指定为有效 Snowflake 标识符的字符串。如果指定，将使用此仓库创建和联结协作。如果未指定，则当前仓库将用于创建协作，并且您必须调用 JOIN 来联结协作。推荐使用 XS 仓库。

返回¶

返回包含以下列的表：

• collaboration_name：选择使用 时默认使用的角色和仓库。协作的名称。在任何需要您指定协作的过程中使用此选项。

• message：选择使用 时默认使用的角色和仓库。有关初始化请求的信息。

• auto_join_task：选择使用 时默认使用的角色和仓库。如果已指定 auto_join_warehouse，则指示是否已创建自动加入任务。

示例¶

以下示例创建了一个协作，其中 Alice 是所有者，并且可以使用 Bob 提供的数据运行分析。

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.INITIALIZE(
  $$
  api_version: 2.0.0
  spec_type: collaboration
  name: basic_collaboration
  owner: alice
  collaborator_identifier_aliases:
    alice: corp_id.account_id
    bob: corp2_id.account2_id
  analysis_runners:
    alice:
      data_providers:
        bob:
          data_offerings:
          - id: bob_data_v1
      templates:
      - id: alice_test_template_2026_01_12_V1
  $$,
  'APP_WH'
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下过程获得权限的角色：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

  如果提供 auto-join-warehouse 参数并使用除 SAMOOHA_APP_ROLE 以外的角色，还必须向该角色授予 EXECUTE TASK 账户级权限。

有关所需的其他角色权限，请参阅 GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE。

语法¶

TEARDOWN( <collaboration_name> )

实参¶

collaboration_name

要删除的协作的名称。

返回¶

字符串成功消息。

示例¶

-- Start the process.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.TEARDOWN($collaboration_name);

-- Call until it returns LOCAL_DROP_PENDING.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.GET_STATUS($collaboration_name);

-- Final call.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.TEARDOWN($collaboration_name);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

有关所需的其他角色权限，请参阅 GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE。

语法¶

GET_STATUS( <collaboration_name> )

实参¶

collaboration_name

要查看其状态的协作的名称。您可以通过调用 COLLABORATION.VIEW_COLLABORATIONS 来查看协作列表。您必须先受邀参与协作或已联接协作，然后才能对该协作调用 GET_STATUS。

返回¶

一个表，其中显示有关指定协作中所有协作者的最新联接尝试的详细信息。该表包括以下各列：

• updated_on：选择使用 时默认使用的角色和仓库。系统报告状态的时间戳。

• collaborator_account：选择使用 时默认使用的角色和仓库。此协作者的数据共享账户 ID。

• collaborator_name：选择使用 时默认使用的角色和仓库。协作规范中声明的协作者别名。

• roles：选择使用 时默认使用的角色和仓库。此协作者的实际和潜在角色。值包括 owner、data_provider、analysis_runner。

• status：选择使用 时默认使用的角色和仓库。更新时的状态。支持以下值，并显示指定协作中指定协作者的状态。

  • CREATING：选择使用 时默认使用的角色和仓库。协作创建已启动。

  • CREATE_FAILED：选择使用 时默认使用的角色和仓库。协作创建失败。

  • CREATE_TIMED_OUT：选择使用 时默认使用的角色和仓库。协作创建超时。

  • CREATED：选择使用 时默认使用的角色和仓库。协作已创建，可以进行操作。

  • INSTALLING：选择使用 时默认使用的角色和仓库。安装应用程序包并准备协作详细信息以供审查。

  • IN_REVIEW：选择使用 时默认使用的角色和仓库。协作正在审核中。

  • INSTALLATION_FAILED：选择使用 时默认使用的角色和仓库。安装失败；应用程序包未安装，无法查看。

  • INVITED：选择使用 时默认使用的角色和仓库。已邀请参与者。

  • JOINING：选择使用 时默认使用的角色和仓库。联接过程已启动。

  • JOIN_FAILED：选择使用 时默认使用的角色和仓库。联接过程失败。

  • JOINED：选择使用 时默认使用的角色和仓库。已成功联接该协作。您可以开始使用协作。

  • LEAVING：选择使用 时默认使用的角色和仓库。退出过程已启动。

  • LEAVE_FAILED：选择使用 时默认使用的角色和仓库。退出过程失败。

  • LEFT：选择使用 时默认使用的角色和仓库。成功退出该协作。

  • LOCAL_DROP_PENDING：选择使用 时默认使用的角色和仓库。您已成功提交删除或退出该协作的请求。请再次调用 TEARDOWN 或 LEAVE 来完成该过程。

  • DROPPING：选择使用 时默认使用的角色和仓库。删除过程已启动。

  • DROPPED：选择使用 时默认使用的角色和仓库。已成功删除。

  • DROP_FAILED：选择使用 时默认使用的角色和仓库。删除过程失败。

• details：选择使用 时默认使用的角色和仓库。有关当前状态的其他详细信息（如有）。

• region：选择使用 时默认使用的角色和仓库。此协作者所属的云区域。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.GET_STATUS(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('GET STATUS', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

ENABLE_EXTERNAL_TABLE_ANALYSIS_FOR_COLLABORATION( <collaboration_name> )

实参¶

collaboration_name

协作的名称。

返回¶

包含 MESSAGE 列的表，其中显示成功消息。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.ADMIN.ENABLE_EXTERNAL_TABLE_ANALYSIS_FOR_COLLABORATION(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用获得 MANAGE FIREWALL CONFIGURATION 权限的角色才能调用此过程。

语法¶

VIEW_COLLABORATIONS()

实参¶

无

返回¶

列出您可以访问的所有协作的详细信息的表。该表包括以下各列：

• source_name：选择使用 时默认使用的角色和仓库。协作的名称，由协作规范中的 name 值指定。

• collaboration_name：选择使用 时默认使用的角色和仓库。已安装的协作的名称。在通过调用 JOIN（所有者）或 REVIEW（非所有者）安装协作之前，此值为 NULL。

• owner_account：选择使用 时默认使用的角色和仓库。创建了协作的账户的数据共享 ID。

• updated_on：选择使用 时默认使用的角色和仓库。上次更新协作的时间。

• collaboration_spec：选择使用 时默认使用的角色和仓库。此协作的规范采用 YAML 格式。这将显示协作的最新版本，包括创建协作后链接或移除的任何资源。不过，可能有一些正在处理中的更新请求即将完成关联，例如新增或移除的模板，以及提供的数据产品。

示例¶

查看所有协作：

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_COLLABORATIONS();

按名称查看给定协作的规范：

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_COLLABORATIONS() ->>
SELECT "COLLABORATION_SPEC" FROM $1 WHERE "SOURCE_NAME" = $collaboration_name;

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('RUN', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('VIEW COLLABORATIONS', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

REVIEW( <source_name>, <owner_account> )

实参¶

source_name

您受邀联接的协作的名称。您可以通过调用 COLLABORATION.VIEW_COLLABORATIONS 来查看协作列表。

owner_account

所有者的 数据共享账户标识符。这可以在对 COLLABORATION.VIEW_COLLABORATIONS 的响应中找到。

返回¶

有关协作的信息表，包括协作 ID、所有者和协作规范。

如果您的账户位于与协作所有者 不同的云托管区域，REVIEW 可能会返回一条消息，说明仍在执行其他设置步骤。如果您收到此消息，请继续调用 REVIEW，直到返回有关协作的信息表。

示例¶

-- View the collaboration for your own usage.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.REVIEW(
  $collaboration_name,
  'org1.account1234'
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('REVIEW COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

有关所需的其他角色权限，请参阅 GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE。

语法¶

JOIN( <collaboration_name> )

实参¶

collaboration_name

要联接的协作的名称。您可以通过调用 COLLABORATION.VIEW_COLLABORATIONS 来查看协作列表。如果您受邀联接具有相同名称的多个协作，系统将默认选择您对其调用过 COLLABORATION.REVIEW 的最后一个协作。

返回¶

字符串成功消息。如果您收到有关缺少引用使用授权的错误，请参阅 故障排除指南。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.JOIN(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

有关所需的其他角色权限，请参阅 GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE。

语法¶

LEAVE( <collaboration_name> )

实参¶

collaboration_name

要退出的协作的名称。

返回¶

字符串成功消息。

示例¶

-- Start the process.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.LEAVE($collaboration_name);

-- Call until it returns LOCAL_DROP_PENDING.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.GET_STATUS($collaboration_name);

-- Final call.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.LEAVE($collaboration_name);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

有关所需的其他角色权限，请参阅 GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE。

语法¶

GET_CONFIGURATION( <collaboration_name> )

实参¶

collaboration_name

协作的名称。

返回¶

返回包含以下列的表：

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.GET_CONFIGURATION(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('MANAGE TEMPLATE AUTO APPROVAL', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('READ', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

SET_CONFIGURATION( <collaboration_name>, <config_name>, <value> )

实参¶

collaboration_name

协作的名称。

config_name

要设置的配置名称。有关支持的配置名称，请参阅 GET_CONFIGURATION。

value

配置的新值。必须是该配置名称对应的有效值。

返回¶

确认请求已接受的字符串消息。

示例¶

-- Enable automatic approval of template requests
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.SET_CONFIGURATION(
  $collaboration_name,
  'TEMPLATE_AUTO_APPROVAL',
  'true'
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('MANAGE TEMPLATE AUTO APPROVAL', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('UPDATE', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

YAML 实参语法：

RUN( <collaboration_name>, <analysis_spec> )

显式参数语法：

RUN( <collaboration_name>, <template_id>, <template_view_names>, <local_template_view_names>, <arguments> )

实参¶

collaboration_name

要在其中运行此分析的协作的名称。

analysis_spec

分析定义，采用 YAML 格式，以字符串形式呈现，描述要在此分析中使用的模板、表和模板值。配合 YAML 实参语法使用。

template_id

要运行的模板的 ID。

template_view_names

要在分析中使用的源表的字符串名称数组。使用 template_view_name 列中 VIEW_DATA_OFFERINGS 返回的表名。每个条目的格式为 user_alias.data_offering_id.dataset_alias

local_template_view_names

要在分析中使用的您自己的表的字符串 IDs 数组。您必须先通过调用 LINK_LOCAL_DATA_OFFERING 来链接这些表。

arguments

包含模板使用的命名实参的 JSON 对象，其中每个键都是模板实参名称，值是该实参的值。

返回¶

以表格形式呈现的分析结果。

示例¶

按参数传递示例：

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.RUN(
  $collaboration_name,
  $template_name,
  ['Provider.data_offering_1_2026_01_12_v0.test_dataset'], -- Tables to pass to source_tables variable.
  [],
  {} -- Template takes no parameters.
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('RUN', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

VIEW_ACTIVATIONS( <collaboration_name> )

实参¶

collaboration_name

协作的名称。

返回¶

包含每次激活详细信息的表。该表包括以下各列：

• updated_on：选择使用 时默认使用的角色和仓库。上次更新状态的时间。

• segment_name：选择使用 时默认使用的角色和仓库。分析执行器分配的任意字符串，用于标识此激活。有关更多信息，请参阅 Activating query results。

• batch_id：选择使用 时默认使用的角色和仓库。此激活请求的批次 ID。有关更多信息，请参阅 查看提供商和使用者激活结果。

• template_id：选择使用 时默认使用的角色和仓库。用于生成此激活数据的模板。

• shared_by：选择使用 时默认使用的角色和仓库。已运行分析的协作者。

• shared_with：选择使用 时默认使用的角色和仓库。应接收分析数据的协作者。

• status：选择使用 时默认使用的角色和仓库。激活的状态。支持以下值：

  • PENDING：选择使用 时默认使用的角色和仓库。已请求激活，但正在等待处理。

  • REPLICATING：选择使用 时默认使用的角色和仓库。激活数据正在复制到目标区域。

  • SHARED：选择使用 时默认使用的角色和仓库。激活数据可进行处理。调用 PROCESS_ACTIVATION 将结果发送到您的账户。

  • FAILED：选择使用 时默认使用的角色和仓库。激活处理失败。请参阅 details 列中的信息。

  • PROCESSED：选择使用 时默认使用的角色和仓库。激活结果已发送到激活请求中指定的账户。

• details：选择使用 时默认使用的角色和仓库。失败详细信息（如果激活失败）。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_ACTIVATIONS(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('VIEW ACTIVATIONS', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('RUN', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

PROCESS_ACTIVATION( <collaboration_name> [, <segment_name> | <array_of_batch_ids> ] )

实参¶

collaboration_name

协作的名称。

segment_name （可选）

要处理的特定激活段的字符串名称。

batch_ids （可选）

要处理的激活批次 IDs 的字符串数组。此值使用 VIEW_ACTIVATIONS 返回。如果未包含在内，则请求将处理调用方指定协作中的所有待处理激活。

返回¶

用户可以检索结果的表名称，以及为结果指定的段名称。请参阅 Implementing activation，了解如何读取结果。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.PROCESS_ACTIVATION(
  $collaboration_name
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下任一过程获得权限的角色：

• GRANT_PRIVILEGE_ON_OBJECT_TO_ROLE('PROCESS ACTIVATION', 'COLLABORATION', 'collaboration name', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE COLLABORATION', 'role name')

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('JOIN COLLABORATION', 'role name')

语法¶

CREATE_REGISTRY( '<registry_name>', <registry_type> )

实参¶

registry_name

要创建的注册表的名称。必须是账户中所有注册表中的唯一名称。

registry_type

此注册表将包含的资源类型。支持的值：TEMPLATE、DATA OFFERING

返回¶

字符串成功消息。

示例¶

CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.REGISTRY.CREATE_REGISTRY(
  'my_custom_registry',
  'TEMPLATE'
);

访问要求¶

如果不使用 SAMOOHA_APP_ROLE 角色，则必须使用通过调用以下过程获得权限的角色：

• GRANT_PRIVILEGE_ON_ACCOUNT_TO_ROLE('CREATE REGISTRY', 'role name')

语法¶

VIEW_REGISTRIES()