A postgresql datalayer for the Ash Framework
Find a file
Zach Daniel 4d2d29d976 feat: support configuring references
feat: support configuring polymorphic references
feat: support `distinct` Ash queries
2021-04-01 02:19:30 -04:00
.github chore: fix CI setup-elixir version 2021-03-29 10:12:37 -04:00
config fix: better embedded filters, switch to latest ash 2021-02-24 13:59:49 -05:00
documentation docs: make polymorphic resources docs clearer 2021-03-21 13:23:51 -04:00
lib feat: support configuring references 2021-04-01 02:19:30 -04:00
logos feat: use the new DSL builder for config (#7) 2020-06-14 03:04:18 -04:00
priv feat: support configuring references 2021-04-01 02:19:30 -04:00
test feat: support configuring references 2021-04-01 02:19:30 -04:00
test_snapshot_path feat: automatically install extensions from repo 2021-03-02 12:33:24 -05:00
.check.exs chore: only run coverage once (#14) 2020-08-27 23:00:57 -04:00
.credo.exs feat: multitenancy (#25) 2020-10-28 22:26:45 -04:00
.formatter.exs feat: support configuring references 2021-04-01 02:19:30 -04:00
.gitignore feat: snapshot-based migration generator 2020-09-10 20:26:47 -04:00
CHANGELOG.md chore: release version v0.35.5 2021-03-29 09:27:47 -04:00
LICENSE Update LICENSE 2020-09-21 14:02:15 -04:00
mix.exs feat: support configuring references 2021-04-01 02:19:30 -04:00
mix.lock feat: support configuring references 2021-04-01 02:19:30 -04:00
README.md docs: Update docs in readme (#50) 2021-03-14 17:22:59 -04:00

AshPostgres

Elixir CI License: MIT Coverage Status Hex version badge

AshPostgres supports all capabilities of an Ash data layer, and it will most likely stay that way, as postgres is the primary target/most maintained data layer.

Custom Predicates:

  • AshPostgres.Predicates.Trigram

DSL

See the DSL documentation in AshPostgres.DataLayer for DSL documentation

Usage

First, ensure you've added ash_postgres to your mix.exs file.

{:ash_postgres, "~> x.y.z"}

To use this data layer, you need to chage your Ecto Repo's from use Ecto.Repo, to use AshPostgres.Repo. because AshPostgres adds functionality to Ecto Repos.

Then, configure each of your Ash.Resource resources by adding use Ash.Resource, data_layer: AshPostgres.DataLayer like so:

defmodule MyApp.SomeResource do
  use Ash.Resource, data_layer: AshPostgres.DataLayer

  postgres do
    repo MyApp.Repo
    table "table_name"
  end

  attributes do
    # ... Attribute definitions
  end
end

Generating Migrations

See the documentation for Mix.Tasks.AshPostgres.GenerateMigrations for how to generate migrations from your resources