ash-framework

Additional References

ash

• ash
• actions
• aggregates
• authorization
• calculations
• code_interfaces
• code_structure
• data_layers
• exist_expressions
• generating_code
• migrations
• query_filter
• querying_data
• relationships
• testing

ash_graphql

• ash_graphql
• custom_types
• domain_configuration
• resource_configuration

ash_json_api

• ash_json_api

ash_oban

• ash_oban
• best_practices
• debugging_and_error_handling
• defining_triggers
• multi_tenancy_support
• scheduled_actions
• setting_up_ash_oban
• triggering_jobs_programmatically
• working_with_actors

ash_phoenix

• ash_phoenix
• best_practices
• debugging_form_submissions
• error_handling
• form_integration
• nested_forms
• union_forms

ash_postgres

• ash_postgres
• advanced_features
• best_practices
• check_constraints
• configuration
• custom_indexes
• custom_sql_statements
• foreign_keys
• migrations
• multitenancy

Searching Documentation

mix usage_rules.search_docs "search term" -p ash -p ash_archival -p ash_authentication_phoenix -p ash_graphql -p ash_json_api -p ash_oban -p ash_ops -p ash_paper_trail -p ash_phoenix -p ash_postgres -p ash_rate_limiter

Available Mix Tasks

• mix ash - Prints Ash help information
• mix ash.codegen - Runs all codegen tasks for any extension on any resource/domain in your application.
• mix ash.extend - Adds an extension or extensions to the given domain/resource
• mix ash.gen.base_resource - Generates a base resource. This is a module that you can use instead of Ash.Resource, for consistency.
• mix ash.gen.change - Generates a custom change module.
• mix ash.gen.custom_expression - Generates a custom expression module.
• mix ash.gen.domain - Generates an Ash.Domain
• mix ash.gen.enum - Generates an Ash.Type.Enum
• mix ash.gen.gettext - Copies Ash's .pot file for error message translation
• mix ash.gen.preparation - Generates a custom preparation module.
• mix ash.gen.resource - Generate and configure an Ash.Resource.
• mix ash.gen.validation - Generates a custom validation module.
• mix ash.generate_livebook - Generates a Livebook for each Ash domain
• mix ash.generate_policy_charts - Generates a Mermaid Flow Chart for a given resource's policies.
• mix ash.generate_resource_diagrams - Generates Mermaid Resource Diagrams for each Ash domain
• mix ash.gettext.extract - Extracts Ash error messages into a .pot file
• mix ash.install - Installs Ash into a project. Should be called with mix igniter.install ash
• mix ash.manifest.dump - Dump the Ash app manifest as JSON
• mix ash.migrate - Runs all migration tasks for any extension on any resource/domain in your application.
• mix ash.patch.extend - Adds an extension or extensions to the given domain/resource
• mix ash.reset - Runs all tear down & setup tasks for any extension on any resource/domain in your application.
• mix ash.rollback - Runs all rollback tasks for any extension on any resource/domain in your application.
• mix ash.set.domains - Dynamically discovers and updates Ash domains in config.exs
• mix ash.setup - Runs all setup tasks for any extension on any resource/domain in your application.
• mix ash.tear_down - Runs all tear_down tasks for any extension on any resource/domain in your application.
• mix ash_authentication.phoenix.routes - Prints all routes generated by AshAuthentication Phoenix
• mix ash_authentication_phoenix.install - Installs AshAuthenticationPhoenix. Invoke with mix igniter.install ash_authentication_phoenix
• mix ash_authentication_phoenix.upgrade
• mix ash_graphql.install - Installs AshGraphql. Should be run with mix igniter.install ash_graphql
• mix ash_json_api.install - Installs AshJsonApi. Should be run with mix igniter.install ash_json_api
• mix ash_json_api.routes - Prints all routes by AshJsonApiRouter
• mix ash_oban.install - Installs AshOban and Oban
• mix ash_oban.install.docs
• mix ash_oban.set_default_module_names - Set module names to their default values for triggers and scheduled actions
• mix ash_oban.set_default_module_names.docs
• mix ash_oban.upgrade
• mix ash_ops.install - Installs AshOps into a project.
• mix ash_phoenix.gen.html - Generates a controller and HTML views for an existing Ash resource.
• mix ash_phoenix.gen.live - Generates liveviews for a given domain and resource.
• mix ash_phoenix.install - Installs AshPhoenix into a project. Should be called with mix igniter.install ash_phoenix
• mix ash_postgres.create - Creates the repository storage
• mix ash_postgres.drop - Drops the repository storage for the repos in the specified (or configured) domains
• mix ash_postgres.gen.resources - Generates resources based on a database schema
• mix ash_postgres.generate_migrations - Generates migrations, and stores a snapshot of your resources
• mix ash_postgres.install - Installs AshPostgres. Should be run with mix igniter.install ash_postgres
• mix ash_postgres.migrate - Runs the repository migrations for all repositories in the provided (or configured) domains
• mix ash_postgres.rollback - Rolls back the repository migrations for all repositories in the provided (or configured) domains
• mix ash_postgres.setup_vector - Sets up pgvector for AshPostgres
• mix ash_postgres.setup_vector.docs
• mix ash_postgres.squash_snapshots - Cleans snapshots folder, leaving only one snapshot per resource
• mix ash_rate_limiter.install - Installs AshRateLimiter
• mix ash_rate_limiter.upgrade - Upgrades AshRateLimiter