DOCSP-45330: inheritance #66
Open
+388
−5
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
✅ Deploy Preview for docs-mongoid ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
stephmarie17
approved these changes
Nov 18, 2024
| {+odm+} models. Inheritance allows you to apply the characteristics of | ||
| one "parent" class to one or more "child" classes. | ||
|
|
||
| {+odm+} supports inheritance in top level and embedded documents. |
There was a problem hiding this comment.
Suggested change
| {+odm+} supports inheritance in top level and embedded documents. | |
| {+odm+} supports inheritance in top-level and embedded documents. |
Comment on lines
+48
to
+49
| instances of ``Person``, ``Employee``, or ``Manager`` are all saved in the | ||
| ``people`` collection. {+odm+} sets the ``_type`` discriminator field to |
There was a problem hiding this comment.
[s] Suggestion for active voice:
Suggested change
| instances of ``Person``, ``Employee``, or ``Manager`` are all saved in the | |
| ``people`` collection. {+odm+} sets the ``_type`` discriminator field to | |
| {+odm} saves instances of ``Person``, ``Employee``, or ``Manager`` in the | |
| ``people`` collection. {+odm+} sets the ``_type`` discriminator field to |
| ~~~~~~~~~~~~~~ | ||
|
|
||
| When you query on a child model class, the query returns only documents | ||
| in which the value of the ``_type`` field match the queried class or |
There was a problem hiding this comment.
Suggested change
| in which the value of the ``_type`` field match the queried class or | |
| in which the value of the ``_type`` field matches the queried class or |
Comment on lines
+189
to
+197
| .. note:: | ||
|
|
||
| Because the discriminator value customization is declared in child classes, | ||
| you must load the child classes retrieved by a query *before* sending | ||
| that query. In the preceding example, the ``Employee`` class definition | ||
| must be loaded before you query on ``Person`` if the returned documents could | ||
| potentially be instances of ``Employee``. Autoloading isn't able to resolve | ||
| the discriminator value ``"Worker"`` to return the document as an | ||
| instance of ``Employee``. |
There was a problem hiding this comment.
[s] Can potentially omit extra words for brevity and make this note easier to follow, for example:
Suggested change
| .. note:: | |
| Because the discriminator value customization is declared in child classes, | |
| you must load the child classes retrieved by a query *before* sending | |
| that query. In the preceding example, the ``Employee`` class definition | |
| must be loaded before you query on ``Person`` if the returned documents could | |
| potentially be instances of ``Employee``. Autoloading isn't able to resolve | |
| the discriminator value ``"Worker"`` to return the document as an | |
| instance of ``Employee``. | |
| .. note:: | |
| Because the discriminator value customization is declared in child classes, | |
| you must load the child classes retrieved by a query *before* sending | |
| that query. In the preceding example, the ``Employee`` class definition | |
| must be loaded before you query on ``Person`` if the returned documents could | |
| be instances of ``Employee``. Autoloading cannot resolve | |
| the discriminator value ``"Worker"`` to return the document as an | |
| instance of ``Employee``. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-45330
Staging - https://deploy-preview-66--docs-mongoid.netlify.app/data-modeling/inheritance/
Self-Review Checklist