ash/documentation/topics/resources_without_a_data_layer.md
Zach Daniel 88168de320 improvement: add Ash.DataLayer.Simple.set_data/2
docs: add data-layer-less resource guide
2021-12-07 21:39:07 -05:00

60 lines
1.8 KiB
Markdown

# Resources without a data layer
If a resource is configured without a data layer, then it will always be working off of a temporary data set that lives only for the life of that query. This can be a powerful way to simply model input validations and/or custom/complex reads.
## Example
```elixir
defmodule MyApp.MyComplexResource do
use Ash.Resource
# notice no data layer is configured
attributes do
#A primary key is always necessary on a resource, but you can make it a uuid and fill it in on each read, if you don't have one
uuid_primary_key :id
attribute :some_complex_derived_number, :integer
end
actions do
defaults [] # You may want to include this to remove the default `:create`, `:update`, `:destroy`, and `:read` actions, since they make less sense for resources without a data layer.
read :read do
prepare MyApp.FetchComplexResources
end
create :validate_input do
...
# will validate required inputs, and you can add
# validations like you would for any normal resource
end
end
end
defmodule MyApp.FetchComplexResources do
use Ash.Resource.Preparation
def prepare(query, _, _) do
case fetch_data(query) do
{:ok, data} ->
Ash.DataLayer.Simple.set_data(query, data)
{:error, error} ->
Ash.Query.add_error(query, SomeBuiltinOrCustomAshError.exception(...))
end
end
end
```
## Usage
They are used in exactly the same way as regular resources
```elixir
# You can construct changeset over them
changeset =
Ash.Changeset.for_create(MyApp.FetchComplexResource, :validate_input, %{})
# This will simply return the structs by default
# Although you are free to do custom persistence in your resource changes
MyApp.MyApi.create!(changeset)
# %MyApp.FetchComplexResource{...}
```