Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrderInstance

Hierarchy

Index

Constructors

constructor

  • new OrderInstance(values?: TCreationAttributes, options?: BuildOptions): OrderInstance
  • Builds a new model instance.

    Parameters

    • Optional values: TCreationAttributes

      an object of key value pairs

    • Optional options: BuildOptions

    Returns OrderInstance

Properties

_attributes

_attributes: OrderAttributes

A dummy variable that doesn't exist on the real object. This exists so Typescript can infer the type of the attributes in static functions. Don't try to access this!

Before using these, I'd tried typing out the functions without them, but Typescript fails to infer TAttributes in signatures like the below.

public static findOne<M extends Model<TAttributes>, TAttributes>(
  this: { new(): M },
  options: NonNullFindOptions<TAttributes>
): Promise<M>;

_creationAttributes

_creationAttributes: OrderCreationAttributes

A similar dummy variable that doesn't exist on the real object. Do not try to access this in real code.

_model

A dummy variable that doesn't exist on the real object. This exists so Typescript can infer the type of the attributes in static functions. Don't try to access this!

isNewRecord

isNewRecord: boolean

Returns true if this instance has not yet been persisted to the database

Optional localId

localId: undefined | string

Optional nodeId

nodeId: undefined | number

The internal db node id of the peer that created this order.

Optional price

price: undefined | number

The price for the order expressed in units of the quote currency.

sequelize

sequelize: Sequelize

A reference to the sequelize instance

Static Readonly associations

associations: {}

An object hash from alias to association object

Type declaration

  • [key: string]: Association

Static Readonly options

options: InitOptions

The options that the model was initialized with

Static Readonly primaryKeyAttribute

primaryKeyAttribute: string

The name of the primary key attribute

Static Readonly primaryKeyAttributes

primaryKeyAttributes: string[]

The name of the primary key attributes

Static Readonly rawAttributes

rawAttributes: {}

The attributes of the model

Type declaration

  • [attribute: string]: ModelAttributeColumnOptions

Static Optional Readonly sequelize

sequelize: Sequelize

Reference to the sequelize instance the model was initialized with

Static Readonly tableName

tableName: string

The name of the database table

Methods

addHook

  • addHook<K>(hookType: K, name: string, fn: SequelizeHooks<Model, OrderAttributes, OrderCreationAttributes>[K]): this
  • addHook<K>(hookType: K, fn: SequelizeHooks<Model<OrderAttributes, OrderCreationAttributes>, OrderAttributes, OrderCreationAttributes>[K]): this

changed

  • changed<K>(key: K): boolean
  • changed<K>(key: K, dirty: boolean): void
  • changed(): false | string[]
  • If changed is called with a string it will return a boolean indicating whether the value of that key in dataValues is different from the value in _previousDataValues.

    If changed is called without an argument, it will return an array of keys that have changed.

    If changed is called with two arguments, it will set the property to dirty.

    If changed is called without an argument and no keys have changed, it will return false.

    Type parameters

    • K: keyof this

    Parameters

    • key: K

    Returns boolean

  • Type parameters

    • K: keyof this

    Parameters

    • key: K
    • dirty: boolean

    Returns void

  • Returns false | string[]

decrement

  • Decrement the value of one or more columns. This is done in the database, which means it does not use the values currently stored on the Instance. The decrement is done using a

    SET column = column - X

    query. To get the correct value after an decrement into the Instance you should do a reload.

    instance.decrement('number') // decrement number by 1
    instance.decrement(['number', 'count'], { by: 2 }) // decrement number and count by 2
    instance.decrement({ answer: 42, tries: 1}, { by: 2 }) // decrement answer by 42, and tries by 1.
                                                           // `by` is ignored, since each column has its own
                                                           // value

    Type parameters

    Parameters

    • fields: K | K[] | Partial<OrderAttributes>

      If a string is provided, that column is decremented by the value of by given in options. If an array is provided, the same is true for each column. If and object is provided, each column is decremented by the value given

    • Optional options: IncrementDecrementOptionsWithBy<OrderAttributes>

    Returns Promise<this>

destroy

  • destroy(options?: InstanceDestroyOptions): Promise<void>
  • Destroy the row corresponding to this instance. Depending on your setting for paranoid, the row will either be completely deleted, or have its deletedAt timestamp set to the current time.

    Parameters

    • Optional options: InstanceDestroyOptions

    Returns Promise<void>

equals

  • equals(other: this): boolean
  • Check whether all values of this and other Instance are the same

    Parameters

    • other: this

    Returns boolean

equalsOneOf

  • equalsOneOf(others: this[]): boolean
  • Check if this is eqaul to one of others by calling equals

    Parameters

    • others: this[]

    Returns boolean

get

  • get(options?: undefined | { clone?: undefined | false | true; plain?: undefined | false | true }): OrderAttributes
  • get<K>(key: K, options?: undefined | { clone?: undefined | false | true; plain?: undefined | false | true }): this[K]
  • get(key: string, options?: undefined | { clone?: undefined | false | true; plain?: undefined | false | true }): unknown
  • If no key is given, returns all values of the instance, also invoking virtual getters.

    If key is given and a field or virtual getter is present for the key it will call that getter - else it will return the value for key.

    Parameters

    • Optional options: undefined | { clone?: undefined | false | true; plain?: undefined | false | true }

    Returns OrderAttributes

  • Type parameters

    • K: keyof this

    Parameters

    • key: K
    • Optional options: undefined | { clone?: undefined | false | true; plain?: undefined | false | true }

    Returns this[K]

  • Parameters

    • key: string
    • Optional options: undefined | { clone?: undefined | false | true; plain?: undefined | false | true }

    Returns unknown

getDataValue

  • getDataValue<K>(key: K): OrderAttributes[K]
  • Get the value of the underlying data value

    Type parameters

    Parameters

    • key: K

    Returns OrderAttributes[K]

hasHook

  • hasHook<K>(hookType: K): boolean

hasHooks

  • hasHooks<K>(hookType: K): boolean

increment

  • Increment the value of one or more columns. This is done in the database, which means it does not use the values currently stored on the Instance. The increment is done using a

    SET column = column + X

    query. To get the correct value after an increment into the Instance you should do a reload.

    instance.increment('number') // increment number by 1
    instance.increment(['number', 'count'], { by: 2 }) // increment number and count by 2
    instance.increment({ answer: 42, tries: 1}, { by: 2 }) // increment answer by 42, and tries by 1.
                                                           // `by` is ignored, since each column has its own
                                                           // value

    Type parameters

    Parameters

    • fields: K | K[] | Partial<OrderAttributes>

      If a string is provided, that column is incremented by the value of by given in options. If an array is provided, the same is true for each column. If and object is provided, each column is incremented by the value given.

    • Optional options: IncrementDecrementOptionsWithBy<OrderAttributes>

    Returns Promise<this>

