Provider API endpoint
Extensible Ash Resources and API related to Providing TMF Services and Resources
Summary
Types
TMF blessed Party type atoms accepted by the dispatcher.
TMF blessed Place type atoms accepted by the dispatcher.
Tagged source for ref dispatchers.
Functions
Activates a service instance.
Annotates an instance with a note.
Runs authorization checks for Diffo.Provider.Specification.categorise
Runs authorization checks for Diffo.Provider.Specification.categorise, returning a boolean.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.create
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.create, returning a boolean.
Runs authorization checks for Diffo.Provider.AssignmentRelationship.create
Runs authorization checks for Diffo.Provider.AssignmentRelationship.create, returning a boolean.
Runs authorization checks for Diffo.Provider.Characteristic.create
Runs authorization checks for Diffo.Provider.Characteristic.create, returning a boolean.
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.create
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.create, returning a boolean.
Runs authorization checks for Diffo.Provider.Entity.create
Runs authorization checks for Diffo.Provider.Entity.create, returning a boolean.
Runs authorization checks for Diffo.Provider.EntityRef.create
Runs authorization checks for Diffo.Provider.EntityRef.create, returning a boolean.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.create
Runs authorization checks for Diffo.Provider.ExternalIdentifier.create, returning a boolean.
Runs authorization checks for Diffo.Provider.Feature.create
Runs authorization checks for Diffo.Provider.Feature.create, returning a boolean.
Runs authorization checks for Diffo.Provider.Note.create
Runs authorization checks for Diffo.Provider.Note.create, returning a boolean.
Runs authorization checks for Diffo.Provider.PartyRef.create
Runs authorization checks for Diffo.Provider.PartyRef.create, returning a boolean.
Runs authorization checks for Diffo.Provider.PlaceRef.create
Runs authorization checks for Diffo.Provider.PlaceRef.create, returning a boolean.
Runs authorization checks for Diffo.Provider.ProcessStatus.create
Runs authorization checks for Diffo.Provider.ProcessStatus.create, returning a boolean.
Runs authorization checks for Diffo.Provider.Relationship.create
Runs authorization checks for Diffo.Provider.Relationship.create, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.create
Runs authorization checks for Diffo.Provider.Specification.create, returning a boolean.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.destroy
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.AssignmentRelationship.destroy
Runs authorization checks for Diffo.Provider.AssignmentRelationship.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.Characteristic.destroy
Runs authorization checks for Diffo.Provider.Characteristic.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.destroy
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.Entity.destroy
Runs authorization checks for Diffo.Provider.Entity.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.EntityRef.destroy
Runs authorization checks for Diffo.Provider.EntityRef.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.Event.destroy
Runs authorization checks for Diffo.Provider.Event.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.destroy
Runs authorization checks for Diffo.Provider.ExternalIdentifier.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.Feature.destroy
Runs authorization checks for Diffo.Provider.Feature.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.Note.destroy
Runs authorization checks for Diffo.Provider.Note.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.PartyRef.destroy
Runs authorization checks for Diffo.Provider.PartyRef.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.PlaceRef.destroy
Runs authorization checks for Diffo.Provider.PlaceRef.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.ProcessStatus.destroy
Runs authorization checks for Diffo.Provider.ProcessStatus.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.Relationship.destroy
Runs authorization checks for Diffo.Provider.Relationship.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.destroy
Runs authorization checks for Diffo.Provider.Specification.destroy, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.describe
Runs authorization checks for Diffo.Provider.Specification.describe, returning a boolean.
Runs authorization checks for Diffo.Provider.Entity.find_by_id
Runs authorization checks for Diffo.Provider.Entity.find_by_id, returning a boolean.
Runs authorization checks for Diffo.Provider.Entity.find_by_name
Runs authorization checks for Diffo.Provider.Entity.find_by_name, returning a boolean.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.find_by_external_id
Runs authorization checks for Diffo.Provider.ExternalIdentifier.find_by_external_id, returning a boolean.
Runs authorization checks for Diffo.Provider.Note.find_by_note_id
Runs authorization checks for Diffo.Provider.Note.find_by_note_id, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.find_by_category
Runs authorization checks for Diffo.Provider.Specification.find_by_category, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.find_by_name
Runs authorization checks for Diffo.Provider.Specification.find_by_name, returning a boolean.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.read
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.read, returning a boolean.
Runs authorization checks for Diffo.Provider.AssignmentRelationship.read
Runs authorization checks for Diffo.Provider.AssignmentRelationship.read, returning a boolean.
Runs authorization checks for Diffo.Provider.Characteristic.read
Runs authorization checks for Diffo.Provider.Characteristic.read, returning a boolean.
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.read
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.read, returning a boolean.
Runs authorization checks for Diffo.Provider.Entity.read
Runs authorization checks for Diffo.Provider.Entity.read, returning a boolean.
Runs authorization checks for Diffo.Provider.EntityRef.read
Runs authorization checks for Diffo.Provider.EntityRef.read, returning a boolean.
Runs authorization checks for Diffo.Provider.Event.read
Runs authorization checks for Diffo.Provider.Event.read, returning a boolean.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.read
Runs authorization checks for Diffo.Provider.ExternalIdentifier.read, returning a boolean.
Runs authorization checks for Diffo.Provider.Feature.read
Runs authorization checks for Diffo.Provider.Feature.read, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.get_latest
Runs authorization checks for Diffo.Provider.Specification.get_latest, returning a boolean.
Runs authorization checks for Diffo.Provider.Note.read
Runs authorization checks for Diffo.Provider.Note.read, returning a boolean.
Runs authorization checks for Diffo.Provider.PartyRef.read
Runs authorization checks for Diffo.Provider.PartyRef.read, returning a boolean.
Runs authorization checks for Diffo.Provider.PlaceRef.read
Runs authorization checks for Diffo.Provider.PlaceRef.read, returning a boolean.
Runs authorization checks for Diffo.Provider.ProcessStatus.read
Runs authorization checks for Diffo.Provider.ProcessStatus.read, returning a boolean.
Runs authorization checks for Diffo.Provider.Relationship.read
Runs authorization checks for Diffo.Provider.Relationship.read, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.read
Runs authorization checks for Diffo.Provider.Specification.read, returning a boolean.
Runs authorization checks for Diffo.Provider.Characteristic.list
Runs authorization checks for Diffo.Provider.Characteristic.list, returning a boolean.
Runs authorization checks for Diffo.Provider.Entity.list
Runs authorization checks for Diffo.Provider.Entity.list, returning a boolean.
Runs authorization checks for Diffo.Provider.EntityRef.list
Runs authorization checks for Diffo.Provider.EntityRef.list, returning a boolean.
Runs authorization checks for Diffo.Provider.EntityRef.list_entity_refs_by_entity_id
Runs authorization checks for Diffo.Provider.EntityRef.list_entity_refs_by_entity_id, returning a boolean.
Runs authorization checks for Diffo.Provider.EntityRef.list_entity_refs_by_instance_id
Runs authorization checks for Diffo.Provider.EntityRef.list_entity_refs_by_instance_id, returning a boolean.
Runs authorization checks for Diffo.Provider.Event.list
Runs authorization checks for Diffo.Provider.Event.list, returning a boolean.
Runs authorization checks for Diffo.Provider.Event.list_events_by_instance_id
Runs authorization checks for Diffo.Provider.Event.list_events_by_instance_id, returning a boolean.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list, returning a boolean.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list_external_identifiers_by_instance_id
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list_external_identifiers_by_instance_id, returning a boolean.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list_external_identifiers_by_owner_id
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list_external_identifiers_by_owner_id, returning a boolean.
Runs authorization checks for Diffo.Provider.Feature.list
Runs authorization checks for Diffo.Provider.Feature.list, returning a boolean.
Runs authorization checks for Diffo.Provider.Note.list
Runs authorization checks for Diffo.Provider.Note.list, returning a boolean.
Runs authorization checks for Diffo.Provider.Note.list_notes_by_author_id
Runs authorization checks for Diffo.Provider.Note.list_notes_by_author_id, returning a boolean.
Runs authorization checks for Diffo.Provider.Note.list_notes_by_instance_id
Runs authorization checks for Diffo.Provider.Note.list_notes_by_instance_id, returning a boolean.
Runs authorization checks for Diffo.Provider.PartyRef.list
Runs authorization checks for Diffo.Provider.PartyRef.list, returning a boolean.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_instance_id
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_instance_id, returning a boolean.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_party_id
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_party_id, returning a boolean.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_place_id
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_place_id, returning a boolean.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_source_party_id
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_source_party_id, returning a boolean.
Runs authorization checks for Diffo.Provider.PlaceRef.list
Runs authorization checks for Diffo.Provider.PlaceRef.list, returning a boolean.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_instance_id
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_instance_id, returning a boolean.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_party_id
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_party_id, returning a boolean.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_place_id
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_place_id, returning a boolean.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_source_place_id
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_source_place_id, returning a boolean.
Runs authorization checks for Diffo.Provider.ProcessStatus.list
Runs authorization checks for Diffo.Provider.ProcessStatus.list, returning a boolean.
Runs authorization checks for Diffo.Provider.ProcessStatus.list_process_statuses_by_instance_id
Runs authorization checks for Diffo.Provider.ProcessStatus.list_process_statuses_by_instance_id, returning a boolean.
Runs authorization checks for Diffo.Provider.Relationship.list
Runs authorization checks for Diffo.Provider.Relationship.list, returning a boolean.
Runs authorization checks for Diffo.Provider.Relationship.list_resource_relationships_from
Runs authorization checks for Diffo.Provider.Relationship.list_resource_relationships_from, returning a boolean.
Runs authorization checks for Diffo.Provider.Relationship.list_service_relationships_from
Runs authorization checks for Diffo.Provider.Relationship.list_service_relationships_from, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.list
Runs authorization checks for Diffo.Provider.Specification.list, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.next_minor
Runs authorization checks for Diffo.Provider.Specification.next_minor, returning a boolean.
Runs authorization checks for Diffo.Provider.Specification.next_patch
Runs authorization checks for Diffo.Provider.Specification.next_patch, returning a boolean.
Runs authorization checks for Diffo.Provider.Feature.relate_characteristics
Runs authorization checks for Diffo.Provider.Feature.relate_characteristics, returning a boolean.
Runs authorization checks for Diffo.Provider.Relationship.relate_characteristics
Runs authorization checks for Diffo.Provider.Relationship.relate_characteristics, returning a boolean.
Runs authorization checks for Diffo.Provider.Feature.unrelate_characteristics
Runs authorization checks for Diffo.Provider.Feature.unrelate_characteristics, returning a boolean.
Runs authorization checks for Diffo.Provider.Relationship.unrelate_characteristics
Runs authorization checks for Diffo.Provider.Relationship.unrelate_characteristics, returning a boolean.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.update
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.update, returning a boolean.
Runs authorization checks for Diffo.Provider.Characteristic.update
Runs authorization checks for Diffo.Provider.Characteristic.update, returning a boolean.
Runs authorization checks for Diffo.Provider.Entity.update
Runs authorization checks for Diffo.Provider.Entity.update, returning a boolean.
Runs authorization checks for Diffo.Provider.EntityRef.update
Runs authorization checks for Diffo.Provider.EntityRef.update, returning a boolean.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.update
Runs authorization checks for Diffo.Provider.ExternalIdentifier.update, returning a boolean.
Runs authorization checks for Diffo.Provider.Feature.update
Runs authorization checks for Diffo.Provider.Feature.update, returning a boolean.
Runs authorization checks for Diffo.Provider.Note.update
Runs authorization checks for Diffo.Provider.Note.update, returning a boolean.
Runs authorization checks for Diffo.Provider.PartyRef.update
Runs authorization checks for Diffo.Provider.PartyRef.update, returning a boolean.
Runs authorization checks for Diffo.Provider.PlaceRef.update
Runs authorization checks for Diffo.Provider.PlaceRef.update, returning a boolean.
Runs authorization checks for Diffo.Provider.ProcessStatus.update
Runs authorization checks for Diffo.Provider.ProcessStatus.update, returning a boolean.
Runs authorization checks for Diffo.Provider.Relationship.update
Runs authorization checks for Diffo.Provider.Relationship.update, returning a boolean.
Cancels a service instance.
updates the category
updates the category
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Returns the changeset corresponding to the action.
Calls the create action on Diffo.Provider.AssignableCharacteristic.
Calls the create action on Diffo.Provider.AssignableCharacteristic.
creates a pool assignment relationship between a source and target instance
creates a pool assignment relationship between a source and target instance
creates a characteristic
creates a characteristic
creates a defined simple relationship between a source and target instance
creates a defined simple relationship between a source and target instance
creates a entity
creates a entity
creates a entity ref, relating an instance and entity
creates a entity ref, relating an instance and entity
creates a external identifier related to an instance and optionally an owner party
creates a external identifier related to an instance and optionally an owner party
creates a feature, optionally with related characteristic
creates a feature, optionally with related characteristic
creates a note
creates a note
Same as create_party!/2 but returns {:ok, record} or {:error, error}.
Creates a typed Party subtype by dispatching on the TMF type atom.
Same as create_party_ref!/1 but returns {:ok, record} or {:error, error}.
creates a party ref, relating an instance, place or source party to a party
Creates a PartyRef from a tagged source to a target Party.
creates a party ref, relating an instance, place or source party to a party
Same as create_place!/2 but returns {:ok, record} or {:error, error}.
Creates a typed Place subtype by dispatching on the TMF type atom.
Same as create_place_ref!/1 but returns {:ok, record} or {:error, error}.
creates a place ref, relating an instance, party or source place to a place
Creates a PlaceRef from a tagged source to a target Place.
creates a place ref, relating an instance, party or source place to a place
creates a process status related to an instance
creates a process status related to an instance
creates a relationship between a source and target instance
creates a relationship between a source and target instance
creates a major version of a named serviceSpecification or resourceSpecification
creates a major version of a named serviceSpecification or resourceSpecification
Deactivates a service instance.
Calls the destroy action on Diffo.Provider.AssignableCharacteristic.
Calls the destroy action on Diffo.Provider.AssignableCharacteristic.
Calls the destroy action on Diffo.Provider.AssignmentRelationship.
Calls the destroy action on Diffo.Provider.AssignmentRelationship.
Calls the destroy action on Diffo.Provider.Characteristic.
Calls the destroy action on Diffo.Provider.Characteristic.
Calls the destroy action on Diffo.Provider.DefinedSimpleRelationship.
Calls the destroy action on Diffo.Provider.DefinedSimpleRelationship.
Calls the destroy action on Diffo.Provider.Entity.
Calls the destroy action on Diffo.Provider.Entity.
Calls the destroy action on Diffo.Provider.EntityRef.
Calls the destroy action on Diffo.Provider.EntityRef.
Calls the destroy action on Diffo.Provider.Event.
Calls the destroy action on Diffo.Provider.Event.
Calls the destroy action on Diffo.Provider.ExternalIdentifier.
Calls the destroy action on Diffo.Provider.ExternalIdentifier.
Calls the destroy action on Diffo.Provider.Feature.
Calls the destroy action on Diffo.Provider.Feature.
Deletes an instance (or a list of instances, returning an %Ash.BulkResult{}).
Calls the destroy action on Diffo.Provider.Note.
Calls the destroy action on Diffo.Provider.Note.
Same as delete_party!/1 but returns :ok or {:error, error}.
Deletes a Party record (any subtype, dispatched on its struct module).
Calls the destroy action on Diffo.Provider.PartyRef.
Calls the destroy action on Diffo.Provider.PartyRef.
Same as delete_place!/1 but returns :ok or {:error, error}.
Deletes a Place record (any subtype, dispatched on its struct module).
Calls the destroy action on Diffo.Provider.PlaceRef.
Calls the destroy action on Diffo.Provider.PlaceRef.
Calls the destroy action on Diffo.Provider.ProcessStatus.
Calls the destroy action on Diffo.Provider.ProcessStatus.
Calls the destroy action on Diffo.Provider.Relationship.
Calls the destroy action on Diffo.Provider.Relationship.
Calls the destroy action on Diffo.Provider.Specification.
Calls the destroy action on Diffo.Provider.Specification.
updates the description
updates the description
Same as feasibilityCheck_service!/2 but returns {:ok, record} or {:error, error}.
Feasibility-checks a service instance (dispatches on the record's resource).
finds entity by id
finds entity by id
finds entity by name
finds entity by name
finds external identifiers by id
finds external identifiers by id
Finds instances whose name contains the query, each projected to its concrete leaf.
Finds instances by specification id, each projected to its concrete leaf.
finds notes by id
finds notes by id
Finds Parties whose id contains the query, each projected to its concrete world.
Finds Parties whose name contains the query, each projected to its concrete world.
Finds Places whose id contains the query, each projected to its concrete world.
Finds Places whose name contains the query, each projected to its concrete world.
finds specifications by category
finds specifications by category
finds specifications by name
finds specifications by name
Fires an event on an instance, maintaining the event chain.
Calls the read action on Diffo.Provider.AssignableCharacteristic.
Calls the read action on Diffo.Provider.AssignableCharacteristic.
Calls the read action on Diffo.Provider.AssignmentRelationship.
Calls the read action on Diffo.Provider.AssignmentRelationship.
Calls the read action on Diffo.Provider.Characteristic.
Calls the read action on Diffo.Provider.Characteristic.
Calls the read action on Diffo.Provider.DefinedSimpleRelationship.
Calls the read action on Diffo.Provider.DefinedSimpleRelationship.
Calls the read action on Diffo.Provider.Entity.
Calls the read action on Diffo.Provider.Entity.
Calls the read action on Diffo.Provider.EntityRef.
Calls the read action on Diffo.Provider.EntityRef.
Calls the read action on Diffo.Provider.Event.
Calls the read action on Diffo.Provider.Event.
Calls the read action on Diffo.Provider.ExternalIdentifier.
Calls the read action on Diffo.Provider.ExternalIdentifier.
Calls the read action on Diffo.Provider.Feature.
Calls the read action on Diffo.Provider.Feature.
Same as get_instance_by_id!/2 but returns {:ok, record} or {:error, error}.
Loads an instance by id and projects it to its concrete Service/Resource leaf.
gets the serviceSpecification or resourceSpecification by name with highest major version
gets the serviceSpecification or resourceSpecification by name with highest major version
Calls the read action on Diffo.Provider.Note.
Calls the read action on Diffo.Provider.Note.
Same as get_party_by_id!/1 but returns {:ok, record} or {:error, error}.
Loads a Party by id and projects to the outermost concrete world.
Calls the read action on Diffo.Provider.PartyRef.
Calls the read action on Diffo.Provider.PartyRef.
Same as get_place_by_id!/1 but returns {:ok, record} or {:error, error}.
Loads a Place by id and projects to the outermost concrete world.
Calls the read action on Diffo.Provider.PlaceRef.
Calls the read action on Diffo.Provider.PlaceRef.
Calls the read action on Diffo.Provider.ProcessStatus.
Calls the read action on Diffo.Provider.ProcessStatus.
Calls the read action on Diffo.Provider.Relationship.
Calls the read action on Diffo.Provider.Relationship.
Calls the read action on Diffo.Provider.Specification.
Calls the read action on Diffo.Provider.Specification.
Same as lifecycle_resource!/2 but returns {:ok, record} or {:error, error}.
Sets the TMF lifecycleState of a resource instance.
lists all characteristics
lists all characteristics
lists all parties
lists all parties
lists all entity refs
lists all entity refs
lists entity refs by entity id
lists entity refs by entity id
lists entity refs by instance id
lists entity refs by instance id
lists all events
lists all events
lists events by instance id
lists events by instance id
lists all external identifiers
lists all external identifiers
lists external identifiers by instance id
lists external identifiers by instance id
lists external identifiers by owner id
lists external identifiers by owner id
lists all features
lists all features
Lists all instances, each projected to its concrete Service/Resource leaf.
lists all notes
lists all notes
lists notes by author id
lists notes by author id
lists notes by instance id
lists notes by instance id
Same as list_parties!/0 but returns {:ok, list} or {:error, error}.
Lists all Parties, each projected to its outermost concrete world.
lists all party refs
lists all party refs
lists party refs by instance id
lists party refs by instance id
lists party refs by party id
lists party refs by party id
lists party refs by place id
lists party refs by place id
lists party refs by source_party id
lists party refs by source_party id
Lists PartyRefs whose source matches the given Instance/Place/Party.
Lists PartyRefs targeting the given Party.
lists all place refs
lists all place refs
lists place refs by instance id
lists place refs by instance id
lists place refs by party id
lists place refs by party id
lists place refs by place id
lists place refs by place id
lists place refs by source_place id
lists place refs by source_place id
Lists PlaceRefs whose source matches the given Instance/Party/Place.
Lists PlaceRefs targeting the given Place.
Same as list_places!/0 but returns {:ok, list} or {:error, error}.
Lists all Places, each projected to its outermost concrete world.
lists all process statuses
lists all process statuses
lists process statuses by instance id
lists process statuses by instance id
lists all relationships
lists all relationships
lists resource relationships from the instance
lists resource relationships from the instance
lists service relationships from the instance
lists service relationships from the instance
lists all serviceSpecification and resourceSpecification
lists all serviceSpecification and resourceSpecification
Renames an instance.
increments the minor version and resets the patch version
increments the minor version and resets the patch version
increments the patch version
increments the patch version
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
Returns the query corresponding to the action.
relates characteristics to the feature
relates characteristics to the feature
Relates characteristics to an instance.
Relates features to an instance.
relates characteristics to the relationship
relates characteristics to the relationship
Reserves a service instance.
Respecifies an instance (changes its specification).
Updates the operating status of a service instance.
Suspends a service instance.
Terminates a service instance.
unrelates characteristics from the feature
unrelates characteristics from the feature
Unrelates characteristics from an instance.
Unrelates features from an instance.
unrelates characteristic from the relationship
unrelates characteristic from the relationship
Calls the update action on Diffo.Provider.AssignableCharacteristic.
Calls the update action on Diffo.Provider.AssignableCharacteristic.
updates the characteristic value or instance, feature or relationship
updates the characteristic value or instance, feature or relationship
updates the entity
updates the entity
updates the entity ref role
updates the entity ref role
updates the external identifier
updates the external identifier
updates the feature isEnabled or instance relationship
updates the feature isEnabled or instance relationship
updates the note, touching the timestamp
updates the note, touching the timestamp
Same as update_party!/2 but returns {:ok, record} or {:error, error}.
Updates a Party by dispatching on the record's struct module.
updates the party ref role
updates the party ref role
Same as update_place!/2 but returns {:ok, record} or {:error, error}.
Updates a Place by dispatching on the record's struct module.
updates the place ref role
updates the place ref role
updates a process status, touching the timestamp
updates a process status, touching the timestamp
updates the relationship type and/or alias
updates the relationship type and/or alias
Types
@type party_type() :: :Organization | :Individual | :PartyRef | :Entity
TMF blessed Party type atoms accepted by the dispatcher.
:PartyRef and :Entity route to the abstract Provider.Party's :create
action (no subtype-specific attributes). :PartyRef is the "placeholder Party"
type — a record with referred_type: set, used as the target of a PartyRef
to an externally-managed Party. :Entity is diffo's extension to the TMF
type enum for party-like aggregates that aren't strictly Organization or
Individual.
@type place_type() ::
:GeographicAddress | :GeographicSite | :GeographicLocation | :PlaceRef
TMF blessed Place type atoms accepted by the dispatcher.
:PlaceRef is the "placeholder Place" type — a record with referred_type:
set, used as the target of a PlaceRef to an externally-managed Place.
Dispatches to the abstract Provider.Place's :create action (no
subtype-specific attributes).
@type tagged_source() :: {:instance | :party | :place, String.t()}
Tagged source for ref dispatchers.
Functions
Activates a service instance.
Annotates an instance with a note.
@spec can( action_or_query_or_changeset :: Ash.Query.t() | Ash.Changeset.t() | {Ash.Resource.t(), atom() | Ash.Resource.Actions.action()}, actor :: term(), opts :: Keyword.t() ) :: {:ok, boolean() | :maybe} | {:ok, true, Ash.Changeset.t() | Ash.Query.t()} | {:ok, true, Ash.Changeset.t(), Ash.Query.t()} | {:ok, false, Exception.t()} | {:error, term()}
@spec can?( query_or_changeset_or_action :: Ash.Query.t() | Ash.Changeset.t() | {Ash.Resource.t(), atom() | Ash.Resource.Actions.action()}, actor :: term(), opts :: Keyword.t() ) :: boolean() | no_return()
Runs authorization checks for Diffo.Provider.Specification.categorise
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.categorise, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignmentRelationship.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignmentRelationship.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.create
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.create, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignmentRelationship.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignmentRelationship.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Event.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Event.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.destroy
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.destroy, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.describe
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.describe, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.find_by_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.find_by_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.find_by_name
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.find_by_name, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.find_by_external_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.find_by_external_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.find_by_note_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.find_by_note_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.find_by_category
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.find_by_category, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.find_by_name
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.find_by_name, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignmentRelationship.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignmentRelationship.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.DefinedSimpleRelationship.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Event.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Event.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.get_latest
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.get_latest, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.read
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.read, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.list_entity_refs_by_entity_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.list_entity_refs_by_entity_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.list_entity_refs_by_instance_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.list_entity_refs_by_instance_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Event.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Event.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Event.list_events_by_instance_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Event.list_events_by_instance_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list_external_identifiers_by_instance_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list_external_identifiers_by_instance_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list_external_identifiers_by_owner_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.list_external_identifiers_by_owner_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.list_notes_by_author_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.list_notes_by_author_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.list_notes_by_instance_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.list_notes_by_instance_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_instance_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_instance_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_party_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_party_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_place_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_place_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_source_party_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.list_party_refs_by_source_party_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_instance_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_instance_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_party_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_party_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_place_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_place_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_source_place_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.list_place_refs_by_source_place_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.list_process_statuses_by_instance_id
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.list_process_statuses_by_instance_id, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.list_resource_relationships_from
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.list_resource_relationships_from, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.list_service_relationships_from
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.list_service_relationships_from, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.list
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.list, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.next_minor
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.next_minor, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.next_patch
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Specification.next_patch, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.relate_characteristics
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.relate_characteristics, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.relate_characteristics
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.relate_characteristics, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.unrelate_characteristics
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.unrelate_characteristics, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.unrelate_characteristics
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.unrelate_characteristics, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.AssignableCharacteristic.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Characteristic.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Entity.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.EntityRef.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ExternalIdentifier.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Feature.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Note.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PartyRef.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.PlaceRef.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.ProcessStatus.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.update
See Ash.can/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Runs authorization checks for Diffo.Provider.Relationship.update, returning a boolean.
See Ash.can?/3 for more information
Options
:maybe_is(term/0) - If the actor may be able to perform the action, what value should be returned. The default value is:maybe.:filter_with- If set to:error, the query will raise an error on a match. If set to:filterthe query will filter out unauthorized access. Valid values are :filter, :error The default value is:filter.:validate?(boolean/0) - Whether or not to treat an invalid action as a non-allowed action. The default value isfalse.:reuse_values?(boolean/0) - Whether or not loaded data like aggregates, calculations and relationships should be checked in memory if possible, instead of querying. No effect ifpre_flight?isfalse. The default value isfalse.:pre_flight?(boolean/0) - Whether or not this is a pre_flight check (which may perform optimized in-memory checks) or the final proper check. The default value istrue.:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol. Provides a default tenant and deep merges context (explicit opts take precedence). The actor is always taken from the second argument tocan/3. SeeAsh.Scopefor more.:context(map/0) - Context to set on the query/changeset/action_input being authorized:run_queries?(boolean/0) - Whether or not to run queries. If set totrue,:maybewill not be returned. The default value istrue.:data- The record or records specifically attempting to be acted upon.:tenant(value that implements theAsh.ToTenantprotocol) - The tenant to use for authorization:alter_source?(boolean/0) - If set totrue, the source being authorized is returned so it can be run. The default value isfalse.:base_query(term/0) - A base query on which to apply an generated filters:no_check?(boolean/0) - Whether or not authorization must pass at the strict/filter step, or if post-checks are allowed to be run The default value isfalse.:on_must_pass_strict_check(term/0) - Override the value returned whenno_check?istruebut a check must be run.:atomic_changeset(term/0) - A base query on which to apply an generated filters:return_forbidden_error?(boolean/0) - Whether or not to return a forbidden error in cases of not being authorized. The default value isfalse.:log?(boolean/0) - Whether or not to log the authorization result. The default value isfalse.:log_policy_breakdown?(boolean/0) - If set tofalse, suppresses policy breakdown logs, overriding the globalshow_policy_breakdowns?configuration.
Cancels a service instance.
updates the category
Inputs
- category - the category of the service or resource specified by a major version of this specification
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the category
Raises any errors instead of returning them
Inputs
- category - the category of the service or resource specified by a major version of this specification
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:changeset(term/0) - A changeset to seed the action with.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Returns the changeset corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.
Calls the create action on Diffo.Provider.AssignableCharacteristic.
Inputs
- first - the first assignable value in the pool
- name - the role name of this characteristic on the owning instance or feature
- last - the last assignable value in the pool
- algorithm - the selection algorithm for auto-assign
- instance_id
- thing - the kind of item being assigned (e.g. :slot, :port); set from the pool declaration at build time
- assignable_type - the type label of the assignable thing (e.g. "ADSL2+")
- feature_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the create action on Diffo.Provider.AssignableCharacteristic.
Raises any errors instead of returning them
Inputs
- first - the first assignable value in the pool
- name - the role name of this characteristic on the owning instance or feature
- last - the last assignable value in the pool
- algorithm - the selection algorithm for auto-assign
- instance_id
- thing - the kind of item being assigned (e.g. :slot, :port); set from the pool declaration at build time
- assignable_type - the type label of the assignable thing (e.g. "ADSL2+")
- feature_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a pool assignment relationship between a source and target instance
Inputs
- alias - the alias of this assignment, used by the consuming instance to name the slot
- value - the assigned integer value
- pool - the pool name this assignment belongs to (e.g. :ports)
- thing - the kind of thing being assigned (e.g. :port)
- source_id
- target_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a pool assignment relationship between a source and target instance
Raises any errors instead of returning them
Inputs
- alias - the alias of this assignment, used by the consuming instance to name the slot
- value - the assigned integer value
- pool - the pool name this assignment belongs to (e.g. :ports)
- thing - the kind of thing being assigned (e.g. :port)
- source_id
- target_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a characteristic
Inputs
- name - the name of this characteristic
- type - the type of the characteristic
- value - the value of the characteristic
- values - the array of values of the characteristic
- is_array - true when this characteristic holds an array of values; defaults false
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a characteristic
Raises any errors instead of returning them
Inputs
- name - the name of this characteristic
- type - the type of the characteristic
- value - the value of the characteristic
- values - the array of values of the characteristic
- is_array - true when this characteristic holds an array of values; defaults false
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a defined simple relationship between a source and target instance
Inputs
- alias - an optional alias for this relationship
- type - the type of the relationship from the source to the target
- characteristic - an optional single defining characteristic, set at creation and closed thereafter
- source_id
- target_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a defined simple relationship between a source and target instance
Raises any errors instead of returning them
Inputs
- alias - an optional alias for this relationship
- type - the type of the relationship from the source to the target
- characteristic - an optional single defining characteristic, set at creation and closed thereafter
- source_id
- target_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a entity
Inputs
- id - the unique id of the entity
- name - the name of the entity
- type - the type of the entity
- href - the href of the entity
- referred_type - the type of the entity
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a entity
Raises any errors instead of returning them
Inputs
- id - the unique id of the entity
- name - the name of the entity
- type - the type of the entity
- href - the href of the entity
- referred_type - the type of the entity
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a entity ref, relating an instance and entity
Inputs
- role - the role of the entity to the instance
- instance_id
- entity_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a entity ref, relating an instance and entity
Raises any errors instead of returning them
Inputs
- role - the role of the entity to the instance
- instance_id
- entity_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a external identifier related to an instance and optionally an owner party
Inputs
- type - the type of this external identifier, this is an optional value
- instance_id
- owner_id
- external_id - the id of the external identifier, this is an optional value
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a external identifier related to an instance and optionally an owner party
Raises any errors instead of returning them
Inputs
- type - the type of this external identifier, this is an optional value
- instance_id
- owner_id
- external_id - the id of the external identifier, this is an optional value
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a feature, optionally with related characteristic
Inputs
- name - the name of this feature
- characteristics
- isEnabled - indicates whether the feature is enabled
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a feature, optionally with related characteristic
Raises any errors instead of returning them
Inputs
- name - the name of this feature
- characteristics
- isEnabled - indicates whether the feature is enabled
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a note
Inputs
- text - the text of this note, this is a mandatory value
- instance_id
- author_id
- note_id - the id of the note, this is an optional value
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a note
Raises any errors instead of returning them
Inputs
- text - the text of this note, this is a mandatory value
- instance_id
- author_id
- note_id - the id of the note, this is an optional value
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
@spec create_party(party_type(), map()) :: {:ok, Ash.Resource.record()} | {:error, term()}
Same as create_party!/2 but returns {:ok, record} or {:error, error}.
@spec create_party!(party_type(), map()) :: Ash.Resource.record()
Creates a typed Party subtype by dispatching on the TMF type atom.
Raises ArgumentError for unknown types — consumer-specific shapes go
through consumer domains.
@spec create_party_ref(map()) :: {:ok, Ash.Resource.record()} | {:error, term()}
Same as create_party_ref!/1 but returns {:ok, record} or {:error, error}.
creates a party ref, relating an instance, place or source party to a party
Inputs
- role - the role of the party to the instance, place or source party
- instance_id
- place_id
- party_id
- source_party_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
@spec create_party_ref!(map()) :: Ash.Resource.record()
Creates a PartyRef from a tagged source to a target Party.
Source forms
source: {:instance, "INST-001"}
source: {:place, "PLACE-001"}
source: {:party, "PARTY-001"}
source: some_instance_struct
source: some_place_struct
source: some_party_structcreates a party ref, relating an instance, place or source party to a party
Raises any errors instead of returning them
Inputs
- role - the role of the party to the instance, place or source party
- instance_id
- place_id
- party_id
- source_party_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
@spec create_place(place_type(), map()) :: {:ok, Ash.Resource.record()} | {:error, term()}
Same as create_place!/2 but returns {:ok, record} or {:error, error}.
@spec create_place!(place_type(), map()) :: Ash.Resource.record()
Creates a typed Place subtype by dispatching on the TMF type atom.
Raises ArgumentError for unknown types — consumer-specific shapes go
through consumer domains.
@spec create_place_ref(map()) :: {:ok, Ash.Resource.record()} | {:error, term()}
Same as create_place_ref!/1 but returns {:ok, record} or {:error, error}.
creates a place ref, relating an instance, party or source place to a place
Inputs
- role - the role of the place to the instance, party or source place
- instance_id
- place_id
- party_id
- source_place_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
@spec create_place_ref!(map()) :: Ash.Resource.record()
Creates a PlaceRef from a tagged source to a target Place.
Source forms
source: {:instance, "INST-001"}
source: {:party, "PARTY-001"}
source: {:place, "PLACE-001"}
source: some_instance_struct
source: some_party_struct
source: some_place_structTarget forms
target: "LOC-001"
target: some_place_structcreates a place ref, relating an instance, party or source place to a place
Raises any errors instead of returning them
Inputs
- role - the role of the place to the instance, party or source place
- instance_id
- place_id
- party_id
- source_place_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a process status related to an instance
Inputs
- code - the code of this process status, this is a mandatory value
- message - the message of this process status, this is a mandatory value
- severity - the severity of this process status, this is a mandatory value
- instance_id
- parameterized_message - the parameterized message of this process status, this is an optional value
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a process status related to an instance
Raises any errors instead of returning them
Inputs
- code - the code of this process status, this is a mandatory value
- message - the message of this process status, this is a mandatory value
- severity - the severity of this process status, this is a mandatory value
- instance_id
- parameterized_message - the parameterized message of this process status, this is an optional value
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a relationship between a source and target instance
Inputs
- alias - the alias of this relationship, used for supporting service or resource
- type - the type of the relationship from the source to the target
- characteristics
- source_id
- target_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a relationship between a source and target instance
Raises any errors instead of returning them
Inputs
- alias - the alias of this relationship, used for supporting service or resource
- type - the type of the relationship from the source to the target
- characteristics
- source_id
- target_id
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a major version of a named serviceSpecification or resourceSpecification
Inputs
- id - a uuid4, unique to a major version of this specification and common across all environments, generated by default
- minor_version - the minor version, defaults 0
- name - the generic name of the service or resource specified by any version of this specification, e.g. adslAccess
- type - indicates whether a serviceSpecification or resourceSpecification, defaults serviceSpecification
- description - a description of the service or resource specified by a major version of this specification
- major_version - the major version, defaults 1
- category - the category of the service or resource specified by a major version of this specification
- patch_version - the patch version, defaults 0
- tmf_version - the TMF version of the specified service or resource, e.g. v4
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
creates a major version of a named serviceSpecification or resourceSpecification
Raises any errors instead of returning them
Inputs
- id - a uuid4, unique to a major version of this specification and common across all environments, generated by default
- minor_version - the minor version, defaults 0
- name - the generic name of the service or resource specified by any version of this specification, e.g. adslAccess
- type - indicates whether a serviceSpecification or resourceSpecification, defaults serviceSpecification
- description - a description of the service or resource specified by a major version of this specification
- major_version - the major version, defaults 1
- category - the category of the service or resource specified by a major version of this specification
- patch_version - the patch version, defaults 0
- tmf_version - the TMF version of the specified service or resource, e.g. v4
Options
:upsert?(boolean/0) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse.:return_skipped_upsert?(boolean/0) - Iftrue, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse.:upsert_identity(atom/0) - The identity to use when detecting conflicts forupsert?, e.g.upsert_identity: :full_name. By default, the primary key is used. Has no effect ifupsert?: trueis not provided:upsert_fields- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition(term/0) - An expression to check if the record should be updated when there's a conflict.:touch_update_defaults?(boolean/0) - Whether or not to apply update defaults (likeupdated_attimestamps) on upsert. Only relevant whenupsert?: trueis set. Set tofalseto skip touching update_default fields when an upsert results in an update. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:changeset(term/0) - A changeset to seed the action with.:bulk_options(keyword/0) - Options passed toAsh.bulk_create, if a list or stream of inputs is provided.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:after_action(function of arity 2) - An after_action hook to be added to each processed changeset:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Deactivates a service instance.
Calls the destroy action on Diffo.Provider.AssignableCharacteristic.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.AssignableCharacteristic.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.AssignmentRelationship.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.AssignmentRelationship.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Characteristic.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Characteristic.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.DefinedSimpleRelationship.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.DefinedSimpleRelationship.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Entity.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Entity.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.EntityRef.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.EntityRef.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Event.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Event.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.ExternalIdentifier.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.ExternalIdentifier.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Feature.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Feature.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Deletes an instance (or a list of instances, returning an %Ash.BulkResult{}).
Calls the destroy action on Diffo.Provider.Note.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Note.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
@spec delete_party(Ash.Resource.record() | [Ash.Resource.record()]) :: :ok | {:error, term()} | Ash.BulkResult.t()
Same as delete_party!/1 but returns :ok or {:error, error}.
Accepts either a single record or a list of records (returns
%Ash.BulkResult{} for lists).
@spec delete_party!(Ash.Resource.record()) :: :ok
Deletes a Party record (any subtype, dispatched on its struct module).
Calls the destroy action on Diffo.Provider.PartyRef.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.PartyRef.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
@spec delete_place(Ash.Resource.record() | [Ash.Resource.record()]) :: :ok | {:error, term()} | Ash.BulkResult.t()
Same as delete_place!/1 but returns :ok or {:error, error}.
Accepts either a single record or a list of records (returns
%Ash.BulkResult{} for lists).
@spec delete_place!(Ash.Resource.record()) :: :ok
Deletes a Place record (any subtype, dispatched on its struct module).
Calls the destroy action on Diffo.Provider.PlaceRef.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.PlaceRef.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.ProcessStatus.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.ProcessStatus.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Relationship.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Relationship.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Specification.
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the destroy action on Diffo.Provider.Specification.
Raises any errors instead of returning them
Options
:return_destroyed?(boolean/0) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}or{:ok, destroyed, notifications}The default value isfalse.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_destroy, if a query, list, or stream of inputs is provided.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the description
Inputs
- description - a description of the service or resource specified by a major version of this specification
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the description
Raises any errors instead of returning them
Inputs
- description - a description of the service or resource specified by a major version of this specification
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Same as feasibilityCheck_service!/2 but returns {:ok, record} or {:error, error}.
Feasibility-checks a service instance (dispatches on the record's resource).
finds entity by id
Arguments
- query - Return only entities with id including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
finds entity by id
Raises any errors instead of returning them
Arguments
- query - Return only entities with id including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
finds entity by name
Arguments
- query - Return only entities with names including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
finds entity by name
Raises any errors instead of returning them
Arguments
- query - Return only entities with names including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
finds external identifiers by id
Arguments
- query - Return only external identifiers with id's including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
finds external identifiers by id
Raises any errors instead of returning them
Arguments
- query - Return only external identifiers with id's including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
@spec find_instances_by_name!(String.t()) :: [Ash.Resource.record()]
Finds instances whose name contains the query, each projected to its concrete leaf.
@spec find_instances_by_specification_id!(String.t()) :: [Ash.Resource.record()]
Finds instances by specification id, each projected to its concrete leaf.
finds notes by id
Arguments
- query - Return only notes with id's including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
finds notes by id
Raises any errors instead of returning them
Arguments
- query - Return only notes with id's including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
@spec find_parties_by_id!(String.t()) :: [Ash.Resource.record()]
Finds Parties whose id contains the query, each projected to its concrete world.
@spec find_parties_by_name!(String.t()) :: [Ash.Resource.record()]
Finds Parties whose name contains the query, each projected to its concrete world.
@spec find_places_by_id!(String.t()) :: [Ash.Resource.record()]
Finds Places whose id contains the query, each projected to its concrete world.
@spec find_places_by_name!(String.t()) :: [Ash.Resource.record()]
Finds Places whose name contains the query, each projected to its concrete world.
finds specifications by category
Arguments
- query - Return only specifications with category including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
finds specifications by category
Raises any errors instead of returning them
Arguments
- query - Return only specifications with category including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
finds specifications by name
Arguments
- query - Return only specifications with names including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
finds specifications by name
Raises any errors instead of returning them
Arguments
- query - Return only specifications with names including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Fires an event on an instance, maintaining the event chain.
Calls the read action on Diffo.Provider.AssignableCharacteristic.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.AssignableCharacteristic.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.AssignmentRelationship.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.AssignmentRelationship.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Characteristic.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Characteristic.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.DefinedSimpleRelationship.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.DefinedSimpleRelationship.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Entity.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Entity.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.EntityRef.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.EntityRef.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Event.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Event.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.ExternalIdentifier.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.ExternalIdentifier.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Feature.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Feature.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
@spec get_instance_by_id( String.t(), keyword() ) :: {:ok, Ash.Resource.record()} | {:error, term()}
Same as get_instance_by_id!/2 but returns {:ok, record} or {:error, error}.
@spec get_instance_by_id!( String.t(), keyword() ) :: Ash.Resource.record()
Loads an instance by id and projects it to its concrete Service/Resource leaf.
Accepts a :load opt applied to the projected leaf (e.g. load: [:event]).
gets the serviceSpecification or resourceSpecification by name with highest major version
Arguments
- query - Return only specifications with names including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
gets the serviceSpecification or resourceSpecification by name with highest major version
Raises any errors instead of returning them
Arguments
- query - Return only specifications with names including the given value.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Note.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Note.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
@spec get_party_by_id(String.t()) :: {:ok, Ash.Resource.record()} | {:error, term()}
Same as get_party_by_id!/1 but returns {:ok, record} or {:error, error}.
@spec get_party_by_id!(String.t()) :: Ash.Resource.record()
Loads a Party by id and projects to the outermost concrete world.
Returns the concrete subtype struct (Provider.Organization,
Provider.Individual, MyApp.Carrier, etc.) or the abstract
Provider.Party if no concrete world resolves.
Calls the read action on Diffo.Provider.PartyRef.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.PartyRef.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
@spec get_place_by_id(String.t()) :: {:ok, Ash.Resource.record()} | {:error, term()}
Same as get_place_by_id!/1 but returns {:ok, record} or {:error, error}.
@spec get_place_by_id!(String.t()) :: Ash.Resource.record()
Loads a Place by id and projects to the outermost concrete world.
Returns the concrete subtype struct (Provider.GeographicSite,
MyApp.SydneyExchange, etc.) or the abstract Provider.Place if no
concrete world resolves.
Calls the read action on Diffo.Provider.PlaceRef.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.PlaceRef.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.ProcessStatus.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.ProcessStatus.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Relationship.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Relationship.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Specification.
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Calls the read action on Diffo.Provider.Specification.
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Same as lifecycle_resource!/2 but returns {:ok, record} or {:error, error}.
Sets the TMF lifecycleState of a resource instance.
lists all characteristics
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all characteristics
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all parties
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all parties
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all entity refs
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all entity refs
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists entity refs by entity id
Arguments
- entity_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists entity refs by entity id
Raises any errors instead of returning them
Arguments
- entity_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists entity refs by instance id
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists entity refs by instance id
Raises any errors instead of returning them
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all events
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all events
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists events by instance id
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists events by instance id
Raises any errors instead of returning them
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all external identifiers
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all external identifiers
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists external identifiers by instance id
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists external identifiers by instance id
Raises any errors instead of returning them
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists external identifiers by owner id
Arguments
- owner_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists external identifiers by owner id
Raises any errors instead of returning them
Arguments
- owner_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all features
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all features
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
@spec list_instances!() :: [Ash.Resource.record()]
Lists all instances, each projected to its concrete Service/Resource leaf.
lists all notes
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all notes
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists notes by author id
Arguments
- author_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists notes by author id
Raises any errors instead of returning them
Arguments
- author_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists notes by instance id
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists notes by instance id
Raises any errors instead of returning them
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
@spec list_parties() :: {:ok, [Ash.Resource.record()]} | {:error, term()}
Same as list_parties!/0 but returns {:ok, list} or {:error, error}.
@spec list_parties!() :: [Ash.Resource.record()]
Lists all Parties, each projected to its outermost concrete world.
lists all party refs
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all party refs
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists party refs by instance id
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists party refs by instance id
Raises any errors instead of returning them
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists party refs by party id
Arguments
- party_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists party refs by party id
Raises any errors instead of returning them
Arguments
- party_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists party refs by place id
Arguments
- place_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists party refs by place id
Raises any errors instead of returning them
Arguments
- place_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists party refs by source_party id
Arguments
- source_party_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists party refs by source_party id
Raises any errors instead of returning them
Arguments
- source_party_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
@spec list_party_refs_from(tagged_source() | Ash.Resource.record()) :: [ Ash.Resource.record() ]
Lists PartyRefs whose source matches the given Instance/Place/Party.
@spec list_party_refs_targeting(String.t() | Ash.Resource.record()) :: [ Ash.Resource.record() ]
Lists PartyRefs targeting the given Party.
lists all place refs
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all place refs
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists place refs by instance id
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists place refs by instance id
Raises any errors instead of returning them
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists place refs by party id
Arguments
- party_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists place refs by party id
Raises any errors instead of returning them
Arguments
- party_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists place refs by place id
Arguments
- place_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists place refs by place id
Raises any errors instead of returning them
Arguments
- place_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists place refs by source_place id
Arguments
- source_place_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists place refs by source_place id
Raises any errors instead of returning them
Arguments
- source_place_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
@spec list_place_refs_from(tagged_source() | Ash.Resource.record()) :: [ Ash.Resource.record() ]
Lists PlaceRefs whose source matches the given Instance/Party/Place.
@spec list_place_refs_targeting(String.t() | Ash.Resource.record()) :: [ Ash.Resource.record() ]
Lists PlaceRefs targeting the given Place.
@spec list_places() :: {:ok, [Ash.Resource.record()]} | {:error, term()}
Same as list_places!/0 but returns {:ok, list} or {:error, error}.
@spec list_places!() :: [Ash.Resource.record()]
Lists all Places, each projected to its outermost concrete world.
lists all process statuses
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all process statuses
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists process statuses by instance id
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists process statuses by instance id
Raises any errors instead of returning them
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all relationships
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all relationships
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists resource relationships from the instance
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists resource relationships from the instance
Raises any errors instead of returning them
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists service relationships from the instance
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists service relationships from the instance
Raises any errors instead of returning them
Arguments
- instance_id
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all serviceSpecification and resourceSpecification
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
lists all serviceSpecification and resourceSpecification
Raises any errors instead of returning them
Options
:page- Pagination options, seeAsh.read/2for more.:load(term/0) - A load statement to add onto the query:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2. The default value isfalse.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.:not_found_error?(boolean/0) - Whether or not to return or raise aNotFounderror or to returnnilwhen a get? action/interface is called.:stream?(boolean/0) - If true, a stream of the results will be returned The default value isfalse.:stream_options(keyword/0) - Options passed toAsh.stream!, ifstream?: trueis given:batch_size(integer/0) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.
Renames an instance.
increments the minor version and resets the patch version
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
increments the minor version and resets the patch version
Raises any errors instead of returning them
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
increments the patch version
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
increments the patch version
Raises any errors instead of returning them
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
Returns the query corresponding to the action.
Options
:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:query- A query to seed the action with.
relates characteristics to the feature
Inputs
- characteristics
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
relates characteristics to the feature
Raises any errors instead of returning them
Inputs
- characteristics
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Relates characteristics to an instance.
Relates features to an instance.
relates characteristics to the relationship
Inputs
- characteristics
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
relates characteristics to the relationship
Raises any errors instead of returning them
Inputs
- characteristics
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Reserves a service instance.
Respecifies an instance (changes its specification).
Updates the operating status of a service instance.
Suspends a service instance.
Terminates a service instance.
unrelates characteristics from the feature
Inputs
- characteristics
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
unrelates characteristics from the feature
Raises any errors instead of returning them
Inputs
- characteristics
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Unrelates characteristics from an instance.
Unrelates features from an instance.
unrelates characteristic from the relationship
Inputs
- characteristics
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
unrelates characteristic from the relationship
Raises any errors instead of returning them
Inputs
- characteristics
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the update action on Diffo.Provider.AssignableCharacteristic.
Inputs
- first - the first assignable value in the pool
- last - the last assignable value in the pool
- algorithm - the selection algorithm for auto-assign
- assignable_type - the type label of the assignable thing (e.g. "ADSL2+")
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
Calls the update action on Diffo.Provider.AssignableCharacteristic.
Raises any errors instead of returning them
Inputs
- first - the first assignable value in the pool
- last - the last assignable value in the pool
- algorithm - the selection algorithm for auto-assign
- assignable_type - the type label of the assignable thing (e.g. "ADSL2+")
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the characteristic value or instance, feature or relationship
Inputs
- value - the value of the characteristic
- values - the array of values of the characteristic
- instance_id
- feature_id
- relationship_id
- is_array - true when this characteristic holds an array of values; defaults false
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the characteristic value or instance, feature or relationship
Raises any errors instead of returning them
Inputs
- value - the value of the characteristic
- values - the array of values of the characteristic
- instance_id
- feature_id
- relationship_id
- is_array - true when this characteristic holds an array of values; defaults false
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the entity
Inputs
- name - the name of the entity
- type - the type of the entity
- href - the href of the entity
- referred_type - the type of the entity
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the entity
Raises any errors instead of returning them
Inputs
- name - the name of the entity
- type - the type of the entity
- href - the href of the entity
- referred_type - the type of the entity
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the entity ref role
Inputs
- role - the role of the entity to the instance
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the entity ref role
Raises any errors instead of returning them
Inputs
- role - the role of the entity to the instance
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the external identifier
Inputs
- type - the type of this external identifier, this is an optional value
- instance_id
- owner_id
- external_id - the id of the external identifier, this is an optional value
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the external identifier
Raises any errors instead of returning them
Inputs
- type - the type of this external identifier, this is an optional value
- instance_id
- owner_id
- external_id - the id of the external identifier, this is an optional value
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the feature isEnabled or instance relationship
Inputs
- instance_id
- isEnabled - indicates whether the feature is enabled
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the feature isEnabled or instance relationship
Raises any errors instead of returning them
Inputs
- instance_id
- isEnabled - indicates whether the feature is enabled
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the note, touching the timestamp
Inputs
- text - the text of this note, this is a mandatory value
- instance_id
- author_id
- note_id - the id of the note, this is an optional value
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the note, touching the timestamp
Raises any errors instead of returning them
Inputs
- text - the text of this note, this is a mandatory value
- instance_id
- author_id
- note_id - the id of the note, this is an optional value
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
@spec update_party(Ash.Resource.record(), map()) :: {:ok, Ash.Resource.record()} | {:error, term()}
Same as update_party!/2 but returns {:ok, record} or {:error, error}.
@spec update_party!(Ash.Resource.record(), map()) :: Ash.Resource.record()
Updates a Party by dispatching on the record's struct module.
Cascade leaves (Provider.Organization/Individual) update via their
:define action; the abstract Provider.Party updates via its inherited
:update action.
updates the party ref role
Inputs
- role - the role of the party to the instance, place or source party
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the party ref role
Raises any errors instead of returning them
Inputs
- role - the role of the party to the instance, place or source party
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
@spec update_place(Ash.Resource.record(), map()) :: {:ok, Ash.Resource.record()} | {:error, term()}
Same as update_place!/2 but returns {:ok, record} or {:error, error}.
@spec update_place!(Ash.Resource.record(), map()) :: Ash.Resource.record()
Updates a Place by dispatching on the record's struct module.
Cascade leaves (Provider.GeographicAddress/Site/Location) update via
their :define action; the abstract Provider.Place updates via its
inherited :update action.
updates the place ref role
Inputs
- role - the role of the place to the instance, party or source place
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the place ref role
Raises any errors instead of returning them
Inputs
- role - the role of the place to the instance, party or source place
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates a process status, touching the timestamp
Inputs
- code - the code of this process status, this is a mandatory value
- message - the message of this process status, this is a mandatory value
- severity - the severity of this process status, this is a mandatory value
- parameterized_message - the parameterized message of this process status, this is an optional value
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates a process status, touching the timestamp
Raises any errors instead of returning them
Inputs
- code - the code of this process status, this is a mandatory value
- message - the message of this process status, this is a mandatory value
- severity - the severity of this process status, this is a mandatory value
- parameterized_message - the parameterized message of this process status, this is an optional value
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the relationship type and/or alias
Inputs
- alias - the alias of this relationship, used for supporting service or resource
- type - the type of the relationship from the source to the target
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.
updates the relationship type and/or alias
Raises any errors instead of returning them
Inputs
- alias - the alias of this relationship, used for supporting service or resource
- type - the type of the relationship from the source to the target
Options
:params(map/0) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?(boolean/0) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue.:timeout(timeout/0) - A positive integer, or:infinity. If none is provided, the timeout configured on the domain is used.:tracer(one or a list of module that adoptsAsh.Tracer) - A tracer that implements theAsh.Tracerbehaviour. See that module for more.:action(term/0) - The action to use, either an Action struct or the name of the action:authorize?- If an actor option is provided (even if it isnil), authorization happens automatically. If not, this flag can be used to authorize with no user.:context(map/0) - Context to set on the query, changeset, or input:tenant(value that implements theAsh.ToTenantprotocol) - A tenant to set on the query or changeset:actor(term/0) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:scope(term/0) - A value that implements theAsh.Scope.ToOptsprotocol, for passing around actor/tenant/context in a single value. SeeAsh.Scope.ToOptsfor more.:return_notifications?(boolean/0) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}(or{:ok, notifications})
To send notifications later, useAsh.Notifier.notify(notifications). It sends any notifications that can be sent, and returns the rest. The default value isfalse.:rollback_on_error?(boolean/0) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? falsethis option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue.:notification_metadata(term/0) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}.:skip_unknown_inputs- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*to indicate all unknown keys.:load(term/0) - A load statement to add onto the changeset:bulk_options(keyword/0) - Options passed toAsh.bulk_update, if a query, list, or stream of inputs is provided.:atomic_update(map/0) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3for more.:stream_batch_size(integer/0) - Batch size to use if provided a query and the query must be streamed:allow_stream_with- The 'worst' strategy allowed to be used to fetch records if the:streamstrategy is chosen. See theAsh.stream!/2docs for more. The default value is:keyset.:authorize_query?(boolean/0) - If a query is given, determines whether or not authorization is run on that query. The default value istrue.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:filter(term/0) - A filter to apply to records. This is also applied to a stream of inputs.:strategy- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic].:transform_changeset(function of arity 1) - A function that takes and returns a changeset, applied to each changeset after it is built but before validation. Used internally by managed relationships to set foreign keys and context.:allow_stream_with- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2docs for more. The default value is:keyset.:stream_with- The specific strategy to use to fetch records. SeeAsh.stream!/2docs for more.:max_concurrency(non_neg_integer/0) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2:lock(term/0) - A lock statement to add onto the query:return_query?(boolean/0) - Iftrue, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false.:reuse_values?(boolean/0) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse.:strict?(boolean/0) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2.The default value is
false.:authorize_with- If set to:error, instead of applying authorization filters as a filter, any records not matching the authorization filter will cause an error to be returned. The default value is:filter.:read_action(atom/0) - The action to use when building the read query.:assume_casted?(boolean/0) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse.:select(list ofatom/0) - A select statement to apply to records. Ignored ifreturn_records?is not true.:authorize_query_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_changeset_with- If set to:error, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_withif not set.:authorize_with- If set to:error, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter.:private_arguments(map/0) - Private argument values to set on each changeset before validations and changes are run. The default value is%{}.:sorted?(boolean/0) - Whether or not to sort results by their input position, in cases wherereturn_records?: truewas provided. The default value isfalse.:return_records?(boolean/0) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse.:return_errors?(boolean/0) - Whether to return all errors that occur during the operation. Defaults to the value of:bulk_actions_default_to_errors?in your config, orfalseif not set. Returning all errors may be expensive for large inserts. The default value isfalse.:batch_size(pos_integer/0) - The number of records to include in each batch. Defaults to thedefault_limitormax_page_sizeof the action, or 100.:return_stream?(boolean/0) - If set totrue, instead of anAsh.BulkResult, a mixed stream is returned.Potential elements:
{:notification, notification}- ifreturn_notifications?is set totrue{:ok, record}- ifreturn_records?is set totrue{:error, error}- an error that occurred. May be changeset or an individual error.The default value is
false.:return_nothing?(boolean/0) - Mutes warnings about returning nothing.Only relevant if
return_stream?is set totrueand all otherreturn_*?options are set tofalse.The default value is
false.:stop_on_error?(boolean/0) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse.:notify?(boolean/0) - Whether or not to generate any notifications. If this is set totruethen the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?is set totrue.The default value is
false.:transaction- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transactionandafter_transactionhooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all.The default value is
:batch.:max_concurrency(non_neg_integer/0) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0.
:private_arguments(map/0) - Private argument values to set before validations and changes. The default value is%{}.