Configuration

You can also influence the way Sequelize handles your column names:

  1. class Bar extends Model {}
  2. Bar.init({ /* bla */ }, {
  3.   // The name of the model. The model will be stored in `sequelize.models` under this name.
  4.   // This defaults to class name i.e. Bar in this case. This will control name of auto-generated
  5.   // foreignKey and association naming
  6.   modelName: 'bar',
  8.   // don't add the timestamp attributes (updatedAt, createdAt)
  9.   timestamps: false,
  11.   // don't delete database entries but set the newly added attribute deletedAt
  12.   // to the current date (when deletion was done). paranoid will only work if
  13.   // timestamps are enabled
  14.   paranoid: true,
  16.   // Will automatically set field option for all attributes to snake cased name.
  17.   // Does not override attribute with field option already defined
  18.   underscored: true,
  20.   // disable the modification of table names; By default, sequelize will automatically
  21.   // transform all passed model names (first parameter of define) into plural.
  22.   // if you don't want that, set the following
  23.   freezeTableName: true,
  25.   // define the table's name
  26.   tableName: 'my_very_custom_table_name',
  28.   // Enable optimistic locking.  When enabled, sequelize will add a version count attribute
  29.   // to the model and throw an OptimisticLockingError error when stale instances are saved.
  30.   // Set to true or a string with the attribute name you want to use to enable.
  31.   version: true,
  33.   // Sequelize instance
  34.   sequelize,
  35. })

If you want sequelize to handle timestamps, but only want some of them, or want your timestamps to be called something else, you can override each column individually:

  1. class Foo extends Model {}
  2. Foo.init({ /* bla */ }, {
  3.   // don't forget to enable timestamps!
  4.   timestamps: true,
  6.   // I don't want createdAt
  7.   createdAt: false,
  9.   // I want updatedAt to actually be called updateTimestamp
  10.   updatedAt: 'updateTimestamp',
  12.   // And deletedAt to be called destroyTime (remember to enable paranoid for this to work)
  13.   deletedAt: 'destroyTime',
  14.   paranoid: true,
  16.   sequelize,
  17. })

You can also change the database engine, e.g. to MyISAM. InnoDB is the default.

  1. class Person extends Model {}
  2. Person.init({ /* attributes */ }, {
  3.   engine: 'MYISAM',
  4.   sequelize
  5. })
  7. // or globally
  8. const sequelize = new Sequelize(db, user, pw, {
  9.   define: { engine: 'MYISAM' }
  10. })

Finally you can specify a comment for the table in MySQL and PG

  1. class Person extends Model {}
  2. Person.init({ /* attributes */ }, {
  3.   comment: "I'm a table comment!",
  4.   sequelize
  5. })