AshNeo4j.DataLayer.Info (AshNeo4j v0.4.1)

Copy Markdown View Source

Introspection helpers for AshNeo4j.DataLayer

Summary

Functions

Returns the guard DSL of the resource

Returns the label DSL of the resource. The label is the PascalCase short name of the resource's Elixir Module name by default, but can be overridden by setting the :label option in the DSL. It is used as a Neo4j label for all nodes of the resource.

Returns the relate DSL of the resource

Returns the skip DSL of the resource. The skip DSL is a list of attribute names which are not translated to node properties, either because they are transient or because they will be stored as relationships rather than properties. By default, all attributes which are the source of a 1:1 belongs_to relationship are skipped, but additional attributes can be skipped by setting the :skip option in the DSL.

Functions

guard(resource)

@spec guard(Ash.Resource.t()) :: [tuple()] | nil

Returns the guard DSL of the resource

label(resource)

@spec label(Ash.Resource.t()) :: atom() | nil

Returns the label DSL of the resource. The label is the PascalCase short name of the resource's Elixir Module name by default, but can be overridden by setting the :label option in the DSL. It is used as a Neo4j label for all nodes of the resource.

relate(resource)

@spec relate(Ash.Resource.t()) :: [tuple()] | nil

Returns the relate DSL of the resource

skip(resource)

@spec skip(Ash.Resource.t()) :: list() | nil

Returns the skip DSL of the resource. The skip DSL is a list of attribute names which are not translated to node properties, either because they are transient or because they will be stored as relationships rather than properties. By default, all attributes which are the source of a 1:1 belongs_to relationship are skipped, but additional attributes can be skipped by setting the :skip option in the DSL.