# IncludeModel

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](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/FromSpace.htm), [FromCurrentSpace](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/FromCurrentSpace.htm), or [FromPersonalSpace](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/FromPersonalSpace.htm) | 用于指定从中加载数据产品的空间的关键字。<br><br>根据需要使用以下选项之一。如果省略所有这些关键字选项，则 IncludeModel 语句会在您的个人空间中查找数据产品。<br><br><ul> <li> <p><span>FromSpace</span>：加载位于 <code>data_product_space</code> 所指定空间中的数据产品。</p> </li> <li> <p><span>FromCurrentSpace</span>：加载位于当前空间中的数据产品。</p> </li> <li> <p><span>FromPersonalSpace</span>: 加载位于您的个人空间中的数据产品。</p> </li> </ul> |
| data\_product\_space | 指定要加载的数据产品的空间，如果您使用 FromSpace 显式指定要从中加载的特定空间。如果您使用的是 FromPersonalSpace 或 FromCurrentSpace，则不适用。<br><br>请遵循 [在脚本中使用引号](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/use-quotes-in-script.htm) 中记录的引用约定。示例：<br><br>`MyAnalyticsSpace`<br>`"My Analytics Space"`<br>`[My Analytics Space]` |
| [InEnvironment](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/InEnvironment.htm) | 用于指定在 `environment_name` 指定的环境中使用数据产品的关键字。<br><br>如果数据产品未位于环境中，则不需要。 |
| environment\_name | 包含您要加载的数据产品的环境的名称（如果适用）。<br><br>请遵循 [在脚本中使用引号](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/use-quotes-in-script.htm) 中记录的引用约定。示例：<br><br>`Production`<br>`[Production Environment]`<br>`"Production Environment"` |
| [WithTables](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/WithTables.htm) | 指定使用后续 `Table` 语句中定义的表的关键字。 |
| [Table](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/Table.htm) | 指定使用表的关键字。每条 `Table` 语句加载一个表。 |
| table\_name | 指定在数据模型中使用的表的名称。<br><br>请遵循 [在脚本中使用引号](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/use-quotes-in-script.htm) 中记录的引用约定。示例：<br><br>`MyDataTable`<br>`[My Data Table]`<br>`"My Data Table"` |
| [Fields](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/Field.htm) | 指示使用表中的指定字段 (fieldlist) 集成到数据模型中的关键字。 |
| fieldlist | 前面 `Table` 语句中引用的表中的字段列表。<br><br>您可以使用 `*` 来使用表中的所有字段，或者提供以逗号分隔的特定字段列表。<br><br>示例：<br><br>`Amount, Quantity, Region`<br>`[Amount], [Quantity], [Region]` |
| [Connection](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/Connection.htm) | 用于指定使用 `dataset_connection` 中指定的数据集的关键字。 |
| dataset\_connection | 能够加载包含所引用表的数据集的连接。<br><br>根据连接的位置，使用以下格式之一：<br><br><ul> <li> <p><span>environment:space:connection</span> — 用于位于环境（在 <span>Qlik Cloud</span> 和 <span>Qlik Talend Cloud</span> 之间同步数据的容器）中的文件。环境与空间（特别是<span>数据空间</span>）相关联。</p> <p>有关环境的详细信息，请参阅 <a href="https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-administer-environments.htm">同步和管理环境</a>。</p> </li> <li> <p><span>space:connection</span> — 用于以空间作为顶级存储容器，或与加载应用程序位于同一环境中的连接。这可以是位于 <span>共享</span>、<span>托管</span>或数据空间中的连接。</p> <p>例如，对于本地存储在 <span>Qlik Cloud</span>（<span>DataFiles</span> 连接）中且位于名为 <span>Sales Analysis</span> 的空间中的数据集，您可以使用以下内容：<span>Sales Analysis:DataFiles</span></p> </li> <li> <p><span>connection</span> — 仅连接名称。这是指位于您的<span>个人空间</span>中的连接。在这种情况下，连接将只是：<span>DataFiles</span></p> </li> </ul><br><br>示例：<br><br>`[CustomerOrders:DataFiles]`<br>`[SalesData2026:SnowflakeSales]` |
| [WithMeasures](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/WithMeasures.htm) | 指示将数据产品 (measurelist) 中的指定度量转换为主度量的关键字。 |
| measurelist | 数据产品语义模型中要转换为主度量的度量列表。<br><br>您可以使用 `*` 来转换所有度量，或者提供以逗号分隔的特定度量列表。<br><br>示例：<br><br>`[Sales], [Total Quantity], [Cost]` |
| [WithDimensions](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/WithDimensions.htm) | 指示将指定维度从数据产品 (dimensionlist) 转换为主维度的关键字。 |
| dimensionlist | 数据产品语义模型中要转换为主维度的维度列表。<br><br>您可以使用 `*` 来转换所有维度，或者提供以逗号分隔的特定维度列表。<br><br>示例：<br><br>`[Product Name], [Region], [Customer]` |

## 注释

