Indexes

Sequelize supports adding indexes to the model definition which will be created on sequelize.sync().

  1. const User = sequelize.define('User', { /* attributes */ }, {
  2.   indexes: [
  3.     // Create a unique index on email
  4.     {
  5.       unique: true,
  6.       fields: ['email']
  7.     },
  9.     // Creates a gin index on data with the jsonb_path_ops operator
  10.     {
  11.       fields: ['data'],
  12.       using: 'gin',
  13.       operator: 'jsonb_path_ops'
  14.     },
  16.     // By default index name will be [table]_[fields]
  17.     // Creates a multi column partial index
  18.     {
  19.       name: 'public_by_author',
  20.       fields: ['author', 'status'],
  21.       where: {
  22.         status: 'public'
  23.       }
  24.     },
  26.     // A BTREE index with an ordered field
  27.     {
  28.       name: 'title_index',
  29.       using: 'BTREE',
  30.       fields: [
  31.         'author',
  32.         {
  33.           attribute: 'title',
  34.           collate: 'en_US',
  35.           order: 'DESC',
  36.           length: 5
  37.         }
  38.       ]
  39.     }
  40.   ]
  41. });