Skip to main content
Version: 5.6

PrimaryKeyOptions <T>

Hierarchy

Index

Properties

Properties

optionalautoincrement

autoincrement?: boolean

optionalcheck

check?: string | CheckCallback<T>

optionalcolumnType

columnType?: AnyString | ColumnType

optionalcomment

comment?: string

optionalconcurrencyCheck

concurrencyCheck?: boolean

optionalcustomOrder

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

optionalcustomType

customType?: Type<any, any>

optionaldefault

default?: null | string | number | boolean | string[] | number[]

optionaldefaultRaw

defaultRaw?: string

optionalextra

extra?: string

mysql only

optionalfieldName

fieldName?: string

optionalfieldNames

fieldNames?: string[]

optionalformula

formula?: string | (alias: string) => string

optionalgetter

getter?: boolean

optionalhidden

hidden?: boolean

optionalignoreSchemaChanges

ignoreSchemaChanges?: (type | extra)[]

optionalindex

index?: string | boolean

optionallazy

lazy?: boolean

optionallength

length?: number

optionalname

name?: string

optionalnullable

nullable?: boolean

optionalonCreate

onCreate?: (entity: T) => any

Type declaration

    • (entity: T): any

    • Parameters

      • entity: T

      Returns any

optionalonUpdate

onUpdate?: (entity: T) => any

Type declaration

    • (entity: T): any

    • Parameters

      • entity: T

      Returns any

optionalpersist

persist?: boolean

optionalprecision

precision?: number

optionalprimary

primary?: boolean

optionalscale

scale?: number

optionalserializedName

serializedName?: string

optionalserializedPrimaryKey

serializedPrimaryKey?: boolean

optionalserializer

serializer?: (value: any) => any

Type declaration

    • (value: any): any

    • Parameters

      • value: any

      Returns any

optionalsetter

setter?: boolean

optionaltrackChanges

trackChanges?: boolean

optionaltype

type?: string | Date | array | enumArray | AnyString | Type<any, any> | Constructor<Partial<any>> | ColumnType | ObjectId | Constructor<Type<any, any>> | () => unknown

optionalunique

unique?: string | boolean

optionalunsigned

unsigned?: boolean

optionalversion

version?: boolean