-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add Model.{getInitialModel,withoutScope}, rename schema+(un)?scope #14337
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ephys
added
the
type: feature
For issues and PRs. For new features. Never breaking changes.
label
Apr 7, 2022
WikiRik
approved these changes
Apr 10, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! I'm assuming the documentation of the renames will follow later?
In our upgrade guide? Yep :) |
🎉 This PR is included in version 7.0.0-alpha.11 🎉 The release is available on: Your semantic-release bot 📦🚀 |
vanthome
pushed a commit
to vanthome/sequelize
that referenced
this pull request
Jun 12, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
yarn test
oryarn test-DIALECT
pass with this change (including linting)?Description Of Change
Another building block for #14280
Context:
Model.scope
,Model.unscope
andModel.schema
return new classes.This is a problem for the above PR because that PR needs to be able to check whether two models classes are the same.
This PR does a few things:
Model.schema('public') === Model.schema('public')
Model.withInitialScope
:unscope()
is a misnomer, it doesn't restore the model to its state before the call toscope()
. Instead it returns a model with no scope at all (including the default scope).withInitialScope()
does return a model with the default scope.Model.getInitialModel
which returns the model, like it was before any call toscope
,unscope
orschema
unscope
towithoutScope
,scope
towithScope
andschema
towithSchema
.This change was done to signal that these methods will not mutate the Model and, instead, return a new Model. These names follow conventions for similar methods that we can find in other libraries.
The old names still exist but will log a deprecation notice. There are no breaking changes in this PR.