EntityMetadata <Entity, Class>

Runtime metadata for an entity, holding its properties, relations, indexes, hooks, and more. Created during metadata discovery and used throughout the ORM lifecycle.

Index

Constructors

• constructor

Properties

• abstract
• allTPTDescendants
• bidirectionalRelations
• checks
• class
• className
• collection
• comment
• comparableProps
• compositePK
• concurrencyCheckKeys
• constructorParams
• definedProperties
• discriminatorColumn
• discriminatorMap
• discriminatorValue
• embeddable
• expression
• extends
• filters
• forceConstructor
• getterProps
• hasTriggers
• hasUniqueProps
• hooks
• hydrateProps
• indexes
• inheritanceType
• materialized
• name
• orderBy
• ownProps
• path
• pivotTable
• polymorphicDiscriminatorMap
• polymorphs
• primaryKeys
• properties
• propertyOrder
• props
• prototype
• readonly
• referencingProperties
• relations
• repository
• repositoryClass
• root
• schema
• selfReferencing
• serializedPrimaryKey
• simplePK
• tableName
• tptChildren
• tptDiscriminatorColumn
• tptInverseProp
• tptParent
• tptParentProp
• trackingProps
• uniqueProps
• uniques
• validateProps
• versionProperty
• view
• virtual
• withData

Accessors

• tableName
• uniqueName

Methods

• addProperty
• createColumnMappingObject
• createSchemaColumnMappingObject
• getPrimaryProp
• getPrimaryProps
• removeProperty
• sync

Constructors

constructor

• new EntityMetadata<Entity, Class>(meta): EntityMetadata<Entity, Class>

• Parameters

  • meta: Partial<EntityMetadata<any, EntityCtor<any>>> = {}

  Returns EntityMetadata<Entity, Class>

Properties

abstract

abstract: boolean

optionalallTPTDescendants

allTPTDescendants?: EntityMetadata<any, EntityCtor<any>>[]

For TPT: all non-abstract descendants, sorted by depth (deepest first). Precomputed during discovery.

bidirectionalRelations

bidirectionalRelations: EntityProperty<Entity, any>[]

checks

checks: CheckConstraint<Entity>[]

class

class: Class

className

className: string

collection

collection: string

optionalcomment

comment?: string

comparableProps

comparableProps: EntityProperty<Entity, any>[]

compositePK

compositePK: boolean

concurrencyCheckKeys

concurrencyCheckKeys: Set<EntityKey<Entity, false>>

optionalconstructorParams

constructorParams?: keyof Entity[]

definedProperties

definedProperties: Dictionary<any>

optionaldiscriminatorColumn

discriminatorColumn?: EntityKey<Entity, false> | AnyString

optionaldiscriminatorMap

discriminatorMap?: Dictionary<EntityClass<any>>

optionaldiscriminatorValue

discriminatorValue?: string | number

embeddable

embeddable: boolean

optionalexpression

expression?: string | (em, where, options, stream) => MaybePromise<string | object | RawQueryFragment<string>>

optionalextends

extends?: EntityName<Entity>

filters

filters: Dictionary<FilterDef<any>>

forceConstructor

forceConstructor: boolean

getterProps

getterProps: EntityProperty<Entity, any>[]

optionalhasTriggers

hasTriggers?: boolean

optionalhasUniqueProps

hasUniqueProps?: boolean

hooks

hooks: { afterCreate: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; afterDelete: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; afterFlush: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; afterTransactionCommit: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; afterTransactionRollback: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; afterTransactionStart: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; afterUpdate: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; afterUpsert: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; beforeCreate: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; beforeDelete: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; beforeFlush: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; beforeTransactionCommit: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; beforeTransactionRollback: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; beforeTransactionStart: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; beforeUpdate: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; beforeUpsert: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; onFlush: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; onInit: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]; onLoad: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[] }

Type declaration

• afterCreate: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• afterDelete: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• afterFlush: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• afterTransactionCommit: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• afterTransactionRollback: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• afterTransactionStart: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• afterUpdate: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• afterUpsert: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• beforeCreate: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• beforeDelete: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• beforeFlush: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• beforeTransactionCommit: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• beforeTransactionRollback: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• beforeTransactionStart: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• beforeUpdate: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• beforeUpsert: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• onFlush: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• onInit: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

• onLoad: undefined | (undefined | keyof Entity | (args) => void | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void> | (args) => void | Promise<void>)[]

hydrateProps

hydrateProps: EntityProperty<Entity, any>[]

indexes

indexes: { clustered?: boolean; columns?: IndexColumnOptions[]; disabled?: boolean; expression?: string | IndexCallback<Entity>; fillFactor?: number; include?: EntityKey<Entity, false> | EntityKey<Entity, false>[]; invisible?: boolean; name?: string; options?: Dictionary<any>; properties?: EntityKey<Entity, false> | EntityKey<Entity, false>[]; type?: string }[]

optionalinheritanceType

inheritanceType?: sti | tpt

Inheritance type: 'sti' (Single Table Inheritance) or 'tpt' (Table-Per-Type). Only set on root entities.

optionalmaterialized

materialized?: boolean

True if this is a materialized view (PostgreSQL only). Requires view: true.

optionalname

name?: string

optionalorderBy

