您在此处:
自定义协作模板
自定义协作模板是提供商可以创建的 JSON 文件,用于指定所需的元数据属性和协作条款。自定义模板可以支持每个用例下的多个用例和多个查询。要创建自定义模板,请复制示例 JSON,指定字段值,并在创建软件包时上载模板。在创建洁净室软件包时,您也可以从 Data 360 设置下载示例 JSON。
模板概览
自定义协作模板包含这些字段。
| 字段名 | 数据类型 | 要求 | 接受的值 | 描述 |
|---|---|---|---|---|
name |
字符串 | 必填 | 不适用 | 协作模板的名称。 |
description |
字符串 | 可选 | 不适用 | 协作模板的简短描述。 |
tables |
对象 | 必填 | 不适用 | 协作查询中使用的输入表。 |
queries |
对象 | 必填 | 不适用 | 在洁净室协作中为支持用例运行的查询。 |
表格配置
查询使用的每个输入表必须定义为tables字段。每个表定义必须包含 tableConfigs 属性。
tableConfigs(数组,必填项)– 表定义的列表。每个条目代表一个表配置,必须包含这些字段。
| 字段名 | 数据类型 | 要求 | 接受的值 | 描述 |
|---|---|---|---|---|
name |
字符串 | 必填 | 不适用 | 表的名称。 |
description |
字符串 | 可选 | 不适用 | 表定义的简短描述。 |
role |
字符串 | 必填 | 提供商或消费者 | 在协作中共享表的角色。 |
columns |
array | 必填 | 不适用 | 表格的模式。每个列对象在表中定义字段,并且必须包含name、type、可选description和defaultvalue(如果有)。 |
查询配置
查询部分定义了您想要在洁净室中允许的组合数据集上的所有查询。每个查询必须包含 queryConfigs 属性。
queryConfigs(数组,必填项)– 查询配置的列表。每个条目定义一个查询,并且必须包含这些字段。
| 字段名 | 数据类型 | 要求 | 接受的值 | 描述 |
|---|---|---|---|---|
name |
字符串 | 必填 | 不适用 | 查询的名称。 |
description |
字符串 | 可选 | 不适用 | 查询配置的简短描述。 |
useCase |
字符串 | 必填 | 重叠或自定义 | 此查询支持的用例。 |
type |
字符串 | 必填 | SQL | 查询的类型。 |
source |
字符串 | 必填 | 不适用 | 实际 SQL 查询文本。 对 |
referencedTables |
字符串数组 | 必填 | 不适用 | 查询引用的所有表的列表。此字段必须包含至少一个表名称。 |
queryParameters |
对象 | 可选 | 不适用 | 查询中使用的动态参数。每个queryParameter必须包含带有name、type和可选description字段的queryParamConfigs。 |
analysisConfigs |
对象 | 可选 | 不适用 | 输出选项,例如 outputPath。 |
- 自定义协作模板示例 JSON
复制以下模板代码,或直接在 Data 360 中下载,以开始创建自定义模板。使用适当值填写必填和可选字段。 - 自定义模板支持的数据类型
自定义模板支持的数据类型因洁净室平台而异。遵守支持的数据类型,以便成功执行查询。
