yggdrasil v3.3.0 Yggdrasil.Publisher.Adapter.Postgres View Source

Yggdrasil publisher adapter for Postgres. The name of the channel must be a binary e.g:

Subscription to channel:

iex(2)> channel = %Yggdrasil.Channel{name: "pg_channel", adapter: :postgres}
iex(3)> Yggdrasil.subscribe(channel)
:ok
iex(4)> flush()
{:Y_CONNECTED, %Yggdrasil.Channel{name: "pg_channel", (...)}}

Publishing message:

iex(5)> Yggdrasil.publish(channel, "foo")
:ok

Subscriber receiving message:

iex(6)> flush()
{:Y_EVENT, %Yggdrasil.Channel{name: "pg_channel", (...)}, "foo"}

The subscriber can also unsubscribe from the channel:

iex(7)> Yggdrasil.unsubscribe(channel)
:ok
iex(8)> flush()
{:Y_DISCONNECTED, %Yggdrasil.Channel{name: "pg_channel", (...)}}

Link to this section Summary

Functions

Publishes a message in a channel using a publisher and optional and unused options

Starts a Postgres publisher with a namespace. Additianally you can add GenServer options

Stops a Postgres publisher

Link to this section Functions

Link to this function publish(publisher, channel, message, options \\ []) View Source
publish(GenServer.server(), Yggdrasil.Channel.t(), term(), Keyword.t()) ::
  :ok | {:error, term()}

Publishes a message in a channel using a publisher and optional and unused options.

Link to this function start_link(namespace, options \\ []) View Source
start_link(term(), GenServer.options()) :: GenServer.on_start()

Starts a Postgres publisher with a namespace. Additianally you can add GenServer options.

Stops a Postgres publisher.