当您选择加载包含其语义模型的数据产品时，IncludeModel 语句通常由数据目录自动生成。您还可以手动编写语句或编辑生成的语句，以自定义包含哪些字段、度量和维度。

语义模型中定义的关系会自动应用于已加载的表，从而在您的数据模型中创建关联。

针对度量和维度的操作会在表和字段加载之后的数据加载结束时应用。如果加载在该阶段之前失败，则不会应用任何度量或维度操作。

信息注释要使用 IncludeModel 语句，您必须在包含数据产品的空间中拥有 可消费数据 或 可查看 权限。

### 主条目属性

从语义模型继承的主条目的大多数属性在消费端应用程序中均为只读。某些其他主条目属性，例如与可视化相关的属性，仍可在应用程序中进行编辑。

只读行为仅适用于用户界面——您可以通过 API 设置多个主条目属性：

* 在语义模型中可配置，但在使用方应用程序的用户界面中为只读的属性。这包括标题、描述和标签。

* 未在语义模型中配置且未在使用方应用程序的用户界面中公开的属性。

应用程序重新加载时，对语义模型定义的属性所做的更改将被覆盖。

### 主项目删除

在未发布的应用程序中，您可以删除继承的主条目，但如果它仍被 IncludeModel 脚本引用，则会在下次重新加载时重新出现。若要永久删除它，请先将其从脚本中删除。您也可以复制继承的主条目。该复制是普通的应用主条目，完全可编辑。

## 示例 1 – 加载特定表以及所有度量和维度

[](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/IncludeModel.htm)

#### 加载脚本

此示例从数据产品及其语义模型中加载特定表及其关系。它还使用通配符 (\*) 从特定表中加载所有字段，并且语义模型中的所有度量和维度都将在应用程序中定义为主条目。

```
IncludeModel [Sales Performance Data] FromSpace [Sales Analysis Space]
WithTables
    Table [Transactions] Fields * Connection [Sales Analysis Space:DataFiles],
    Table [Products] Fields * Connection [Sales Analysis Space:DataFiles]
WithMeasures *
WithDimensions *;
```

此 IncludeModel 语句的组成部分如下：

* 数据产品名称：`Sales Performance Data`

* 数据产品空间：`Sales Analysis Space`

* 表格：`Transactions` 和 `Products`

* 字段：全部

* 度量和维度：全部

这两个表及其关系均已加载。语义模型中的所有度量和维度都将在应用程序中显示为主条目。

## 示例 2 – 加载特定的表、度量值和维度

[](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/IncludeModel.htm)

#### 加载脚本

此示例从数据产品及其语义模型中加载特定表及其关系。它使用通配符 (\*) 从特定表中加载所有字段。特定的度量和维度被定义为主条目，而不是自动将所有度量和维度定义为主条目。

```
IncludeModel [Customer Analytics] FromSpace [sales]
WithTables 
    Table [Customers] Fields * Connection [sales:DataFiles],
    Table [Orders] Fields * Connection [sales:DataFiles]
WithMeasures [Total Revenue], [Customer Count]
WithDimensions [Customer Name];
```

此 IncludeModel 语句的组成部分如下：

* 数据产品名称：`Customer Analytics`

* 数据产品空间：`sales`

* 表格：`Customers` 和 `Orders`

* 字段：全部

* 度量：`Total Revenue` 和 `Customer Count`

* 尺寸：`Customer Name`

这两个表及其关系均已加载。来自语义模型的每个特定度量和维度都会在应用程序中显示为主条目。

## 示例 3 – 加载特定表以及所有度量值和维度（数据集位于环境中）

[](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Scripting/ScriptRegularStatements/IncludeModel.htm)

#### 加载脚本

此示例从包含在环境内的数据空间中的数据产品加载特定表及其语义模型关系（请参阅 [同步和管理环境](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-administer-environments.htm)）。它还使用通配符 (\*) 从特定表中加载所有字段，并且语义模型中的所有度量和维度都将在应用程序中定义为主条目。

```
IncludeModel [Sales Performance Data]
    InEnvironment 'Production'
    FromSpace [Sales Analysis Space]
WithTables
    Table [Transactions] Fields * Connection [Sales Analysis Space:DataFiles],
    Table [Products] Fields * Connection [Sales Analysis Space:DataFiles]
WithMeasures *
WithDimensions *;
```

此 IncludeModel 语句的组成部分如下：

* 数据产品名称：`Sales Performance Data`

* 数据产品环境：`Production`

* 数据产品空间：`Sales Analysis Space`

* 表格：`Transactions` 和 `Products`

* 字段：全部

* 度量和维度：全部

这两个表及其关系均已加载。语义模型中的所有度量和维度都将在应用程序中显示为主条目。

## IncludeModel 脚本限制

不支持 WithTables: \* 通配符语法。您必须显式列出表。

[数据产品中的语义模型](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/DataProducts/semantic-models-in-data-products.htm)

[在应用程序中消费数据产品](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/DataProducts/consuming-data-products-apps.htm)

[数据目录](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/LoadData/data-catalog.htm)