ash v0.1.3 Ash.Resource.Relationships.BelongsTo View Source

The representation of a belongs_to relationship

Link to this section Summary

Types

t()

Functions

new(resource, name, related_resource, opts \\ [])

Link to this section Types

t()

t() :: %Ash.Resource.Relationships.BelongsTo{
  cardinality: :one,
  define_field?: boolean(),
  destination: Ash.resource(),
  destination_field: atom(),
  field_type: Ash.Type.t(),
  name: atom(),
  primary_key?: boolean(),
  reverse_relationship: term(),
  source: Ash.resource(),
  source_field: atom() | nil,
  type: :belongs_to
}

Link to this section Functions

new(resource, name, related_resource, opts \\ [])

new(
  resource :: Ash.resource(),
  name :: atom(),
  related_resource :: Ash.resource(),
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, term()}