# `AshNeo4j.ResourceMapping`
[🔗](https://github.com/diffo-dev/ash_neo4j/blob/v0.6.0/lib/resource_mapping.ex#L5)

A compile-time description of how an Ash resource maps to the Neo4j graph.

`ResourceMapping` is the single source of truth for the graph shape of a resource. It is built
from persisted DSL state via `AshNeo4j.Resource.Info.mapping/1` and collects every piece of
information the data layer needs without requiring scattered calls to individual `Resource.Info`
accessors.

## Fields

- `:module` — the Ash resource module (e.g. `DiffoExample.Access.Shelf`).
- `:domain_label` — PascalCase short name of the domain module, written on CREATE
  (e.g. `:Access`).
- `:module_label` — PascalCase short name of the resource module itself, always the resource's
  own name regardless of any fragment override (e.g. `:Shelf`).
- `:label` — the label used in MATCH for reads, updates, and deletes; comes from the DSL
  `label` option and may be a fragment base-type label (e.g. `:Instance` when `Shelf` extends
  `BaseInstance`).
- `:domain_fragment_label` — optional label contributed by a domain fragment using
  `AshNeo4j.DataLayer.Domain` (e.g. `:Telco`). `nil` when the domain declares none.
- `:all_labels` — full ordered list of labels written on CREATE: `[domain_label, module_label, ...]`
  including any base-type label from a resource fragment and the domain fragment label if present
  (e.g. `[:Access, :Shelf, :Instance, :Telco]`).
- `:label_pair` — the two-label pair `[domain_label, module_label]` used in MATCH for all
  read, update, delete, and aggregate operations. Always uniquely identifies this resource.
- `:properties` — keyword list of `{ash_attribute_name, neo4j_property_name}` translations;
  insertion order is preserved.
- `:edges` — list of `AshNeo4j.EdgeDescriptor.t()` structs, one per `relate` entry.
- `:relationship_attributes` — keyword list of `{source_attribute, relationship_name}` pairs for
  attributes that hold foreign keys; used to create edges during CREATE.
- `:guards` — list of `{edge_label, direction, destination_label}` tuples that block deletion.
- `:skip` — list of relationship names excluded from automatic edge management.

# `t`

```elixir
@type t() :: %AshNeo4j.ResourceMapping{
  all_labels: [atom()],
  domain_fragment_label: atom() | nil,
  domain_label: atom(),
  edges: [AshNeo4j.EdgeDescriptor.t()],
  guards: [tuple()],
  label: atom(),
  label_pair: [atom()],
  module: atom(),
  module_label: atom(),
  properties: keyword(String.t()),
  relationship_attributes: keyword(atom()),
  skip: [atom()]
}
```

---

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