IncludeModel
上次更新日期:2026-11-03
IncludeModel 语句加载数据产品及其语义模型,包括表、关系、度量和维度。来自语义模型的度量和维度会自动在应用程序中显示为主条目。
IncludeModel data_product_name [InEnvironment environment_name] [FromSpace data_product_space | FromCurrentSpace | FromPersonalSpace] [WithTables Table table_name1 Fields fieldlist Connection dataset_connection {, Table table_nameN Fields fieldlist Connection dataset_connection,... }] [WithMeasures measurelist] [WithDimensions dimensionlist]
| 参数或关键字 | 说明 |
|---|---|
| data_product_name | 要加载的数据产品的名称。 |
| FromSpace, FromCurrentSpace, or FromPersonalSpace |
用于指定从中加载数据产品的空间的关键字。 根据需要使用以下选项之一。如果省略所有这些关键字选项,则 IncludeModel 语句会在您的个人空间中查找数据产品。
|
| data_product_space |
指定要加载的数据产品的空间,如果您使用 FromSpace 显式指定要从中加载的特定空间。如果您使用的是 FromPersonalSpace 或 FromCurrentSpace,则不适用。 请遵循 在脚本中使用引号 中记录的引用约定。示例: MyAnalyticsSpace "My Analytics Space" [My Analytics Space] |
| InEnvironment |
用于指定在 environment_name 指定的环境中使用数据产品的关键字。 如果数据产品未位于环境中,则不需要。 |
| environment_name |
包含您要加载的数据产品的环境的名称(如果适用)。 请遵循 在脚本中使用引号 中记录的引用约定。示例: Production [Production Environment] "Production Environment" |
| WithTables | 指定使用后续 Table 语句中定义的表的关键字。 |
| Table | 指定使用表的关键字。每条 Table 语句加载一个表。 |
| table_name |
指定在数据模型中使用的表的名称。 请遵循 在脚本中使用引号 中记录的引用约定。示例: MyDataTable [My Data Table] "My Data Table" |
| Fields | 指示使用表中的指定字段 (fieldlist) 集成到数据模型中的关键字。 |
| fieldlist |
前面 Table 语句中引用的表中的字段列表。 您可以使用 * 来使用表中的所有字段,或者提供以逗号分隔的特定字段列表。 示例: Amount, Quantity, Region [Amount], [Quantity], [Region] |
| Connection | 用于指定使用 dataset_connection 中指定的数据集的关键字。 |
| dataset_connection |
能够加载包含所引用表的数据集的连接。 根据连接的位置,使用以下格式之一:
示例: [CustomerOrders:DataFiles] [SalesData2026:SnowflakeSales] |
| WithMeasures | 指示将数据产品 (measurelist) 中的指定度量转换为主度量的关键字。 |
| measurelist |
数据产品语义模型中要转换为主度量的度量列表。 您可以使用 * 来转换所有度量,或者提供以逗号分隔的特定度量列表。 示例: [Sales], [Total Quantity], [Cost] |
| WithDimensions | 指示将指定维度从数据产品 (dimensionlist) 转换为主维度的关键字。 |
| dimensionlist |
数据产品语义模型中要转换为主维度的维度列表。 您可以使用 * 来转换所有维度,或者提供以逗号分隔的特定维度列表。 示例: [Product Name], [Region], [Customer] |
注释
当您选择加载包含其语义模型的数据产品时,IncludeModel 语句通常由数据目录自动生成。您还可以手动编写语句或编辑生成的语句,以自定义包含哪些字段、度量和维度。
语义模型中定义的关系会自动应用于已加载的表,从而在您的数据模型中创建关联。
针对度量和维度的操作会在表和字段加载之后的数据加载结束时应用。如果加载在该阶段之前失败,则不会应用任何度量或维度操作。
主条目属性
从语义模型继承的主条目的大多数属性在消费端应用程序中均为只读。某些其他主条目属性,例如与可视化相关的属性,仍可在应用程序中进行编辑。
只读行为仅适用于用户界面——您可以通过 API 设置多个主条目属性:
-
在语义模型中可配置,但在使用方应用程序的用户界面中为只读的属性。这包括标题、描述和标签。
-
未在语义模型中配置且未在使用方应用程序的用户界面中公开的属性。
应用程序重新加载时,对语义模型定义的属性所做的更改将被覆盖。
主项目删除
在未发布的应用程序中,您可以删除继承的主条目,但如果它仍被 IncludeModel 脚本引用,则会在下次重新加载时重新出现。若要永久删除它,请先将其从脚本中删除。您也可以复制继承的主条目。该复制是普通的应用主条目,完全可编辑。