Skip to content

Commit 529048c

Browse files
authored
Update the description of isContainer
1 parent 48554c8 commit 529048c

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

articles/purview/tutorial-custom-types.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ For example:
7070
:::image type="content" source="./media/tutorial-custom-types/base-model-diagram.png" alt-text="Diagram showing the relationships between system types." border="false":::
7171

7272
## Example of a *Type* definition
73-
73+
7474
To better understand the Type system, let's look at an example and see how an **Azure SQL Table** is defined.
7575

7676
You can get the complete type definition by sending a `GET` request to the Type Definition [endpoint](/rest/api/purview/catalogdataplane/types/get-type-definition-by-name):
@@ -213,13 +213,15 @@ Below you can see a simplified JSON result:
213213

214214
* **enDef1** is the first end of the definition and contains the attributes:
215215

216-
* **type** is the type of the entity that this relationship expects as end1
216+
* **type** is the type of the entity that this relationship expects as end1.
217217

218-
* **name** is the attribute that will appear on this entity's relationship attribute
218+
* **name** is the attribute that will appear on this entity's relationship attribute.
219219

220220
* **cardinality** is either SINGLE, SET or LIST.
221221

222-
* **isContainer** is a boolean and is related to the *cardinality* of this relationship. If the *cardinality* is set to **SET** or **LIST**, then *isContainer* should be set to True. This describes whether the relationship is a one-to-one relationship or one-to-many. For example, in a SQL Table, *columns* relationship (of type *azure_sql_table_columns*) is a one-to-many relationship between a table and its columns.
222+
* **isContainer** is a boolean and applies to containment relationship category. When set to true in one end, it indicates that this end is the container of the other end. Therefore:
223+
* Ony *Composition* or *Aggregation* category relationship can and should have in one end *isContainer* set to true.
224+
* *Association* category relationship should not have *isContainer* property set to true in any end.
223225

224226
* **endDef2** is the second end of the definition and describes, similarly to endDef1, the properties of the second part of the relationship.
225227

@@ -533,4 +535,4 @@ They should be linked together through a 1:n relationship.
533535

534536
> [!div class="nextstepaction"]
535537
> [Manage data sources](manage-data-sources.md)
536-
> [Microsoft Purview data plane REST APIs](/rest/api/purview/)
538+
> [Microsoft Purview data plane REST APIs](/rest/api/purview/)

0 commit comments

Comments
 (0)