isSoftDeleted

  • isSoftDeleted(): boolean
  • Helper method to determine if a instance is "soft deleted". This is particularly useful if the implementer renamed the deletedAt attribute to something different. This method requires paranoid to be enabled.

    Throws an error if paranoid is not enabled.

    Returns boolean

previous

  • previous<K>(key: K): this[K]
  • Returns the previous value for key from _previousDataValues.

    Type parameters

    • K: keyof this

    Parameters

    • key: K

    Returns this[K]

reload

  • Refresh the current instance in-place, i.e. update the object with current data from the DB and return the same object. This is different from doing a find(Instance.id), because that would create and return a new instance. With this method, all references to the Instance are updated with the new data and no new objects are created.

    Parameters

    Returns Promise<this>

removeHook

  • removeHook<K>(hookType: K, name: string): this

restore

  • restore(options?: InstanceRestoreOptions): Promise<void>
  • Restore the row corresponding to this instance. Only available for paranoid models.

    Parameters

    • Optional options: InstanceRestoreOptions

    Returns Promise<void>

save

  • Validates this instance, and if the validation passes, persists it to the database.

    Returns a Promise that resolves to the saved instance (or rejects with a Sequelize.ValidationError, which will have a property for each of the fields for which the validation failed, with the error message for that field).

    This method is optimized to perform an UPDATE only into the fields that changed. If nothing has changed, no SQL query will be performed.

    This method is not aware of eager loaded associations. In other words, if some other model instance (child) was eager loaded with this instance (parent), and you change something in the child, calling save() will simply ignore the change that happened on the child.

    Parameters

    Returns Promise<this>

set

  • set<K>(key: K, value: OrderAttributes[K], options?: SetOptions): this
  • set(keys: Partial<OrderAttributes>, options?: SetOptions): this
  • Set is used to update values on the instance (the sequelize representation of the instance that is, remember that nothing will be persisted before you actually call save). In its most basic form set will update a value stored in the underlying dataValues object. However, if a custom setter function is defined for the key, that function will be called instead. To bypass the setter, you can pass raw: true in the options object.

    If set is called with an object, it will loop over the object, and call set recursively for each key, value pair. If you set raw to true, the underlying dataValues will either be set directly to the object passed, or used to extend dataValues, if dataValues already contain values.

    When set is called, the previous value of the field is stored and sets a changed flag(see changed).

    Set can also be used to build instances for associations, if you have values for those. When using set with associations you need to make sure the property key matches the alias of the association while also making sure that the proper include options have been set (from .build() or .findOne())

    If called with a dot.seperated key on a JSON/JSONB attribute it will set the value nested and flag the entire object as changed.

    Type parameters

    Parameters

    • key: K
    • value: OrderAttributes[K]
    • Optional options: SetOptions

    Returns this

  • Parameters

    Returns this

setAttributes

  • setAttributes<K>(key: K, value: OrderAttributes[K], options?: SetOptions): this
  • setAttributes(keys: Partial<OrderAttributes>, options?: SetOptions): this

setDataValue

  • setDataValue<K>(key: K, value: OrderAttributes[K]): void
  • Update the underlying data value

    Type parameters

    Parameters

    • key: K
    • value: OrderAttributes[K]

    Returns void

toJSON

  • toJSON(): object
  • Convert the instance to a JSON representation. Proxies to calling get with no keys. This means get all values gotten from the DB, and apply all custom getters.

    Returns object

update

  • update<K>(key: K, value: this[K], options?: InstanceUpdateOptions<OrderAttributes>): Promise<this>
  • update(keys: object, options?: InstanceUpdateOptions<OrderAttributes>): Promise<this>
  • This is the same as calling set and then calling save.

    Type parameters

    • K: keyof this

    Parameters

    • key: K
    • value: this[K]
    • Optional options: InstanceUpdateOptions<OrderAttributes>

    Returns Promise<this>

  • Parameters

    Returns Promise<this>

validate

  • validate(options?: ValidationOptions): Promise<void>
  • Validate the attribute of this instance according to validation rules set in the model definition.

    Emits null if and only if validation successful; otherwise an Error instance containing { field name : [error msgs] } entries.

    Parameters

    • Optional options: ValidationOptions

    Returns Promise<void>

where

  • where(): object
  • Get an object representing the query for this instance, use with options.where

    Returns object

Static addHook

  • addHook<H, K>(this: HooksStatic<H>, hookType: K, name: string, fn: SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>[K]): HooksCtor<H>
  • addHook<H, K>(this: HooksStatic<H>, hookType: K, fn: SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>[K]): HooksCtor<H>
  • Add a hook to the model

    Type parameters

    • H: Hooks

    • K: keyof SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>

    Parameters

    • this: HooksStatic<H>
    • hookType: K
    • name: string

      Provide a name for the hook function. It can be used to remove the hook later or to order hooks based on some sort of priority system in the future.

    • fn: SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>[K]

    Returns HooksCtor<H>

  • Type parameters

    • H: Hooks

    • K: keyof SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>

    Parameters

    • this: HooksStatic<H>
    • hookType: K
    • fn: SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>[K]

    Returns HooksCtor<H>

Static addScope

  • addScope<M>(this: ModelStatic<M>, name: string, scope: FindOptions<M["_attributes"]>, options?: AddScopeOptions): void
  • addScope<M>(this: ModelStatic<M>, name: string, scope: (...args: any[]) => FindOptions<M["_attributes"]>, options?: AddScopeOptions): void
  • Add a new scope to the model

    This is especially useful for adding scopes with includes, when the model you want to include is not available at the time this model is defined. By default this will throw an error if a scope with that name already exists. Pass override: true in the options object to silence this error.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • scope: FindOptions<M["_attributes"]>
    • Optional options: AddScopeOptions

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • scope: (...args: any[]) => FindOptions<M["_attributes"]>
        • (...args: any[]): FindOptions<M["_attributes"]>
        • Parameters

          • Rest ...args: any[]

          Returns FindOptions<M["_attributes"]>

    • Optional options: AddScopeOptions

    Returns void

