import { TypeList } from "docs-ui"

DmlEntity

Dml entity is a representation of a DML model with a unique name, its schema and relationships.

Type parameters

<TypeList types={[{"name":"Schema","type":"DMLSchema","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"RelationshipTypes","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"TConfig","type":"IDmlEntityConfig","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tableName","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="DmlEntity"/>

Constructors

• constructor

Methods

• cascades
• checks
• clearTranslatableEntities
• getTranslatableEntities
• indexes
• isDmlEntity
• parse

Properties

• [IsDmlEntity]
• name
• schema

constructor

Type Parameters

<TypeList types={[{"name":"Schema","type":"DMLSchema","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"RelationshipTypes","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"TConfig","type":"IDmlEntityConfig","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tableName","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="DmlEntity"/>

Parameters

<TypeList types={[{"name":"nameOrConfig","type":"TConfig","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="DmlEntity"/>

---

<TypeList types={[{"name":"[IsDmlEntity]","type":"boolean","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"name","type":"InferDmlEntityNameFromConfig<TConfig>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="DmlEntity"/>