Interface: EntityMetadata

Defined in: src/model/EntityMetadata.ts:74

Properties

target

target: Function

Defined in: src/model/EntityMetadata.ts:75

---

tableName

tableName: string

Defined in: src/model/EntityMetadata.ts:76

---

schema?

optional schema?: string

Defined in: src/model/EntityMetadata.ts:77

---

columns

columns: Map<string, ColumnMetadata>

Defined in: src/model/EntityMetadata.ts:78

---

primaryKeys

primaryKeys: string[]

Defined in: src/model/EntityMetadata.ts:79

---

compositeKeys?

optional compositeKeys?: string[][]

Defined in: src/model/EntityMetadata.ts:84

Composite primary key definitions. Each inner array is a set of column names forming one PK. When set, DDL emits a table-level PRIMARY KEY constraint instead of per-column PRIMARY KEY.

---

ignoredProperties

ignoredProperties: Set<string>

Defined in: src/model/EntityMetadata.ts:85

---

softDelete?

optional softDelete?: SoftDeleteMetadata

Defined in: src/model/EntityMetadata.ts:86

---

createdAtProperty?

optional createdAtProperty?: string

Defined in: src/model/EntityMetadata.ts:87

---

updatedAtProperty?

optional updatedAtProperty?: string

Defined in: src/model/EntityMetadata.ts:88

---

createdByProperty?

optional createdByProperty?: string

Defined in: src/model/EntityMetadata.ts:89

---

versionProperty?

optional versionProperty?: VersionMetadata

Defined in: src/model/EntityMetadata.ts:90

---

concurrencyCheckProperties

concurrencyCheckProperties: Set<string>

Defined in: src/model/EntityMetadata.ts:91

---

queryFilters

queryFilters: (clause) => any[]

Defined in: src/model/EntityMetadata.ts:92

Parameters

Parameter	Type
clause	any

Returns

any

---

relations

relations: Map<string, RelationMetadata>

Defined in: src/model/EntityMetadata.ts:93

---

indexes?

optional indexes?: IndexMetadata[]

Defined in: src/model/EntityMetadata.ts:94

---

lifecycleHooks?

optional lifecycleHooks?: EntityLifecycleHooks

Defined in: src/model/EntityMetadata.ts:95

---

tenantIdProperty?

optional tenantIdProperty?: string

Defined in: src/model/EntityMetadata.ts:96

---

isView?

optional isView?: boolean

Defined in: src/model/EntityMetadata.ts:101

When true, this entity maps to a database VIEW rather than a table. DDL generation is skipped; write operations (add/update/remove) throw at runtime.