Add another parent value option to join documentation #25609
Merged
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.
When indexing a document using a
joinfield, the user must always specify the name of the relation, and in the case of a child document, must specify the parent document id. When indexing a parent document you can simply send the name of the relation as the value of the join field instead of an object with the relation name as a subfield. This PR adds documentation for both indexing cases, and implies that sending just the relation name is a short-form for the object use case.