Ash.Api.get

You're seeing just the callback get, go back to Ash.Api module for more information.
Link to this callback

get(resource, id_or_filter, params)

View Source

Specs

get(resource :: Ash.Resource.t(), id_or_filter :: term(), params :: Keyword.t()) ::
  {:ok, Ash.Resource.record()} | {:error, term()}

Get a record by a primary key.

For a resource with a composite primary key, pass a keyword list, e.g MyApi.get(MyResource, first_key: 1, second_key: 2)

  • :load - Fields or relationships to load in the query. See Ash.Query.load/2

  • :context - Context to be set on the query being run

  • :verbose? - Log engine operations (very verbose!) The default value is false.

  • :action - The action to use, either an Action struct or the name of the action

  • :authorize? - If an actor option is provided (even if it is nil), authorization happens automatically. If not, this flag can be used to authorize with no user.

  • :stacktraces? - For Ash errors, wether or not each error has a stacktrace. See the error_handling guide for more. The default value is true.

  • :tenant - A tenant to set on the query or changeset

  • :actor - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access