Ash Framework

Welcome! Here you will find everything you need to know to get started with and use Ash. This documentation is best viewed on hexdocs.

Dive In

• What is Ash?
• Get Started Livebook
• See the roadmap

About the Documentation

The Get Started Livebook Tutorial introduces you to the core concepts of Ash like resources, actions, and relationships. It’s a great place to start if you are a beginner.

Topics provide a high level overview of a specific concept or feature of Ash. These are understanding-oriented, and are perfect for discovering design patterns, features, and tools.

How-to guides are goal-oriented recipes for accomplishing specific popular tasks. Browse to get an idea of how Ash works and what is possible with it.

Reference documentation is information-oriented, covering every Ash module, function, expression, and DSL. It is produced automatically from our source code. Use the sidebar and the top search bar to find relevant reference information. Place the text dsl before your search to quickly jump to a particular DSL — e.g. try comparing the results of searching for name with the results for dsl name.

Topics

About Ash

• What is Ash?
• Our Design Principles
• Contributing to Ash
• Alternatives

Resources

• Domains
• Attributes
• Relationships
• Calculations
• Aggregates
• Code Interfaces
• Identities
• Validations
• Changes
• Preparations
• Embedded Resources
• Notifiers

Actions

• Actions
• Read Actions
• Create Actions
• Update Actions
• Destroy Actions
• Generic Actions
• Manual Actions

Security

• Actors & Authorization
• Sensitive Data
• Policies

Development

• Project Structure
• Generators
• Testing
• Development Utilities
• Backwards Compatibility Config
• Upgrading to 3.0
• Error Handling

Advanced

• Monitoring
• Multitenancy
• Reactor
• Timeouts
• Writing Extensions

How-to

• Write Queries
• Test Resources
• Authorize Access to Resources
• Encrypt Attributes
• Prevent Concurrent Writes
• Wrap External APIs
• Define Polymorphic Relationships

Reference

• Ash.Resource DSL
• Ash.Domain DSL
• Ash.Reactor DSL
• Ash.Notifier.PubSub DSL
• Ash.Policy.Authorizer DSL
• Ash.DataLayer.Ets DSL
• Ash.DataLayer.Mnesia DSL
• Glossary
• Expressions
• For other reference documentation, see the sidebar & search bar

Packages

The Ash ecosystem consists of numerous packages, all of which have their own documentation. If you can't find something in this documentation, don't forget to search in any potentially relevant package.

Data Layers

• AshPostgres | PostgreSQL data layer
• AshSqlite | SQLite data layer
• AshCsv | CSV data layer
• AshCubdb | CubDB data layer

API Extensions

• AshJsonApi | JSON:API builder
• AshGraphql | GraphQL builder

Web

• AshPhoenix | Phoenix integrations
• AshAuthentication | Authenticate users with password, OAuth, and more
• AshAuthenticationPhoenix | Integrations for AshAuthentication and Phoenix

Finance

• AshMoney | A money data type for Ash
• AshDoubleEntry | A double entry system backed by Ash Resources

Resource Utilities

• AshOban | Background jobs and scheduled jobs for Ash, backed by Oban
• AshArchival | Archive resources instead of deleting them
• AshStateMachine | Create state machines for resources
• AshPaperTrail | Keep a history of changes to resources
• AshCloak | Encrypt attributes of a resource

Admin & Monitoring

• AshAdmin | A push-button admin interface
• AshAppsignal | Monitor your Ash resources with AppSignal

Testing

• Smokestack | Declarative test factories for Ash resources

Examples & External Resources

• Ash Real World | Ash + Phoenix LiveView codebase containing real world examples (CRUD, auth, advanced patterns, etc)