EctoPGMQ.Queue (ecto_pgmq v2.0.0)

Copy Markdown View Source

Read-only schema for PGMQ queues.

Summary

Types

name()

A PGMQ queue name.

t()

A PGMQ queue.

Functions

query()

Returns a query for all queues.

Types

name()

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

A PGMQ queue name.

t()

@type t() :: %EctoPGMQ.Queue{
  bindings: [EctoPGMQ.Binding.t()],
  created_at: DateTime.t(),
  metrics: EctoPGMQ.Metrics.t() | nil,
  name: name(),
  notifications: EctoPGMQ.Throttle.t() | nil,
  partitioned?: boolean(),
  unlogged?: boolean()
}

A PGMQ queue.

Functions

query()

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

Returns a query for all queues.

The returned query joins and populates bindings, metrics, and notification throttles.

Examples

iex> [%Queue{} | _] = Repo.all(Queue.query())