Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InitOptions<M>

Options passed to Model.init

Type parameters

Hierarchy

Index

Properties

Properties

Optional charset

charset?: string

The charset to use for the model

Optional collate

collate?: string

The collation for model's table

Optional comment

comment?: string

A comment for the table.

MySQL, PG only.

Optional createdAt

createdAt?: string | boolean

Override the name of the createdAt attribute if a string is provided, or disable it if false. ModelOptions.timestamps must be true.

Not affected by underscored setting.

Optional defaultScope

defaultScope?: FindOptions<Attributes<M>>

Define the default search scope to use for this model. Scopes have the same form as the options passed to find / findAll.

Optional deletedAt

deletedAt?: string | boolean

Override the name of the deletedAt attribute if a string is provided, or disable it if false. ModelOptions.timestamps must be true. ModelOptions.paranoid must be true.

Not affected by underscored setting.

Optional engine

engine?: string

The name of the database storage engine to use (e.g. MyISAM, InnoDB).

MySQL, MariaDB only.

Optional freezeTableName

freezeTableName?: boolean

If true, sequelize will use the name of the Model as-is as the name of the SQL table. If false, the name of the table will be pluralised (and snake_cased if ModelOptions.underscored is true).

This option has no effect if ModelOptions.tableName is set.

default

false

Optional getterMethods

getterMethods?: ModelGetterOptions<M>

Allows defining additional getters that will be available on model instances.

Optional hasTrigger

hasTrigger?: boolean

Indicates if the model's table has a trigger associated with it.

default

false

Optional hooks

hooks?: { afterBulkCreate?: any; afterBulkDestroy?: any; afterBulkRestore?: any; afterBulkSync?: any; afterBulkUpdate?: any; afterCreate?: any; afterDestroy?: any; afterFind?: any; afterQuery?: any; afterRestore?: any; afterSave?: any; afterSync?: any; afterUpdate?: any; afterUpsert?: any; afterValidate?: any; beforeBulkCreate?: any; beforeBulkDestroy?: any; beforeBulkRestore?: any; beforeBulkSync?: any; beforeBulkUpdate?: any; beforeCount?: any; beforeCreate?: any; beforeDestroy?: any; beforeFind?: any; beforeFindAfterExpandIncludeAll?: any; beforeFindAfterOptions?: any; beforeQuery?: any; beforeRestore?: any; beforeSave?: any; beforeSync?: any; beforeUpdate?: any; beforeUpsert?: any; beforeValidate?: any }

Add hooks to the model. Hooks will be called before and after certain operations.

This can also be done through Model.addHook, or the individual hook methods such as {@link Model.afterQuery}. Each property can either be a function, or an array of functions.

see

https://sequelize.org/docs/v7/other-topics/hooks/

