Skip to main content
Version: 5.7

ManyToManyOptions <T, O>

Hierarchy

Index

Properties

Properties

optionalautoincrement

autoincrement?: boolean

Explicitly specify the auto increment of the primary key.

optionalcascade

cascade?: Cascade[]

optionalcheck

check?: string | CheckCallback<O>

Specify column with check constraints. (Postgres driver only)

@see

https://mikro-orm.io/docs/defining-entities#check-constraints

optionalcolumnType

columnType?: AnyString | ColumnType

Specify exact database column type for Generator. (SQL only)

optionalcomment

comment?: string

Specify comment of column for Generator. (SQL only)

optionalconcurrencyCheck

concurrencyCheck?: boolean

Set to true to enable Locking via concurrency fields.

optionalcustomOrder

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

Specify a custom order based on the values. (SQL only)

optionalcustomType

customType?: Type<any, any>

Explicitly specify the mapped type instance for this property.

@see

https://mikro-orm.io/docs/custom-types

optionaldefault

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

Specify default column value for Generator. This is a runtime value, assignable to the entity property. (SQL only)

optionaldefaultRaw

defaultRaw?: string

Specify SQL functions for Generator. (SQL only) Since v4 you should use defaultRaw for SQL functions. e.g. now()

optionaleager

eager?: boolean

optionalentity

entity?: string | () => EntityName<T>

optionalextra

extra?: string

mysql only

optionalfieldName

fieldName?: string

Specify database column name for this property.

@see

https://mikro-orm.io/docs/naming-strategy

optionalfieldNames

fieldNames?: string[]

Specify database column names for this property. Same as fieldName but for composite FKs.

@see

https://mikro-orm.io/docs/naming-strategy

optionalfixedOrder

fixedOrder?: boolean

optionalfixedOrderColumn

fixedOrderColumn?: string

optionalformula

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

Set to map some SQL snippet for the entity.

@see

https://mikro-orm.io/docs/defining-entities#formulas Formulas}

optionalgetter

getter?: boolean

Set true to define the properties as getter. (virtual)

@example
@Property({ getter: true })
get fullName() {
  return this.firstName + this.lastName;
}

optionalhidden

hidden?: boolean

Set to true to omit the property when Serializing.

optionalhydrate

hydrate?: boolean

Set false to disable hydration of this property. Useful for persisted getters.

optionalignoreSchemaChanges

ignoreSchemaChanges?: (type | extra)[]

Set to avoid a perpetual diff from the Generator when columns are generated.

@see

https://mikro-orm.io/docs/defining-entities#sql-generated-columns

optionalindex

index?: string | boolean

Explicitly specify index on a property.

optionalinverseJoinColumn

inverseJoinColumn?: string

optionalinverseJoinColumns

inverseJoinColumns?: string[]

optionalinversedBy

inversedBy?: (string & keyof T) | (e: T) => any

optionaljoinColumn

joinColumn?: string

optionaljoinColumns

joinColumns?: string[]

optionallazy

lazy?: boolean

Set to omit the property from the select clause for lazy loading.

@see

https://mikro-orm.io/docs/defining-entities#lazy-scalar-properties

optionallength

length?: number

Set length of database column, used for datetime/timestamp/varchar column types for Generator. (SQL only)

optionalmappedBy

mappedBy?: (string & keyof T) | (e: T) => any

optionalname

name?: string

Alias for fieldName.

optionalnullable

nullable?: boolean

Set column as nullable for Generator.

optionalonCreate

onCreate?: (entity: O) => any

Type declaration

    • (entity: O): any

    • Automatically set the property value when entity gets created, executed during flush operation.

      Parameters

      • entity: O

      Returns any

optionalonUpdate

onUpdate?: (entity: O) => any

Type declaration

    • (entity: O): any

    • Automatically update the property value every time entity gets updated, executed during flush operation.

      Parameters

      • entity: O

      Returns any

optionalorderBy

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

optionalowner

owner?: boolean

optionalpersist

persist?: boolean

Set false to define Property.

optionalpivotEntity

pivotEntity?: string | () => EntityName<any>

optionalpivotTable

pivotTable?: string

optionalprecision

precision?: number

Set precision of database column to represent the number of significant digits. (SQL only)

optionalprimary

primary?: boolean

Set true to define entity’s unique primary key identifier. Alias for @PrimaryKey() decorator

@see

https://mikro-orm.io/docs/decorators#primarykey

optionalreferenceColumnName

referenceColumnName?: string

optionalreferencedColumnNames

referencedColumnNames?: string[]

optionalscale

scale?: number

Set scale of database column to represents the number of digits after the decimal point. (SQL only)

optionalserializedName

serializedName?: string

Specify name of key for the serialized value.

optionalserializedPrimaryKey

serializedPrimaryKey?: boolean

Set to define serialized primary key for MongoDB. (virtual) Alias for @SerializedPrimaryKey() decorator.

@see

https://mikro-orm.io/docs/decorators#serializedprimarykey

optionalserializer

serializer?: (value: any) => any

Type declaration

optionalsetter

setter?: boolean

Set true to define the properties as setter. (virtual)

@example
@Property({ setter: true })
set address(value: string) {
    this._address = value.toLocaleLowerCase();
}

optionalstrategy

strategy?: LoadStrategy

optionaltrackChanges

trackChanges?: boolean

Set false to disable change tracking on a property level.

@see

https://mikro-orm.io/docs/unit-of-work#change-tracking-and-performance-considerations

optionaltype

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

Explicitly specify the runtime type.

@see

optionalunique

unique?: string | boolean

Set column as unique for Generator. (SQL only)

optionalunsigned

unsigned?: boolean

Set column as unsigned for Generator. (SQL only)

optionalversion

version?: boolean

Set to true to enable Locking via version field. (SQL only)