API Reference ash_postgres v2.5.18

The AshPostgres extension gives you tools to map a resource to a postgres database table.

Represents a configured check constraint on the table backing a resource

A custom aggregate implementation for ecto.

A custom extension implementation.

Represents a custom index on the table backing a resource

A postgres data layer that leverages Ecto's postgres capabilities.

Introspection functions for

An extension that adds support for the vector type.

Refers to the current table binding.

Maps to the builtin postgres function ilike.

Maps to the builtin postgres function like.

Maps to the builtin postgres trigram similarity function. Requires pgtrgm extension to be installed.

Maps to the vector cosine distance operator. Requires vector extension to be installed.

Maps to the vector l2 distance operator. Requires vector extension to be installed.

Codemods and utilities for working with AshPostgres & Igniter

Ash Type for postgres ltree, a hierarchical tree-like data type.

A behavior for postgres-specific manual relationship functionality

Utilities for use in migrations

A cache for the compiled migrations.

Represents the configuration of a reference (i.e foreign key).

Resources that use AshPostgres.DataLayer use a Repo to access the database.

Represents a custom statement to be run in generated migrations

Implements the PostgresSQL timestamptz (aka timestamp with time zone) type.

Implements the PostgresSQL timestamptz (aka timestamp with time zone) type with nanosecond precision.

A thin wrapper around :string for working with tsquery types in calculations.

A type for representing postgres' tsvectors.

Postgres specific callbacks for Ash.Type.

Allows configuring how values are translated to default values in migrations.

Create the storage for repos in all resources for the given (or configured) domains.

Drop the storage for the given repository.

Generates resources based on a database schema

Generates migrations, and stores a snapshot of your resources.

Installs AshPostgres. Should be run with mix igniter.install ash_postgres

Runs the pending migrations for the given repository.

Reverts applied migrations in the given repository. Migrations are expected at "priv/YOUR_REPO/migrations" directory of the current application but it can be configured by specifying the :priv key under the repository configuration. Runs the latest applied migration by default. To roll back to a version number, supply --to version_number. To roll back a specific number of times, use --step n. To undo all applied migrations, provide --all.

Cleans snapshots folder, leaving only one snapshot per resource.