orderBy?: QueryOrderMap<Entity> | QueryOrderMap<Entity>[]

Default ordering for this entity. Applied when querying this entity directly or when it's populated as a relation. Combined with other orderings based on precedence.

optionalownProps

ownProps?: EntityProperty<Entity, any>[]

For TPT: properties defined only in THIS entity (not inherited from parent).

path

path: string

optionalpivotTable

pivotTable?: boolean

optionalpolymorphicDiscriminatorMap

polymorphicDiscriminatorMap?: Dictionary<EntityClass<any>>

For polymorphic M:N pivot tables, maps discriminator values to entity classes

optionalpolymorphs

polymorphs?: EntityMetadata<any, EntityCtor<any>>[]

primaryKeys

primaryKeys: EntityKey<Entity, false>[]

properties

properties: { [ K in string ]: EntityProperty<Entity, any> }

readonlypropertyOrder

propertyOrder: Map<string, number> = ...

props

props: EntityProperty<Entity, any>[]

prototype

prototype: Entity

optionalreadonly

readonly?: boolean

referencingProperties

referencingProperties: { meta: EntityMetadata<Entity, EntityCtor<Entity>>; prop: EntityProperty<Entity, any> }[]

relations

relations: EntityProperty<Entity, any>[]

repository

repository: () => EntityClass<EntityRepository<any>>

Type declaration

• • (): EntityClass<EntityRepository<any>>

  • Returns EntityClass<EntityRepository<any>>

optionalrepositoryClass

repositoryClass?: string

root

root: EntityMetadata<Entity, EntityCtor<Entity>>

optionalschema

schema?: string

optionalselfReferencing

selfReferencing?: boolean

optionalserializedPrimaryKey

serializedPrimaryKey?: EntityKey<Entity, false>

simplePK

simplePK: boolean

tableName

tableName: string

optionaltptChildren

tptChildren?: EntityMetadata<any, EntityCtor<any>>[]

For TPT: direct child entities (entities that extend this one).

optionaltptDiscriminatorColumn

tptDiscriminatorColumn?: string

For TPT: virtual discriminator property name (computed at query time, not persisted).

optionaltptInverseProp

tptInverseProp?: EntityProperty<any, any>

For TPT: inverse of tptParentProp, used for joining from parent to child (parent PK → child PK).

optionaltptParent

tptParent?: EntityMetadata<any, EntityCtor<any>>

For TPT: direct parent entity metadata (the entity this one extends).

optionaltptParentProp

tptParentProp?: EntityProperty<any, any>

For TPT: synthetic property representing the join to the parent table (child PK → parent PK).

trackingProps

trackingProps: EntityProperty<Entity, any>[]

uniqueProps

uniqueProps: EntityProperty<Entity, any>[]

uniques

uniques: { columns?: IndexColumnOptions[]; deferMode?: DeferMode | immediate | deferred; disabled?: boolean; expression?: string | IndexCallback<Entity>; fillFactor?: number; include?: EntityKey<Entity, false> | EntityKey<Entity, false>[]; name?: string; options?: Dictionary<any>; properties?: EntityKey<Entity, false> | EntityKey<Entity, false>[] }[]

validateProps

validateProps: EntityProperty<Entity, any>[]

versionProperty

versionProperty: EntityKey<Entity, false>

optionalview

view?: boolean | { materialized?: boolean; withData?: boolean }

True if this entity represents a database view (not a virtual entity). Accepts { materialized: true } as input, normalized to true during sync.

optionalvirtual

virtual?: boolean

optionalwithData

withData?: boolean

For materialized views, whether data is populated on creation. Defaults to true.

Accessors

tableName

• get tableName(): string
• set tableName(name): void

• Returns string

• Parameters

  • name: string

  Returns void

uniqueName

• get uniqueName(): string

• Returns string

Methods

addProperty

• addProperty(prop): void

• Parameters

  • prop: Partial<EntityProperty<Entity, any>>

  Returns void

createColumnMappingObject

• createColumnMappingObject(alias, toStringAlias): FormulaColumns<Entity>

• Creates a mapping from property names to field names.

  ---

  Parameters

  • optionalalias: string | (prop) => string

    Optional alias to prefix field names. Can be a string (same for all) or a function (per-property). When provided, also adds toString() returning the alias for backwards compatibility with formulas.

  • optionaltoStringAlias: string

    Optional alias to return from toString(). Defaults to alias when it's a string.

  Returns FormulaColumns<Entity>

createSchemaColumnMappingObject

• createSchemaColumnMappingObject(): SchemaColumns<Entity>

• Creates a column mapping for schema callbacks (indexes, checks, generated columns). For TPT entities, only includes properties that belong to the current table (ownProps).

  ---

  Returns SchemaColumns<Entity>

getPrimaryProp

• getPrimaryProp(): EntityProperty<Entity, any>

• Returns EntityProperty<Entity, any>

getPrimaryProps

• getPrimaryProps(flatten): EntityProperty<Entity, any>[]

• Parameters

  • flatten: boolean = false

  Returns EntityProperty<Entity, any>[]

removeProperty

• removeProperty(name, sync): void

• Parameters

  • name: string

  • sync: boolean = true

  Returns void

sync

• sync(initIndexes, config): void

• Parameters

  • initIndexes: boolean = false

  • optionalconfig: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  Returns void