An entity represents a data table that holds information within the data model. In a Cached Model, you can easily add an entity through the Get Data button and further create a custom entity using an SQL expression. For more information on data extraction, see the Create Cached Model article.

To Reconfigure Entity

There are high chances of missing columns or specifying an incorrect table definition when adding entities using SQL expressions. To resolve this issue, you can reconfigure the entity to modify its bound data source, existing table definition, or predefined alias. The process to reconfigure an entity is similar to the get data process of the cached model, used for extracting data from multiple data sources.

Note: You can reconfigure only one entity at a time.

1. In the data model designer, select an entity you want to modify.

2. Click the Ellipses icon and select the Reconfigure Entity option.

   
   

3. In the Reconfigure window that appears, choose the data source for the selected entity, or keep the original data source, and click the Next button.

   
   

4. Select the table you want to reconfigure or add a custom table using an SQL expression. In the case of the original data source, the chosen table is already selected by default.

   Note: You can select only one table at a time.

   
   

   Here, you can modify the table in the following ways -

   • Add or change the table alias by entering the name under the Alias header.

     
     

   • Replace the chosen entity with another table, by selecting any other table from the list. For example, over here the Categories table would be replaced by Territories.

     
     

   • Change the custom table definition by entering a valid SQL query using the Edit button.

     
     

     You can also change the table name using the Alias field.

     The originally selected table gets replaced by the newly created custom table.

     
     

   Note: In the case of unsupported column data types, an error message is displayed while selecting and editing the table.

5. Click the Next button to proceed further.

6. Select the table column you want to reconfigure. By default, all the columns in the table are selected. You can uncheck the checkbox next to the Column Name header to discard the default selection of columns.

   
   

   Following are the different ways to modify a table column -

   • Change the column data type using the Type dropdown.

     
     

     
     

   • Add or modify the existing column name by entering the name under the Alias header. You can also generate the Alias based on data source mapping or database description by clicking this button . It is supported for: SQL Server, Oracle, Mysql, TiDB, and Doris databases.
     

     
     

   • Add a new custom column using a valid SQL expression.

     
     

   • Change the custom column definition by entering a valid SQL query using the Edit button. You can also change the column name using the Alias field.

     
     

   Note: You cannot add or remove a column from a custom table.

7. Click the Next button to proceed further.

   The data for the table starts loading, you can see the loading progress for the table under the Progress header.

   
   

   Once the data loading is complete, you will see the load status for the table under the Status header, and the number of rows loaded in that table under the Total Number of Rows header.

   
   

   Note: The relationships that are no longer valid after successfully reconfiguring an entity are removed from the model.

To Delete Entity

Follow the below steps to delete an entity from a cached model.

1. Select the entity you want to delete.

2. Click the Delete button next to the selected entity.

   
   

3. In the Delete Entity dialog box that appears, click Yes to confirm. Note that all the relationships referring to the chosen table are removed as well.

   
   

Search Entity

Follow the below steps to search for an entity from a cached model.

1. Go to the Entities list, and enter the name of the entity you want to search in the search bar above the entity list. The searched entity will be listed as shown below.

   
   

   
   

Important Properties

The following table describes the important properties of an entity that you can set in the Data Model Designer.