Merge pull request #4399 from pensierinmusica/patch-1

[ci skip] 📝 Added details about "unique" property (closes #4329)

docs/docs/models-definition.md

@@ -37,6 +37,12 @@ var Foo = sequelize.define('Foo', {
  someUnique: {type: Sequelize.STRING, unique: true},
  someUnique: {type: Sequelize.STRING, unique: true},
  uniqueOne: { type: Sequelize.STRING,  unique: 'compositeIndex'},
  uniqueOne: { type: Sequelize.STRING,  unique: 'compositeIndex'},
  uniqueTwo: { type: Sequelize.INTEGER, unique: 'compositeIndex'}
  uniqueTwo: { type: Sequelize.INTEGER, unique: 'compositeIndex'}
+ 
+ // The unique property is simply a shorthand to create a unique index.
+ someUnique: {type: Sequelize.STRING, unique: true}
+ // It's exactly the same as creating the index in the model's options.
+ {someUnique: {type: Sequelize.STRING}},
+ {indexes: [{unique: true, fields: ['someUnique']}]}
 
 
  // Go on reading for further information about primary keys
  // Go on reading for further information about primary keys
  identifier: { type: Sequelize.STRING, primaryKey: true},
  identifier: { type: Sequelize.STRING, primaryKey: true},