Commit35b9cae

committed

docs: update docs

1 parent4267d01 commit35b9caeCopy full SHA for 35b9cae

File tree

+43

-35

lines changed

+43

-35

lines changed

Lines changed: 32 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,35 @@`
`5`	`5`	`[![Coverage Status](https://coveralls.io/repos/github/ash-project/ash_postgres/badge.svg?branch=master)](https://coveralls.io/github/ash-project/ash_postgres?branch=master)`
`6`	`6`	`[![Hex version badge](https://img.shields.io/hexpm/v/ash_postgres.svg)](https://hex.pm/packages/ash_postgres)`
`7`	`7`
`8`		`-The documentation for ash_postgres is available on[hexdocs](https://hexdocs.pm/ash_postgres/AshPostgres.html)`
	`8`	`+AshPostgres supports all capabilities of an Ash data layer, and it will`
	`9`	`+most likely stay that way, as postgres is the primary target/most maintained`
	`10`	`+data layer.`
	`11`	`+`
	`12`	`+Custom Predicates:`
	`13`	`+`
	`14`	`+- AshPostgres.Predicates.Trigram`
	`15`	`+`
	`16`	`+###Usage`
	`17`	`+`
	`18`	+First, ensure you've added ash_postgres to your`mix.exs` file.
	`19`	`+`
	`20`	+```elixir
	`21`	`+{:ash_postgres,"~> x.y.z"}`
	`22`	+```
	`23`	`+`
	`24`	+To use this data layer, you need to define an`Ecto.Repo`. AshPostgres adds some
	`25`	+functionality on top of ecto repos, so you'll want to use`AshPostgres.Repo`
	`26`	`+`
	`27`	`+Then, configure your resource like so:`
	`28`	`+`
	`29`	+```elixir
	`30`	`+postgresdo`
	`31`	`+ repoMyApp.Repo`
	`32`	`+ table"table_name"`
	`33`	`+end`
	`34`	+```
	`35`	`+`
	`36`	`+###Generating Migrations`
	`37`	`+`
	`38`	+See the documentation for`Mix.Tasks.AshPostgres.GenerateMigrations` for how to generate
	`39`	`+migrations from your resources`

Lines changed: 0 additions & 32 deletions

Original file line number	Diff line number	Diff line change
`@@ -2,38 +2,6 @@ defmodule AshPostgres.DataLayer do`
`2`	`2`	`@moduledoc"""`
`3`	`3`	`A postgres data layer that levereges Ecto's postgres capabilities.`
`4`	`4`
`5`		`- AshPostgres supports all capabilities of an Ash data layer, and it will`
`6`		`- most likely stay that way, as postgres is the primary target/most maintained`
`7`		`- data layer.`
`8`		`-`
`9`		`- Custom Predicates:`
`10`		`-`
`11`		`- * AshPostgres.Predicates.Trigram`
`12`		`-`
`13`		`- ### Usage`
`14`		`-`
`15`		- First, ensure you've added ash_postgres to your `mix.exs` file.
`16`		`-`
`17`		- ```elixir
`18`		`- {:ash_postgres, "~> x.y.z"}`
`19`		- ```
`20`		`-`
`21`		- To use this data layer, you need to define an `Ecto.Repo`. AshPostgres adds some
`22`		- functionality on top of ecto repos, so you'll want to use `AshPostgres.Repo`
`23`		`-`
`24`		`- Then, configure your resource like so:`
`25`		`-`
`26`		- ```elixir
`27`		`- postgres do`
`28`		`- repo MyApp.Repo`
`29`		`- table "table_name"`
`30`		`- end`
`31`		- ```
`32`		`-`
`33`		`- ### Generating Migrations`
`34`		`-`
`35`		- See the documentation for `Mix.Tasks.AshPostgres.GenerateMigrations` for how to generate
`36`		`- migrations from your resources`
`37`	`5`	`"""`
`38`	`6`
`39`	`7`	`@manage_tenant%Ash.Dsl.Section{`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ defmodule AshPostgres.Repo do`
`26`	`26`	`@doc"Return a list of all schema names (only relevant for a multitenant implementation)"`
`27`	`27`	`@callbackall_tenants()::[String.t()]`
`28`	`28`	`@doc"The path where your tenant migrations are stored (only relevant for a multitenant implementation)"`
`29`		`-@callbacktenant_migration_path()::String.t()`
	`29`	`+@callbacktenant_migrations_path()::String.t()`
`30`	`30`
`31`	`31`	`defmacro__using__(opts)do`
`32`	`32`	`quotebind_quoted:[opts:opts]do`

Lines changed: 10 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -48,9 +48,18 @@ defmodule AshPostgres.MixProject do`
`48`	`48`
`49`	`49`	`defpdocsdo`
`50`	`50`	`[`
`51`		`-main:"AshPostgres",`
	`51`	`+main:"readme",`
`52`	`52`	`source_ref:"v#{@version}",`
`53`	`53`	`logo:"logos/small-logo.png",`
	`54`	`+extras:[`
	`55`	`+"README.md",`
	`56`	`+"documentation/multitenancy.md"`
	`57`	`+],`
	`58`	`+groups_for_extras:[`
	`59`	`+guides:[`
	`60`	`+"documentation/multitenancy.md"`
	`61`	`+]`
	`62`	`+],`
`54`	`63`	`groups_for_modules:[`
`55`	`64`	`"entry point":[AshPostgres],`
`56`	`65`	`"data layer and dsl":~r/AshPostgres.DataLayer/,`

Comments

(0)