EntityProperty <Owner, Target>

Index

Properties

• array
• autoincrement
• cascade
• columnTypes
• comment
• concurrencyCheck
• customOrder
• customType
• customTypes
• default
• defaultRaw
• deferMode
• deleteRule
• discriminatorColumn
• eager
• embeddable
• embedded
• embeddedPath
• embeddedProps
• entity
• enum
• extra
• fieldNameRaw
• fieldNames
• fixedOrder
• fixedOrderColumn
• formula
• generated
• getter
• getterName
• groups
• hasConvertToDatabaseValueSQL
• hasConvertToJSValueSQL
• hidden
• hydrate
• ignoreSchemaChanges
• index
• inherited
• inversedBy
• inverseJoinColumns
• items
• joinColumns
• kind
• lazy
• length
• mappedBy
• mapToPk
• name
• nativeEnumName
• nullable
• object
• onCreate
• onUpdate
• optional
• orderBy
• orphanRemoval
• ownColumns
• owner
• persist
• pivotEntity
• pivotTable
• precision
• prefix
• prefixMode
• primary
• ref
• referencedColumnNames
• referencedPKs
• referencedTableName
• returning
• runtimeType
• scale
• serializedName
• serializedPrimaryKey
• serializer
• setter
• strategy
• targetMeta
• trackChanges
• type
• unique
• unsigned
• updateRule
• userDefined
• version
• where

Properties

optionalarray

array?: boolean

optionalautoincrement

autoincrement?: boolean

cascade

cascade: Cascade[]

columnTypes

columnTypes: string[]

optionalcomment

comment?: string

optionalconcurrencyCheck

concurrencyCheck?: boolean

optionalcustomOrder

customOrder?: string[] | number[] | boolean[]

optionalcustomType

customType?: Type<any, any>

customTypes

customTypes: (undefined | Type<any, any>)[]

optionaldefault

default?: null | string | number | boolean

optionaldefaultRaw

defaultRaw?: string

optionaldeferMode

deferMode?: DeferMode

optionaldeleteRule

deleteRule?: AnyString | cascade | no action | set null | set default

optionaldiscriminatorColumn

discriminatorColumn?: string

optionaleager

eager?: boolean

embeddable

embeddable: EntityClass<Owner>

optionalembedded

embedded?: [EntityKey<Owner, false>, EntityKey<Owner, false>]

optionalembeddedPath

embeddedPath?: string[]

embeddedProps

embeddedProps: Dictionary<EntityProperty<any, any>>

entity

entity: () => EntityName<Owner>

Type declaration

• • (): EntityName<Owner>

  • Returns EntityName<Owner>

optionalenum

enum?: boolean

optionalextra

extra?: string

mysql only

optionalfieldNameRaw

fieldNameRaw?: string

fieldNames

fieldNames: string[]

optionalfixedOrder

fixedOrder?: boolean

optionalfixedOrderColumn

fixedOrderColumn?: string

optionalformula

formula?: (alias: string) => string

Type declaration

• • (alias: string): string

  • Parameters

    • alias: string

    Returns string

optionalgenerated

generated?: string | GeneratedColumnCallback<Owner>

optionalgetter

getter?: boolean

optionalgetterName

getterName?: keyof Owner

optionalgroups

groups?: string[]

hasConvertToDatabaseValueSQL

hasConvertToDatabaseValueSQL: boolean

hasConvertToJSValueSQL

hasConvertToJSValueSQL: boolean

optionalhidden

hidden?: boolean

optionalhydrate

hydrate?: boolean

optionalignoreSchemaChanges

ignoreSchemaChanges?: (type | extra | default)[]

optionalindex

index?: string | boolean

optionalinherited

inherited?: boolean

inversedBy

inversedBy: EntityKey<Target, false>

inverseJoinColumns

inverseJoinColumns: string[]

optionalitems

items?: (string | number)[]

joinColumns

joinColumns: string[]

kind

kind: ReferenceKind

optionallazy

lazy?: boolean

optionallength

length?: number

mappedBy

mappedBy: EntityKey<Target, false>

optionalmapToPk

mapToPk?: boolean

name

name: EntityKey<Owner, false>

optionalnativeEnumName

nativeEnumName?: string

optionalnullable

nullable?: boolean

optionalobject

object?: boolean

optionalonCreate

onCreate?: (entity: Owner, em: EntityManager<IDatabaseDriver<Connection>>) => any

Type declaration

• • (entity: Owner, em: EntityManager<IDatabaseDriver<Connection>>): any

  • Parameters

    • entity: Owner

    • em: EntityManager<IDatabaseDriver<Connection>>

    Returns any

optionalonUpdate

onUpdate?: (entity: Owner, em: EntityManager<IDatabaseDriver<Connection>>) => any

Type declaration

• • (entity: Owner, em: EntityManager<IDatabaseDriver<Connection>>): any

  • Parameters

    • entity: Owner

    • em: EntityManager<IDatabaseDriver<Connection>>

    Returns any

optionaloptional

optional?: boolean

optionalorderBy

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

optionalorphanRemoval

orphanRemoval?: boolean

ownColumns

ownColumns: string[]

owner

owner: boolean

optionalpersist

persist?: boolean

pivotEntity

pivotEntity: string

pivotTable

pivotTable: string

optionalprecision

precision?: number

optionalprefix

prefix?: string | boolean

optionalprefixMode

prefixMode?: EmbeddedPrefixMode

optionalprimary

primary?: boolean

optionalref

ref?: boolean

referencedColumnNames

referencedColumnNames: string[]

referencedPKs

referencedPKs: EntityKey<Owner, false>[]

referencedTableName

referencedTableName: string

optionalreturning

returning?: boolean

runtimeType

runtimeType: string | number | bigint | boolean | object | AnyString | Buffer | Date | any

optionalscale

scale?: number

optionalserializedName

serializedName?: string

serializedPrimaryKey

serializedPrimaryKey: boolean

optionalserializer

serializer?: (value: any, options?: SerializeOptions<any, never, never>) => any

Type declaration

• • (value: any, options?: SerializeOptions<any, never, never>): any

  • Parameters

    • value: any

    • optionaloptions: SerializeOptions<any, never, never>

    Returns any

optionalsetter

setter?: boolean

optionalstrategy

strategy?: LoadStrategy

optionaltargetMeta

targetMeta?: EntityMetadata<Target>

optionaltrackChanges

trackChanges?: boolean

type

type: string | bigint | boolean | uuid | date | time | datetime | blob | uint8array | array | enumArray | enum | json | integer | smallint | tinyint | mediumint | float | double | decimal | character | text | interval | unknown | AnyString

optionalunique

unique?: string | boolean

optionalunsigned

unsigned?: boolean

optionalupdateRule

updateRule?: AnyString | cascade | no action | set null | set default

optionaluserDefined

userDefined?: boolean

optionalversion

version?: boolean

optionalwhere

where?: FilterQuery<Target>