Static afterBulkCreate

  • afterBulkCreate<M>(this: ModelStatic<M>, name: string, fn: (instances: M[], options: BulkCreateOptions<M["_attributes"]>) => HookReturn): void
  • afterBulkCreate<M>(this: ModelStatic<M>, fn: (instances: M[], options: BulkCreateOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run after creating instances in bulk

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instances: M[], options: BulkCreateOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with instances, options

        • (instances: M[], options: BulkCreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instances: M[]
          • options: BulkCreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instances: M[], options: BulkCreateOptions<M["_attributes"]>) => HookReturn
        • (instances: M[], options: BulkCreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instances: M[]
          • options: BulkCreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static afterBulkDestroy

  • afterBulkDestroy<M>(this: ModelStatic<M>, name: string, fn: (options: DestroyOptions<M["_attributes"]>) => HookReturn): void
  • afterBulkDestroy<M>(this: ModelStatic<M>, fn: (options: DestroyOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run after destroying instances in bulk

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (options: DestroyOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with options

        • (options: DestroyOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: DestroyOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (options: DestroyOptions<M["_attributes"]>) => HookReturn
        • (options: DestroyOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: DestroyOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static afterBulkSync

  • afterBulkSync(name: string, fn: (options: SyncOptions) => HookReturn): void
  • afterBulkSync(fn: (options: SyncOptions) => HookReturn): void
  • A hook that is run after sequelize.sync call

    Parameters

    • name: string
    • fn: (options: SyncOptions) => HookReturn

      A callback function that is called with options passed to sequelize.sync

        • (options: SyncOptions): HookReturn
        • Parameters

          • options: SyncOptions

          Returns HookReturn

    Returns void

  • Parameters

    • fn: (options: SyncOptions) => HookReturn
        • (options: SyncOptions): HookReturn
        • Parameters

          • options: SyncOptions

          Returns HookReturn

    Returns void

Static afterBulkUpdate

  • afterBulkUpdate<M>(this: ModelStatic<M>, name: string, fn: (options: UpdateOptions<M["_attributes"]>) => HookReturn): void
  • afterBulkUpdate<M>(this: ModelStatic<M>, fn: (options: UpdateOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run after updating instances in bulk

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (options: UpdateOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with options

        • (options: UpdateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: UpdateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (options: UpdateOptions<M["_attributes"]>) => HookReturn
        • (options: UpdateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: UpdateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static afterCreate

  • afterCreate<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: CreateOptions<M["_attributes"]>) => HookReturn): void
  • afterCreate<M>(this: ModelStatic<M>, fn: (instance: M, options: CreateOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run after creating a single instance

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: CreateOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with attributes, options

        • (instance: M, options: CreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: CreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: CreateOptions<M["_attributes"]>) => HookReturn
        • (instance: M, options: CreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: CreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static afterDestroy

  • afterDestroy<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: InstanceDestroyOptions) => HookReturn): void
  • afterDestroy<M>(this: ModelStatic<M>, fn: (instance: M, options: InstanceDestroyOptions) => HookReturn): void
  • A hook that is run after destroying a single instance

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: InstanceDestroyOptions) => HookReturn

      A callback function that is called with instance, options

        • (instance: M, options: InstanceDestroyOptions): HookReturn
        • Parameters

          • instance: M
          • options: InstanceDestroyOptions

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: InstanceDestroyOptions) => HookReturn
        • (instance: M, options: InstanceDestroyOptions): HookReturn
        • Parameters

          • instance: M
          • options: InstanceDestroyOptions

          Returns HookReturn

    Returns void

Static afterFind

  • afterFind<M>(this: ModelStatic<M>, name: string, fn: (instancesOrInstance: M[] | M | null, options: FindOptions<M["_attributes"]>) => HookReturn): void
  • afterFind<M>(this: ModelStatic<M>, fn: (instancesOrInstance: M[] | M | null, options: FindOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run after a find (select) query

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instancesOrInstance: M[] | M | null, options: FindOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with instance(s), options

        • (instancesOrInstance: M[] | M | null, options: FindOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instancesOrInstance: M[] | M | null
          • options: FindOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instancesOrInstance: M[] | M | null, options: FindOptions<M["_attributes"]>) => HookReturn
        • (instancesOrInstance: M[] | M | null, options: FindOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instancesOrInstance: M[] | M | null
          • options: FindOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static afterSave

  • afterSave<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>) => HookReturn): void
  • afterSave<M>(this: ModelStatic<M>, fn: (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run after creating or updating a single instance, It proxies afterCreate and afterUpdate

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with instance, options

        • (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>) => HookReturn
        • (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static afterSync

  • afterSync(name: string, fn: (options: SyncOptions) => HookReturn): void
  • afterSync(fn: (options: SyncOptions) => HookReturn): void
  • A hook that is run after Model.sync call

    Parameters

    • name: string
    • fn: (options: SyncOptions) => HookReturn

      A callback function that is called with options passed to Model.sync

        • (options: SyncOptions): HookReturn
        • Parameters

          • options: SyncOptions

          Returns HookReturn

    Returns void

  • Parameters

    • fn: (options: SyncOptions) => HookReturn
        • (options: SyncOptions): HookReturn
        • Parameters

          • options: SyncOptions

          Returns HookReturn

    Returns void

Static afterUpdate

  • afterUpdate<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: UpdateOptions<M["_attributes"]>) => HookReturn): void
  • afterUpdate<M>(this: ModelStatic<M>, fn: (instance: M, options: UpdateOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run after updating a single instance

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: UpdateOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with instance, options

        • (instance: M, options: UpdateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: UpdateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: UpdateOptions<M["_attributes"]>) => HookReturn
        • (instance: M, options: UpdateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: UpdateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static afterValidate

  • afterValidate<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: ValidationOptions) => HookReturn): void
  • afterValidate<M>(this: ModelStatic<M>, fn: (instance: M, options: ValidationOptions) => HookReturn): void
  • A hook that is run after validation

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: ValidationOptions) => HookReturn

      A callback function that is called with instance, options

        • (instance: M, options: ValidationOptions): HookReturn
        • Parameters

          • instance: M
          • options: ValidationOptions

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: ValidationOptions) => HookReturn
        • (instance: M, options: ValidationOptions): HookReturn
        • Parameters

          • instance: M
          • options: ValidationOptions

          Returns HookReturn

    Returns void

Static aggregate

  • aggregate<T, M>(this: ModelStatic<M>, field: keyof M["_attributes"] | "*", aggregateFunction: string, options?: AggregateOptions<T, M["_attributes"]>): Promise<T>
  • Run an aggregation method on the specified field

    Type parameters

    • T

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • field: keyof M["_attributes"] | "*"

      The field to aggregate over. Can be a field name or *

    • aggregateFunction: string

      The function to use for aggregation, e.g. sum, max etc.

    • Optional options: AggregateOptions<T, M["_attributes"]>

      Query options. See sequelize.query for full options

    Returns Promise<T>

    Returns the aggregate result cast to options.dataType, unless options.plain is false, in which case the complete data result is returned.

Static beforeBulkCreate

  • beforeBulkCreate<M>(this: ModelStatic<M>, name: string, fn: (instances: M[], options: BulkCreateOptions<M["_attributes"]>) => HookReturn): void
  • beforeBulkCreate<M>(this: ModelStatic<M>, fn: (instances: M[], options: BulkCreateOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run before creating instances in bulk

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instances: M[], options: BulkCreateOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with instances, options

        • (instances: M[], options: BulkCreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instances: M[]
          • options: BulkCreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instances: M[], options: BulkCreateOptions<M["_attributes"]>) => HookReturn
        • (instances: M[], options: BulkCreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instances: M[]
          • options: BulkCreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static beforeBulkDestroy

  • beforeBulkDestroy<M>(this: ModelStatic<M>, name: string, fn: (options: BulkCreateOptions<M["_attributes"]>) => HookReturn): void
  • beforeBulkDestroy<M>(this: ModelStatic<M>, fn: (options: BulkCreateOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run before destroying instances in bulk

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (options: BulkCreateOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with options

        • (options: BulkCreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: BulkCreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (options: BulkCreateOptions<M["_attributes"]>) => HookReturn
        • (options: BulkCreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: BulkCreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static beforeBulkSync

  • beforeBulkSync(name: string, fn: (options: SyncOptions) => HookReturn): void
  • beforeBulkSync(fn: (options: SyncOptions) => HookReturn): void
  • A hook that is run before sequelize.sync call

    Parameters

    • name: string
    • fn: (options: SyncOptions) => HookReturn

      A callback function that is called with options passed to sequelize.sync

        • (options: SyncOptions): HookReturn
        • Parameters

          • options: SyncOptions

          Returns HookReturn

    Returns void

  • Parameters

    • fn: (options: SyncOptions) => HookReturn
        • (options: SyncOptions): HookReturn
        • Parameters

          • options: SyncOptions

          Returns HookReturn

    Returns void

Static beforeBulkUpdate

  • beforeBulkUpdate<M>(this: ModelStatic<M>, name: string, fn: (options: UpdateOptions<M["_attributes"]>) => HookReturn): void
  • beforeBulkUpdate<M>(this: ModelStatic<M>, fn: (options: UpdateOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run after updating instances in bulk

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (options: UpdateOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with options

        • (options: UpdateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: UpdateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (options: UpdateOptions<M["_attributes"]>) => HookReturn
        • (options: UpdateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: UpdateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static beforeCount

  • beforeCount<M>(this: ModelStatic<M>, name: string, fn: (options: CountOptions<M["_attributes"]>) => HookReturn): void
  • beforeCount<M>(this: ModelStatic<M>, fn: (options: CountOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run before a count query

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (options: CountOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with options

        • (options: CountOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: CountOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (options: CountOptions<M["_attributes"]>) => HookReturn
        • (options: CountOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: CountOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static beforeCreate

  • beforeCreate<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: CreateOptions<M["_attributes"]>) => HookReturn): void
  • beforeCreate<M>(this: ModelStatic<M>, fn: (instance: M, options: CreateOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run before creating a single instance

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: CreateOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with attributes, options

        • (instance: M, options: CreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: CreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: CreateOptions<M["_attributes"]>) => HookReturn
        • (instance: M, options: CreateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: CreateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static beforeDestroy

  • beforeDestroy<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: InstanceDestroyOptions) => HookReturn): void
  • beforeDestroy<M>(this: ModelStatic<M>, fn: (instance: M, options: InstanceDestroyOptions) => HookReturn): void
  • A hook that is run before destroying a single instance

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: InstanceDestroyOptions) => HookReturn

      A callback function that is called with instance, options

        • (instance: M, options: InstanceDestroyOptions): HookReturn
        • Parameters

          • instance: M
          • options: InstanceDestroyOptions

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: InstanceDestroyOptions) => HookReturn
        • (instance: M, options: InstanceDestroyOptions): HookReturn
        • Parameters

          • instance: M
          • options: InstanceDestroyOptions

          Returns HookReturn

    Returns void

Static beforeFind

  • beforeFind<M>(this: ModelStatic<M>, name: string, fn: (options: FindOptions<M["_attributes"]>) => HookReturn): void
  • beforeFind<M>(this: ModelStatic<M>, fn: (options: FindOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run before a find (select) query

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (options: FindOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with options

        • (options: FindOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: FindOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (options: FindOptions<M["_attributes"]>) => HookReturn
        • (options: FindOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: FindOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static beforeFindAfterExpandIncludeAll

  • beforeFindAfterExpandIncludeAll<M>(this: ModelStatic<M>, name: string, fn: (options: FindOptions<M["_attributes"]>) => HookReturn): void
  • beforeFindAfterExpandIncludeAll<M>(this: ModelStatic<M>, fn: (options: FindOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run before a find (select) query, after any { include: {all: ...} } options are expanded

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (options: FindOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with options

        • (options: FindOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: FindOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (options: FindOptions<M["_attributes"]>) => HookReturn
        • (options: FindOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: FindOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static beforeFindAfterOptions

  • beforeFindAfterOptions<M>(this: ModelStatic<M>, name: string, fn: (options: FindOptions<M["_attributes"]>) => HookReturn): void
  • beforeFindAfterOptions<M>(this: ModelStatic<M>, fn: (options: FindOptions<M["_attributes"]>) => void): HookReturn
  • A hook that is run before a find (select) query, after all option parsing is complete

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (options: FindOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with options

        • (options: FindOptions<M["_attributes"]>): HookReturn
        • Parameters

          • options: FindOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (options: FindOptions<M["_attributes"]>) => void
        • (options: FindOptions<M["_attributes"]>): void
        • Parameters

          • options: FindOptions<M["_attributes"]>

          Returns void

    Returns HookReturn

Static beforeSave

  • beforeSave<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>) => HookReturn): void
  • beforeSave<M>(this: ModelStatic<M>, fn: (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run before creating or updating a single instance, It proxies beforeCreate and beforeUpdate

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with instance, options

        • (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>) => HookReturn
        • (instance: M, options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: UpdateOptions<M["_attributes"]> | SaveOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static beforeSync

  • beforeSync(name: string, fn: (options: SyncOptions) => HookReturn): void
  • beforeSync(fn: (options: SyncOptions) => HookReturn): void
  • A hook that is run before Model.sync call

    Parameters

    • name: string
    • fn: (options: SyncOptions) => HookReturn

      A callback function that is called with options passed to Model.sync

        • (options: SyncOptions): HookReturn
        • Parameters

          • options: SyncOptions

          Returns HookReturn

    Returns void

  • Parameters

    • fn: (options: SyncOptions) => HookReturn
        • (options: SyncOptions): HookReturn
        • Parameters

          • options: SyncOptions

          Returns HookReturn

    Returns void

Static beforeUpdate

  • beforeUpdate<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: UpdateOptions<M["_attributes"]>) => HookReturn): void
  • beforeUpdate<M>(this: ModelStatic<M>, fn: (instance: M, options: UpdateOptions<M["_attributes"]>) => HookReturn): void
  • A hook that is run before updating a single instance

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: UpdateOptions<M["_attributes"]>) => HookReturn

      A callback function that is called with instance, options

        • (instance: M, options: UpdateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: UpdateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: UpdateOptions<M["_attributes"]>) => HookReturn
        • (instance: M, options: UpdateOptions<M["_attributes"]>): HookReturn
        • Parameters

          • instance: M
          • options: UpdateOptions<M["_attributes"]>

          Returns HookReturn

    Returns void

Static beforeValidate

  • beforeValidate<M>(this: ModelStatic<M>, name: string, fn: (instance: M, options: ValidationOptions) => HookReturn): void
  • beforeValidate<M>(this: ModelStatic<M>, fn: (instance: M, options: ValidationOptions) => HookReturn): void
  • A hook that is run before validation

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • name: string
    • fn: (instance: M, options: ValidationOptions) => HookReturn

      A callback function that is called with instance, options

        • (instance: M, options: ValidationOptions): HookReturn
        • Parameters

          • instance: M
          • options: ValidationOptions

          Returns HookReturn

    Returns void

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fn: (instance: M, options: ValidationOptions) => HookReturn
        • (instance: M, options: ValidationOptions): HookReturn
        • Parameters

          • instance: M
          • options: ValidationOptions

          Returns HookReturn

    Returns void

Static belongsTo

  • belongsTo<M, T>(this: ModelStatic<M>, target: ModelStatic<T>, options?: BelongsToOptions): BelongsTo<M, T>
  • Creates an association between this (the source) and the provided target. The foreign key is added on the source.

    Example: Profile.belongsTo(User). This will add userId to the profile table.

    Type parameters

    • M: Model

    • T: Model

    Parameters

    • this: ModelStatic<M>
    • target: ModelStatic<T>

      The model that will be associated with hasOne relationship

    • Optional options: BelongsToOptions

      Options for the association

    Returns BelongsTo<M, T>

Static belongsToMany

  • belongsToMany<M, T>(this: ModelStatic<M>, target: ModelStatic<T>, options: BelongsToManyOptions): BelongsToMany<M, T>
  • Create an N:M association with a join table

    User.belongsToMany(Project)
    Project.belongsToMany(User)

    By default, the name of the join table will be source+target, so in this case projectsusers. This can be overridden by providing either a string or a Model as through in the options.

    If you use a through model with custom attributes, these attributes can be set when adding / setting new associations in two ways. Consider users and projects from before with a join table that stores whether the project has been started yet:

    class UserProjects extends Model {}
    UserProjects.init({
      started: Sequelize.BOOLEAN
    }, { sequelize });
    User.belongsToMany(Project, { through: UserProjects })
    Project.belongsToMany(User, { through: UserProjects })
    jan.addProject(homework, { started: false }) // The homework project is not started yet
    jan.setProjects([makedinner, doshopping], { started: true}) // Both shopping and dinner has been started

    If you want to set several target instances, but with different attributes you have to set the attributes on the instance, using a property with the name of the through model:

    p1.userprojects {
      started: true
    }
    user.setProjects([p1, p2], {started: false}) // The default value is false, but p1 overrides that.

    Similarily, when fetching through a join table with custom attributes, these attributes will be available as an object with the name of the through model.

    user.getProjects().then(projects => {
      const p1 = projects[0]
      p1.userprojects.started // Is this project started yet?
    })

    Type parameters

    • M: Model

    • T: Model

    Parameters

    • this: ModelStatic<M>
    • target: ModelStatic<T>

      The model that will be associated with hasOne relationship

    • options: BelongsToManyOptions

      Options for the association

    Returns BelongsToMany<M, T>

Static build

  • build<M>(this: ModelStatic<M>, record?: M["_creationAttributes"], options?: BuildOptions): M
  • Builds a new model instance. Values is an object of key value pairs, must be defined but can be empty.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional record: M["_creationAttributes"]
    • Optional options: BuildOptions

    Returns M

Static bulkBuild

  • bulkBuild<M>(this: ModelStatic<M>, records: M["_creationAttributes"][], options?: BuildOptions): M[]
  • Undocumented bulkBuild

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • records: M["_creationAttributes"][]
    • Optional options: BuildOptions

    Returns M[]

Static bulkCreate

  • bulkCreate<M>(this: ModelStatic<M>, records: M["_creationAttributes"][], options?: BulkCreateOptions<M["_attributes"]>): Promise<M[]>
  • Create and insert multiple instances in bulk.

    The success handler is passed an array of instances, but please notice that these may not completely represent the state of the rows in the DB. This is because MySQL and SQLite do not make it easy to obtain back automatically generated IDs and other default values in a way that can be mapped to multiple records. To obtain Instances for the newly created values, you will need to query for them again.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • records: M["_creationAttributes"][]

      List of objects (key/value pairs) to create instances from

    • Optional options: BulkCreateOptions<M["_attributes"]>

    Returns Promise<M[]>

Static count

  • count<M>(this: ModelStatic<M>, options: CountWithOptions<M["_attributes"]>): Promise<{}>
  • count<M>(this: ModelStatic<M>, options?: CountOptions<M["_attributes"]>): Promise<number>
  • Count number of records if group by is used

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • options: CountWithOptions<M["_attributes"]>

    Returns Promise<{}>

  • Count the number of records matching the provided where clause.

    If you provide an include option, the number of matching associations will be counted instead.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional options: CountOptions<M["_attributes"]>

    Returns Promise<number>

Static create

  • create<M>(this: ModelStatic<M>, values?: M["_creationAttributes"], options?: CreateOptions<M["_attributes"]>): Promise<M>
  • create<M>(this: ModelStatic<M>, values: M["_creationAttributes"], options: CreateOptions<M["_attributes"]> & { returning: false }): Promise<void>
  • Builds a new model instance and calls save on it.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional values: M["_creationAttributes"]
    • Optional options: CreateOptions<M["_attributes"]>

    Returns Promise<M>

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • values: M["_creationAttributes"]
    • options: CreateOptions<M["_attributes"]> & { returning: false }

    Returns Promise<void>

Static describe

  • describe(): Promise<object>
  • Run a describe query on the table. The result will be return to the listener as a hash of attributes and their types.

    Returns Promise<object>

Static destroy

  • destroy<M>(this: ModelStatic<M>, options?: DestroyOptions<M["_attributes"]>): Promise<number>
  • Delete multiple instances, or set their deletedAt timestamp to the current time if paranoid is enabled.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional options: DestroyOptions<M["_attributes"]>

    Returns Promise<number>

    Promise The number of destroyed rows

Static drop

  • drop(options?: DropOptions): Promise<void>
  • Drop the table represented by this Model

    Parameters

    • Optional options: DropOptions

    Returns Promise<void>

Static findAll

  • findAll<M>(this: ModelStatic<M>, options?: FindOptions<M["_attributes"]>): Promise<M[]>
  • Search for multiple instances.

    Simple search using AND and =

    Model.findAll({
      where: {
        attr1: 42,
        attr2: 'cake'
      }
    })
    WHERE attr1 = 42 AND attr2 = 'cake'

    Using greater than, less than etc.

    
    Model.findAll({
      where: {
        attr1: {
          gt: 50
        },
        attr2: {
          lte: 45
        },
        attr3: {
          in: [1,2,3]
        },
        attr4: {
          ne: 5
        }
      }
    })
    WHERE attr1 > 50 AND attr2 <= 45 AND attr3 IN (1,2,3) AND attr4 != 5

    Possible options are: [Op.ne], [Op.in], [Op.not], [Op.notIn], [Op.gte], [Op.gt], [Op.lte], [Op.lt], [Op.like], [Op.ilike]/[Op.iLike], [Op.notLike], [Op.notILike], '..'/[Op.between], '!..'/[Op.notBetween], '&&'/[Op.overlap], '@>'/[Op.contains], '<@'/[Op.contained]

    Queries using OR

    Model.findAll({
      where: Sequelize.and(
        { name: 'a project' },
        Sequelize.or(
          { id: [1,2,3] },
          { id: { gt: 10 } }
        )
      )
    })
    WHERE name = 'a project' AND (id` IN (1,2,3) OR id > 10)

    The success listener is called with an array of instances if the query succeeds.

    see

    {Sequelize#query}

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional options: FindOptions<M["_attributes"]>

    Returns Promise<M[]>

Static findAndCountAll

  • findAndCountAll<M>(this: ModelStatic<M>, options?: FindAndCountOptions<M["_attributes"]>): Promise<{ count: number; rows: M[] }>
  • Find all the rows matching your query, within a specified offset / limit, and get the total number of rows matching your query. This is very usefull for paging

    Model.findAndCountAll({
      where: ...,
      limit: 12,
      offset: 12
    }).then(result => {
      ...
    })

    In the above example, result.rows will contain rows 13 through 24, while result.count will return the total number of rows that matched your query.

    When you add includes, only those which are required (either because they have a where clause, or because required is explicitly set to true on the include) will be added to the count part.

    Suppose you want to find all users who have a profile attached:

    User.findAndCountAll({
      include: [
         { model: Profile, required: true}
      ],
      limit: 3
    });

    Because the include for Profile has required set it will result in an inner join, and only the users who have a profile will be counted. If we remove required from the include, both users with and without profiles will be counted

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional options: FindAndCountOptions<M["_attributes"]>

    Returns Promise<{ count: number; rows: M[] }>

Static findByPk

  • findByPk<M>(this: ModelStatic<M>, identifier: Identifier, options: Omit<NonNullFindOptions<M["_attributes"]>, "where">): Promise<M>
  • findByPk<M>(this: ModelStatic<M>, identifier?: Identifier, options?: Omit<FindOptions<M["_attributes"]>, "where">): Promise<M | null>
  • Search for a single instance by its primary key. This applies LIMIT 1, so the listener will always be called with a single instance.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • identifier: Identifier
    • options: Omit<NonNullFindOptions<M["_attributes"]>, "where">

    Returns Promise<M>

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional identifier: Identifier
    • Optional options: Omit<FindOptions<M["_attributes"]>, "where">

    Returns Promise<M | null>

Static findCreateFind

  • findCreateFind<M>(this: ModelStatic<M>, options: FindOrCreateOptions<M["_attributes"], M["_creationAttributes"]>): Promise<[M, boolean]>
  • A more performant findOrCreate that will not work under a transaction (at least not in postgres) Will execute a find call, if empty then attempt to create, if unique constraint then attempt to find again

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • options: FindOrCreateOptions<M["_attributes"], M["_creationAttributes"]>

    Returns Promise<[M, boolean]>

Static findOne

  • findOne<M>(this: ModelStatic<M>, options: NonNullFindOptions<M["_attributes"]>): Promise<M>
  • findOne<M>(this: ModelStatic<M>, options?: FindOptions<M["_attributes"]>): Promise<M | null>
  • Search for a single instance. Returns the first instance found, or null if none can be found.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • options: NonNullFindOptions<M["_attributes"]>

    Returns Promise<M>

  • Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional options: FindOptions<M["_attributes"]>

    Returns Promise<M | null>

Static findOrBuild

  • findOrBuild<M>(this: ModelStatic<M>, options: FindOrCreateOptions<M["_attributes"], M["_creationAttributes"]>): Promise<[M, boolean]>
  • Find a row that matches the query, or build (but don't save) the row if none is found. The successfull result of the promise will be (instance, initialized) - Make sure to use .then(([...]))

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • options: FindOrCreateOptions<M["_attributes"], M["_creationAttributes"]>

    Returns Promise<[M, boolean]>

Static findOrCreate

  • findOrCreate<M>(this: ModelStatic<M>, options: FindOrCreateOptions<M["_attributes"], M["_creationAttributes"]>): Promise<[M, boolean]>
  • Find a row that matches the query, or build and save the row if none is found The successful result of the promise will be (instance, created) - Make sure to use .then(([...]))

    If no transaction is passed in the options object, a new transaction will be created internally, to prevent the race condition where a matching row is created by another connection after the find but before the insert call. However, it is not always possible to handle this case in SQLite, specifically if one transaction inserts and another tries to select before the first one has comitted. In this case, an instance of sequelize.TimeoutError will be thrown instead. If a transaction is created, a savepoint will be created instead, and any unique constraint violation will be handled internally.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • options: FindOrCreateOptions<M["_attributes"], M["_creationAttributes"]>

    Returns Promise<[M, boolean]>

Static getTableName

  • getTableName(): string | { delimiter: string; schema: string; tableName: string }
  • Get the tablename of the model, taking schema into account. The method will return The name as a string if the model has no schema, or an object with tableName, schema and delimiter properties.

    Returns string | { delimiter: string; schema: string; tableName: string }

Static hasHook

  • hasHook<H>(this: HooksStatic<H>, hookType: keyof SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>): boolean
  • Check whether the mode has any hooks of this type

    Type parameters

    • H: Hooks

    Parameters

    • this: HooksStatic<H>
    • hookType: keyof SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>

    Returns boolean

Static hasHooks

  • hasHooks<H>(this: HooksStatic<H>, hookType: keyof SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>): boolean
  • Type parameters

    • H: Hooks

    Parameters

    • this: HooksStatic<H>
    • hookType: keyof SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>

    Returns boolean

Static hasMany

  • hasMany<M, T>(this: ModelStatic<M>, target: ModelStatic<T>, options?: HasManyOptions): HasMany<M, T>
  • Create an association that is either 1:m or n:m.

    // Create a 1:m association between user and project
    User.hasMany(Project)
    // Create a n:m association between user and project
    User.hasMany(Project)
    Project.hasMany(User)

    By default, the name of the join table will be source+target, so in this case projectsusers. This can be overridden by providing either a string or a Model as through in the options. If you use a through model with custom attributes, these attributes can be set when adding / setting new associations in two ways. Consider users and projects from before with a join table that stores whether the project has been started yet:

    class UserProjects extends Model {}
    UserProjects.init({
      started: Sequelize.BOOLEAN
    }, { sequelize })
    User.hasMany(Project, { through: UserProjects })
    Project.hasMany(User, { through: UserProjects })
    jan.addProject(homework, { started: false }) // The homework project is not started yet
    jan.setProjects([makedinner, doshopping], { started: true}) // Both shopping and dinner have been
    started

    If you want to set several target instances, but with different attributes you have to set the attributes on the instance, using a property with the name of the through model:

    p1.userprojects {
      started: true
    }
    user.setProjects([p1, p2], {started: false}) // The default value is false, but p1 overrides that.

    Similarily, when fetching through a join table with custom attributes, these attributes will be available as an object with the name of the through model.

    user.getProjects().then(projects => {
      const p1 = projects[0]
      p1.userprojects.started // Is this project started yet?
    })

    Type parameters

    • M: Model

    • T: Model

    Parameters

    • this: ModelStatic<M>
    • target: ModelStatic<T>

      The model that will be associated with hasOne relationship

    • Optional options: HasManyOptions

      Options for the association

    Returns HasMany<M, T>

Static hasOne

  • hasOne<M, T>(this: ModelStatic<M>, target: ModelStatic<T>, options?: HasOneOptions): HasOne<M, T>
  • Creates an association between this (the source) and the provided target. The foreign key is added on the target.

    Example: User.hasOne(Profile). This will add userId to the profile table.

    Type parameters

    • M: Model

    • T: Model

    Parameters

    • this: ModelStatic<M>
    • target: ModelStatic<T>

      The model that will be associated with hasOne relationship

    • Optional options: HasOneOptions

      Options for the association

    Returns HasOne<M, T>

Static increment

  • increment<M>(this: ModelStatic<M>, field: keyof M["_attributes"], options: IncrementDecrementOptionsWithBy<M["_attributes"]>): Promise<M>
  • increment<M>(this: ModelStatic<M>, fields: keyof M["_attributes"][], options: IncrementDecrementOptionsWithBy<M["_attributes"]>): Promise<M>
  • increment<M>(this: ModelStatic<M>, fields: {}, options: IncrementDecrementOptions<M["_attributes"]>): Promise<M>
  • Increments a single field.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • field: keyof M["_attributes"]
    • options: IncrementDecrementOptionsWithBy<M["_attributes"]>

    Returns Promise<M>

  • Increments multiple fields by the same value.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fields: keyof M["_attributes"][]
    • options: IncrementDecrementOptionsWithBy<M["_attributes"]>

    Returns Promise<M>

  • Increments multiple fields by different values.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • fields: {}
    • options: IncrementDecrementOptions<M["_attributes"]>

    Returns Promise<M>

Static init

  • init<M>(this: ModelStatic<M>, attributes: ModelAttributes<M, M["_attributes"]>, options: InitOptions<M>): Model
  • Initialize a model, representing a table in the DB, with attributes and options.

    The table columns are define by the hash that is given as the second argument. Each attribute of the hash represents a column. A short table definition might look like this:

    Project.init({
      columnA: {
        type: Sequelize.BOOLEAN,
        validate: {
          is: ['[a-z]','i'],        // will only allow letters
          max: 23,                  // only allow values <= 23
          isIn: {
            args: [['en', 'zh']],
            msg: "Must be English or Chinese"
          }
        },
        field: 'column_a'
        // Other attributes here
      },
      columnB: Sequelize.STRING,
      columnC: 'MY VERY OWN COLUMN TYPE'
    }, {sequelize})
    
    sequelize.models.modelName // The model will now be available in models under the class name

    As shown above, column definitions can be either strings, a reference to one of the datatypes that are predefined on the Sequelize constructor, or an object that allows you to specify both the type of the column, and other attributes such as default values, foreign key constraints and custom setters and getters.

    For a list of possible data types, see https://sequelize.org/master/en/latest/docs/models-definition/#data-types

    For more about getters and setters, see https://sequelize.org/master/en/latest/docs/models-definition/#getters-setters

    For more about instance and class methods, see https://sequelize.org/master/en/latest/docs/models-definition/#expansion-of-models

    For more about validation, see https://sequelize.org/master/en/latest/docs/models-definition/#validations

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • attributes: ModelAttributes<M, M["_attributes"]>

      An object, where each attribute is a column of the table. Each column can be either a DataType, a string or a type-description object, with the properties described below:

    • options: InitOptions<M>

      These options are merged with the default define options provided to the Sequelize constructor

    Returns Model

    Return the initialized model

Static max

  • max<T, M>(this: ModelStatic<M>, field: keyof M["_attributes"], options?: AggregateOptions<T, M["_attributes"]>): Promise<T>
  • Find the maximum value of field

    Type parameters

    • T: DataType | unknown

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • field: keyof M["_attributes"]
    • Optional options: AggregateOptions<T, M["_attributes"]>

    Returns Promise<T>

Static min

  • min<T, M>(this: ModelStatic<M>, field: keyof M["_attributes"], options?: AggregateOptions<T, M["_attributes"]>): Promise<T>
  • Find the minimum value of field

    Type parameters

    • T: DataType | unknown

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • field: keyof M["_attributes"]
    • Optional options: AggregateOptions<T, M["_attributes"]>

    Returns Promise<T>

Static removeAttribute

  • removeAttribute(attribute: string): void
  • Remove attribute from model definition

    Parameters

    • attribute: string

    Returns void

Static removeHook

  • removeHook<H>(this: HooksStatic<H>, hookType: keyof SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>, name: string): HooksCtor<H>
  • Remove hook from the model

    Type parameters

    • H: Hooks

    Parameters

    • this: HooksStatic<H>
    • hookType: keyof SequelizeHooks<H["_model"], H["_attributes"], H["_creationAttributes"]>
    • name: string

    Returns HooksCtor<H>

Static restore

  • restore<M>(this: ModelStatic<M>, options?: RestoreOptions<M["_attributes"]>): Promise<void>
  • Restore multiple instances if paranoid is enabled.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional options: RestoreOptions<M["_attributes"]>

    Returns Promise<void>

Static schema

  • schema<M>(this: ModelStatic<M>, schema: string, options?: SchemaOptions): { constructor: any } & typeof Model
  • Apply a schema to this model. For postgres, this will actually place the schema in front of the table name

    • "schema"."tableName", while the schema will be prepended to the table name for mysql and sqlite - 'schema.tablename'.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • schema: string

      The name of the schema

    • Optional options: SchemaOptions

    Returns { constructor: any } & typeof Model

Static scope

  • scope<M>(this: ModelStatic<M>, options?: string | ScopeOptions | (string | ScopeOptions)[] | WhereAttributeHash<M>): ModelCtor<M>
  • Apply a scope created in define to the model. First let's look at how to create scopes:

    class MyModel extends Model {}
    MyModel.init(attributes, {
      defaultScope: {
        where: {
          username: 'dan'
        },
        limit: 12
      },
      scopes: {
        isALie: {
          where: {
            stuff: 'cake'
          }
        },
        complexFunction(email, accessLevel) {
          return {
            where: {
              email: {
                [Op.like]: email
              },
              accesss_level {
                [Op.gte]: accessLevel
              }
            }
          }
        }
      },
      sequelize,
    })

    Now, since you defined a default scope, every time you do Model.find, the default scope is appended to your query. Here's a couple of examples:

    Model.findAll() // WHERE username = 'dan'
    Model.findAll({ where: { age: { gt: 12 } } }) // WHERE age > 12 AND username = 'dan'

    To invoke scope functions you can do:

    Model.scope({ method: ['complexFunction' 'dan@sequelize.com', 42]}).findAll()
    // WHERE email like 'dan@sequelize.com%' AND access_level >= 42

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional options: string | ScopeOptions | (string | ScopeOptions)[] | WhereAttributeHash<M>

    Returns ModelCtor<M>

    Model A reference to the model, with the scope(s) applied. Calling scope again on the returned model will clear the previous scope.

Static sum

  • sum<T, M>(this: ModelStatic<M>, field: keyof M["_attributes"], options?: AggregateOptions<T, M["_attributes"]>): Promise<number>
  • Find the sum of field

    Type parameters

    • T: DataType | unknown

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • field: keyof M["_attributes"]
    • Optional options: AggregateOptions<T, M["_attributes"]>

    Returns Promise<number>

Static sync

  • sync<M>(options?: SyncOptions): Promise<M>
  • Sync this Model to the DB, that is create the table. Upon success, the callback will be called with the model instance (this)

    Type parameters

    • M: Model

    Parameters

    • Optional options: SyncOptions

    Returns Promise<M>

Static truncate

  • truncate<M>(this: ModelStatic<M>, options?: TruncateOptions<M["_attributes"]>): Promise<void>
  • Truncate all instances of the model. This is a convenient method for Model.destroy({ truncate: true }).

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • Optional options: TruncateOptions<M["_attributes"]>

    Returns Promise<void>

Static unscoped

  • unscoped<M>(this: M): M
  • Unscope the model

    Type parameters

    • M: typeof Model

    Parameters

    • this: M

    Returns M

Static update

  • update<M>(this: ModelStatic<M>, values: Partial<M["_attributes"]>, options: UpdateOptions<M["_attributes"]>): Promise<[number, M[]]>
  • Update multiple instances that match the where options. The promise returns an array with one or two elements. The first element is always the number of affected rows, while the second element is the actual affected rows (only supported in postgres and mssql with options.returning true.)

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • values: Partial<M["_attributes"]>
    • options: UpdateOptions<M["_attributes"]>

    Returns Promise<[number, M[]]>

Static upsert

  • upsert<M>(this: ModelStatic<M>, values: M["_creationAttributes"], options?: UpsertOptions<M["_attributes"]>): Promise<[M, boolean | null]>
  • Insert or update a single row. An update will be executed if a row which matches the supplied values on either the primary key or a unique key is found. Note that the unique index must be defined in your sequelize model and not just in the table. Otherwise you may experience a unique constraint violation, because sequelize fails to identify the row that should be updated.

    Implementation details:

    • MySQL - Implemented as a single query INSERT values ON DUPLICATE KEY UPDATE values
    • PostgreSQL - Implemented as a temporary function with exception handling: INSERT EXCEPTION WHEN unique_constraint UPDATE
    • SQLite - Implemented as two queries INSERT; UPDATE. This means that the update is executed regardless of whether the row already existed or not

    Note that SQLite returns null for created, no matter if the row was created or updated. This is because SQLite always runs INSERT OR IGNORE + UPDATE, in a single query, so there is no way to know whether the row was inserted or not.

    Type parameters

    • M: Model

    Parameters

    • this: ModelStatic<M>
    • values: M["_creationAttributes"]
    • Optional options: UpsertOptions<M["_attributes"]>

    Returns Promise<[M, boolean | null]>

Generated using TypeDoc