Exograph.Postgres (exograph v0.2.0)

Copy Markdown View Source

Ecto/Postgres helpers for the durable Exograph backend.

Relational storage is created through Ecto migrations. Raw SQL is reserved for Postgres extensions and ParadeDB's BM25 index, which Ecto migrations do not model directly.

Summary

Types

backend_opts()
repo()

Functions

migrate!(opts)

Creates or upgrades the Exograph Postgres schema.

Types

backend_opts()

@type backend_opts() :: [repo: repo(), prefix: String.t(), bm25?: boolean()]

repo()

@type repo() :: module()

Functions

migrate!(opts)

@spec migrate!(backend_opts()) :: :ok

Creates or upgrades the Exograph Postgres schema.

Options:

  • :repo - an Ecto repo module (required)
  • :prefix - table-name prefix, defaults to "exograph"
  • :bm25? - create a ParadeDB BM25 index when pg_search is available, defaults to true