# `Diffo.Provider.AssignmentRelationship`
[🔗](https://github.com/diffo-dev/diffo/blob/v0.9.0/lib/diffo/provider/components/assignment_relationship.ex#L5)

Ash Resource for a pool assignment relationship.

Stores a single pool assignment as a direct Neo4j relationship between a source
(the pool-owning instance) and a target (the assignee instance). `pool`, `thing`,
and `value` are top-level scalar attributes, making them filterable at the Cypher
level and usable in aggregate filters via AshNeo4j #253.

Contrast with `DefinedSimpleRelationship`, which stores its characteristic as an
embedded `NameValuePrimitive` — suitable as a general primitive but opaque to the
data layer for filtering purposes.

Actions: **create** and **destroy** only. Assignments are commitments; to change
an assignment, destroy and recreate.

A pool assignment relationship between a source and target instance

# `t`

```elixir
@type t() :: %Diffo.Provider.AssignmentRelationship{
  __lateral_join_source__: term(),
  __meta__: term(),
  __metadata__: term(),
  __order__: term(),
  aggregates: term(),
  alias: term(),
  calculations: term(),
  created_at: term(),
  id: term(),
  pool: term(),
  source: term(),
  source_id: term(),
  target: term(),
  target_href: term(),
  target_id: term(),
  target_type: term(),
  thing: term(),
  type: term(),
  updated_at: term(),
  value: term()
}
```

# `default_short_name`

# `input`

```elixir
@spec input(values :: map() | Keyword.t()) :: map() | no_return()
```

Validates that the keys in the provided input are valid for at least one action on the resource.

Raises a KeyError error at compile time if not. This exists because generally a struct should only ever
be created by Ash as a result of a successful action. You should not be creating records manually in code,
e.g `%MyResource{value: 1, value: 2}`. Generally that is fine, but often with embedded resources it is nice
to be able to validate the keys that are being provided, e.g

```elixir
Resource
|> Ash.Changeset.for_create(:create, %{embedded: EmbeddedResource.input(foo: 1, bar: 2)})
|> Ash.create()
```

# `input`

```elixir
@spec input(values :: map() | Keyword.t(), action :: atom()) :: map() | no_return()
```

Same as `input/1`, except restricts the keys to values accepted by the action provided.

# `primary_key_matches?`

---

*Consult [api-reference.md](api-reference.md) for complete listing*