HasOneOptions | @sequelize/core

Options provided when associating models with Model.hasOne relationship

Hierarchy

AssociationOptions
- HasOneOptions

Index

Properties

Optional as

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

Optional constraints

constraints?: boolean

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

Optional foreignKey

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

Optional foreignKeyConstraint

foreignKeyConstraint?: boolean

Optional hooks

hooks?: boolean

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

default: true

Optional keyType

keyType?: DataTypes.DataType

A string or a data type to represent the identifier in the table

Optional onDelete

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'

Optional onUpdate

onUpdate?: string

What happens when update occurs

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

default: 'CASCADE'

Optional scope

scope?: AssociationScope

Optional sourceKey

sourceKey?: string

The name of the field to use as the key for the association in the source table. Defaults to the primary key of the source table