Working with legacy tables

While out of the box Sequelize will seem a bit opinionated it's trivial to both legacy and forward proof your application by defining (otherwise generated) table and field names.

Tables

  1. sequelize.define('user', {
  3. }, {
  4.   tableName: 'users'
  5. });

Fields

  1. sequelize.define('modelName', {
  2.   userId: {
  3.     type: Sequelize.INTEGER,
  4.     field: 'user_id'
  5.   }
  6. });

Primary keys

Sequelize will assume your table has a id primary key property by default.

To define your own primary key:

  1. sequelize.define('collection', {
  2.   uid: {
  3.     type: Sequelize.INTEGER,
  4.     primaryKey: true,
  5.     autoIncrement: true // Automatically gets converted to SERIAL for postgres
  6.   }
  7. });
  9. sequelize.define('collection', {
  10.   uuid: {
  11.     type: Sequelize.UUID,
  12.     primaryKey: true
  13.   }
  14. });

And if your model has no primary key at all you can use Model.removeAttribute('id');

Foreign keys

  1. // 1:1
  2. Organization.belongsTo(User, {foreignKey: 'owner_id'});
  3. User.hasOne(Organization, {foreignKey: 'owner_id'});
  5. // 1:M
  6. Project.hasMany(Task, {foreignKey: 'tasks_pk'});
  7. Task.belongsTo(Project, {foreignKey: 'tasks_pk'});
  9. // N:M
  10. User.hasMany(Role, {through: 'user_has_roles', foreignKey: 'user_role_user_id'});
  11. Role.hasMany(User, {through: 'user_has_roles', foreignKey: 'roles_identifier'});