EctoPGMQ.Queue (ecto_pgmq v1.0.0)

Copy Markdown View Source

Schema for PGMQ queues.

Summary

Types

A PGMQ queue name.

t()

A PGMQ queue.

Functions

Returns a query for all queues.

Types

name()

@type name() :: String.t()

A PGMQ queue name.

t()

@type t() :: %EctoPGMQ.Queue{
  created_at: DateTime.t(),
  is_partitioned: boolean(),
  is_unlogged: boolean(),
  metrics: EctoPGMQ.Metrics.t() | nil,
  name: name(),
  notifications: EctoPGMQ.Throttle.t() | nil
}

A PGMQ queue.

Functions

query()

@spec query() :: Ecto.Query.t()

Returns a query for all queues.

The returned query joins and populates queue metrics and queue notification throttles.

Examples

iex> queues = Repo.all(query())
iex> Enum.all?(queues, &is_struct(&1, EctoPGMQ.Queue))
true