Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AssociationOptions

Options provided when associating models

Hierarchy

Index

Properties

as?: string | { plural: string; singular: string }

The alias of this model, in singular form. See also the name option passed to sequelize.define. If you create multiple associations between the same tables, you should provide an alias to be able to distinguish between them. If you provide an alias when creating the assocition, you should provide the same alias when eager loading and when getting associated models. Defaults to the singularized name of target

constraints?: boolean

Should on update and on delete constraints be enabled on the foreign key.

foreignKey?: string | ForeignKeyOptions

The name of the foreign key in the target table or an object representing the type definition for the foreign column (see Sequelize.define for syntax). When using an object, you can add a name property to set the name of the column. Defaults to the name of source + primary key of source

foreignKeyConstraint?: boolean
hooks?: boolean

If false the applicable hooks will not be called. The default value depends on the context.

default

true

onDelete?: string

What happens when delete occurs.

Cascade if this is a n:m, and set null if it is a 1:m

One of RESTRICT, CASCADE, NO ACTION, SET DEFAULT, or SET NULL

default

'SET NULL' or 'CASCADE'

onUpdate?: string

What happens when update occurs

One of RESTRICT, CASCADE, NO ACTION, SET DEFAULT, or SET NULL

default

'CASCADE'

Generated using TypeDoc