Type declaration

  • afterBulkCreate?:function
      • afterBulkDestroy?:function
          • afterBulkRestore?:function
              • afterBulkSync?:function
                  • afterBulkUpdate?:function
                      • afterCreate?:function
                          • afterDestroy?:function
                              • afterFind?:function
                                  • afterQuery?:function
                                      • afterRestore?:function
                                          • afterSave?:function
                                              • afterSync?:function
                                                  • afterUpdate?:function
                                                      • afterUpsert?:function
                                                          • afterValidate?:function
                                                              • beforeBulkCreate?:function
                                                                  • beforeBulkDestroy?:function
                                                                      • beforeBulkRestore?:function
                                                                          • beforeBulkSync?:function
                                                                              • beforeBulkUpdate?:function
                                                                                  • beforeCount?:function
                                                                                      • beforeCreate?:function
                                                                                          • beforeDestroy?:function
                                                                                              • beforeFind?:function
                                                                                                  • beforeFindAfterExpandIncludeAll?:function
                                                                                                      • beforeFindAfterOptions?:function
                                                                                                          • beforeQuery?:function
                                                                                                              • beforeRestore?:function
                                                                                                                  • beforeSave?:function
                                                                                                                      • beforeSync?:function
                                                                                                                          • beforeUpdate?:function
                                                                                                                              • beforeUpsert?:function
                                                                                                                                  • beforeValidate?:function

                                                                                                                                      Optional indexes

                                                                                                                                      indexes?: readonly IndexOptions[]

                                                                                                                                      Indexes for the provided database table

                                                                                                                                      Optional initialAutoIncrement

                                                                                                                                      initialAutoIncrement?: string

                                                                                                                                      Set the initial AUTO_INCREMENT value for the table in MySQL.

                                                                                                                                      Optional modelName

                                                                                                                                      modelName?: string

                                                                                                                                      The name of the model.

                                                                                                                                      If not set, the name of the class will be used instead. You should specify this option if you are going to minify your code in a way that may mangle the class name.

                                                                                                                                      Optional name

                                                                                                                                      name?: ModelNameOptions

                                                                                                                                      An object with two attributes, singular and plural, which are used when this model is associated to others.

                                                                                                                                      Optional noPrimaryKey

                                                                                                                                      noPrimaryKey?: boolean

                                                                                                                                      Sequelize will automatically add a primary key called id if no primary key has been added manually.

                                                                                                                                      Set to false to disable adding that primary key.

                                                                                                                                      default

                                                                                                                                      false

                                                                                                                                      Optional omitNull

                                                                                                                                      omitNull?: boolean

                                                                                                                                      Don't persist null values. This means that all columns with null values will not be saved.

                                                                                                                                      default

                                                                                                                                      false

                                                                                                                                      Optional paranoid

                                                                                                                                      paranoid?: boolean

                                                                                                                                      If true, calling Model.destroy will not delete the model, but will instead set a deletedAt timestamp.

                                                                                                                                      This options requires ModelOptions.timestamps to be true. The deletedAt column can be customized through ModelOptions.deletedAt.

                                                                                                                                      default

                                                                                                                                      false

                                                                                                                                      Optional schema

                                                                                                                                      schema?: string

                                                                                                                                      The database schema in which this table will be located.

                                                                                                                                      Optional scopes

                                                                                                                                      scopes?: ModelScopeOptions<Attributes<M>>

                                                                                                                                      More scopes, defined in the same way as ModelOptions.defaultScope above. See Model.scope for more information about how scopes are defined, and what you can do with them.

                                                                                                                                      sequelize

                                                                                                                                      sequelize: Sequelize

                                                                                                                                      The sequelize connection. Required ATM.

                                                                                                                                      Optional setterMethods

                                                                                                                                      setterMethods?: ModelSetterOptions<M>

                                                                                                                                      Allows defining additional setters that will be available on model instances.

                                                                                                                                      Optional tableName

                                                                                                                                      tableName?: string

                                                                                                                                      The name of the table in SQL.

                                                                                                                                      default

                                                                                                                                      The ModelOptions.modelName, pluralized, unless freezeTableName is true, in which case it uses model name verbatim.

                                                                                                                                      Optional timestamps

                                                                                                                                      timestamps?: boolean

                                                                                                                                      Adds createdAt and updatedAt timestamps to the model.

                                                                                                                                      default

                                                                                                                                      true

                                                                                                                                      Optional underscored

                                                                                                                                      underscored?: boolean

                                                                                                                                      If true, Sequelize will snake_case the name of columns that do not have an explicit value set (using ModelAttributeColumnOptions.field). The name of the table will also be snake_cased, unless ModelOptions.tableName is set, or ModelOptions.freezeTableName is true.

                                                                                                                                      default

                                                                                                                                      false

                                                                                                                                      Optional updatedAt

                                                                                                                                      updatedAt?: string | boolean

                                                                                                                                      Override the name of the updatedAt attribute if a string is provided, or disable it if false. ModelOptions.timestamps must be true.

                                                                                                                                      Not affected by underscored setting.

                                                                                                                                      Optional validate

                                                                                                                                      validate?: ModelValidateOptions

                                                                                                                                      An object of model wide validations. Validations have access to all model values via this. If the validator function takes an argument, it is assumed to be async, and is called with a callback that accepts an optional error.

                                                                                                                                      Optional version

                                                                                                                                      version?: string | boolean

                                                                                                                                      Enable optimistic locking. When enabled, sequelize will add a version count attribute to the model and throw an OptimisticLockingError error when stale instances are saved.

                                                                                                                                      • If string: Uses the named attribute.
                                                                                                                                      • If boolean: Uses version.
                                                                                                                                      default

                                                                                                                                      false

                                                                                                                                      Generated using TypeDoc