[ci skip] Changelog for #5605

changelog.md

@@ -13,6 +13,7 @@
 - [ADDED] Add logging for mysql warnings, observant of the `showWarnings` option. [#5900](https://github.com/sequelize/sequelize/issues/5900)
 - [ADDED] Add logging for mysql warnings, observant of the `showWarnings` option. [#5900](https://github.com/sequelize/sequelize/issues/5900)
 - [REMOVED] MariaDB dialect
 - [REMOVED] MariaDB dialect
 - [FIXED] `hasOne` now prefer aliases to construct foreign key [#5247](https://github.com/sequelize/sequelize/issues/5247)
 - [FIXED] `hasOne` now prefer aliases to construct foreign key [#5247](https://github.com/sequelize/sequelize/issues/5247)
+- [CHANGED] `instance.equals` now only checks primary keys, instead of all attributes.
 
 
 ## BC breaks:
 ## BC breaks:
 - `hookValidate` removed in favor of `validate` with `hooks: true | false`. `validate` returns a promise which is rejected if validation fails
 - `hookValidate` removed in favor of `validate` with `hooks: true | false`. `validate` returns a promise which is rejected if validation fails
@@ -25,6 +26,7 @@
 - Removed default `REPEATABLE_READ` transaction isolation, use config option to explicitly set it
 - Removed default `REPEATABLE_READ` transaction isolation, use config option to explicitly set it
 - Removed MariaDB dialect - this was just a thin wrapper around MySQL, so using `dialect: 'mysql'` instead should work with no further changes
 - Removed MariaDB dialect - this was just a thin wrapper around MySQL, so using `dialect: 'mysql'` instead should work with no further changes
 - `hasOne` now prefer `as` option to generate foreign key name, otherwise it defaults to source model name
 - `hasOne` now prefer `as` option to generate foreign key name, otherwise it defaults to source model name
+- `instance.equals` now provides reference equality (do two instances refer to the same row, i.e. are their primary key(s) equal). Use `instance.get()` to get and compare all values.
 
 
 # 3.23.2
 # 3.23.2
 - [FIXED] Type validation now works with non-strings due to updated validator@5.0.0 [#5861](https://github.com/sequelize/sequelize/pull/5861)
 - [FIXED] Type validation now works with non-strings due to updated validator@5.0.0 [#5861](https://github.com/sequelize/sequelize/pull/5861)