Alembic v2.1.0 Alembic.RelationshipPath
A relationship path is a dot-separated (U+002E FULL-STOP, “.”) list of relationship names.
Summary
Types
NOTE: Kept as a string until application can validate relationship name.
A relationship path is a dot-separated (U+002E FULL-STOP, “.”) list of relationship names.
Functions
Separator for relationship_names
in a relationship_path
Breaks the relationship_path
into relationship_name
s in a nested map to form
Alembic.Fetch.Include.include
Types
relationship_name :: String.t
NOTE: Kept as a string until application can validate relationship name.
The name of a relationship.
Functions
Specs
to_include(t) :: Alembic.Fetch.Includes.include
Breaks the relationship_path
into relationship_name
s in a nested map to form
Alembic.Fetch.Include.include
A relationship name passes through unchanged
iex> Alembic.RelationshipPath.to_include("comments")
"comments"
A relationship path becomes a (nested) map
iex> Alembic.RelationshipPath.to_include("comments.author.posts")
%{
"comments" => %{
"author" => "posts"
}
}