This repository has been archived by the owner on Sep 3, 2021. It is now read-only.
@relation type directive arguments for custom node type field names #521
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.
The current way to define the head and tail node types of a
@relation
type requires the user to definefrom
andto
fields. For example:Different types
Same types
This PR adds
from
andto
arguments to the@relation
type directive used by schema augmentation. Thefrom
argument is for the name of the node type field the relationship is coming from (head node), and theto
argument for the node type it's going to (tail node). This results in adding a layer of customization for the names of node type fields defined for relationship types. This is a non-breaking change, as while thefrom
andto
field names can still be used, field names provided to thefrom
andto
arguments of the@relation
type directive take precedence:Different types
Same types
This allows for more precise semantics when defining related node type field names, which in turn allows for more descriptive documentation comments. :)