Last updated: 10/28/2026
The IncludeModel statement loads a data product and its semantic model, including tables, relationships, measures, and dimensions. Measures and dimensions from the semantic model automatically appear as master items in the application.
Syntax:
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]
| Argument or keyword | Description |
|---|---|
| data_product_name | The name of the data product to load. |
| FromSpace, FromCurrentSpace, or FromPersonalSpace |
Keywords specifying the space from which to load the data product. Use one of the following as needed. If all of these keyword options are omitted, the IncludeModel statement looks for the data product in your personal space.
|
| data_product_space |
Specifies the space of the data product you want to load, if you are using FromSpace to explicitly specify a particular space from which to load. This is not applicable if you are using FromPersonalSpace or FromCurrentSpace. Follow the quoting conventions documented at Using quotation marks in the script. Examples: MyAnalyticsSpace "My Analytics Space" [My Analytics Space] |
| InEnvironment |
Keyword specifying to use the data product in the environment specified with environment_name. Not required if the data product is not located in an environment. |
| environment_name |
The name of the environment, if applicable, containing the data product you want to load. Follow the quoting conventions documented at Using quotation marks in the script. Examples: Production [Production Environment] "Production Environment" |
| WithTables | Keyword specifying to use the tables defined in subsequent Table statements. |
| Table | Keyword specifying the use of a table. Loads one table per Table statement. |
| table_name |
Specifies the name of the table to use in the data model. Follow the quoting conventions documented at Using quotation marks in the script. Examples: MyDataTable [My Data Table] "My Data Table" |
| Fields | Keyword instructing to use the specified fields (fieldlist) from the table to integrate into the data model. |
| fieldlist |
List of fields from the table referenced in the preceding Table statement. You can use * to use all fields from the table, or provide a comma-separated list of specific fields. Examples: Amount, Quantity, Region [Amount], [Quantity], [Region] |
| Connection | Keyword specifying to use the dataset specified in dataset_connection. |
| dataset_connection |
A connection that can load the dataset containing the referenced table. Depending on the location of the connection, use one of the following formats:
Examples: [CustomerOrders:DataFiles] [SalesData2026:SnowflakeSales] |
| WithMeasures | Keyword instructing to convert the specified measures from the data product (measurelist) into master measures. |
| measurelist |
List of measures from data product's semantic model to be converted into master measures. You can use * to convert all measures, or provide a comma-separated list of specific measures. Example: [Sales], [Total Quantity], [Cost] |
| WithDimensions | Keyword instructing to convert the specified dimensions from the data product (dimensionlist) into master dimensions. |
| dimensionlist |
List of dimensions from data product's semantic model to be converted into master dimensions. You can use * to convert all dimensions, or provide a comma-separated list of specific dimensions. Example: [Product Name], [Region], [Customer] |
Remarks
The IncludeModel statement is typically generated automatically by the data catalog when you choose to load a data product with its semantic model. You can also write the statement manually or edit the generated statement to customize which fields, measures, and dimensions are included.
Relationships defined in the semantic model are automatically applied to the loaded tables, creating associations in your data model.
Operations for measures and dimensions are applied at the end of the data load after the tables and fields are loaded. If the load fails before that phase, no measure or dimension operations are applied.
Master item properties
Most attributes of master items inherited from semantic models are read-only in the consuming application. Some other master item attributes, such as those related to visualizations, can still be edited within the application.
The read-only behavior applies to the user interface only—you can set a number of master item properties via API:
-
Properties that are configurable in the semantic model but read-only in the consuming application's user interface. This includes title, description, and tags.
-
Properties that are not configured in the semantic model and not exposed in the consuming application's user interface.
Changes to properties defined by the semantic model will be overwritten when the application reloads.
Master item deletion
In an unpublished application, you can delete an inherited master item, but it reappears on the next reload if it is still referenced in the IncludeModel script. To permanently remove it, remove it from the script first. You can also duplicate an inherited master item. The duplicate is an ordinary application master item and is fully editable.