Yggdrasil for PostgreSQL v5.0.0 Yggdrasil.Postgres.Connection.Pool View Source
PostgreSQL listener connection pool.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor.
Gets a connection for a tag
and namespace
.
Starts a connection pool using an initial tag
and namespace
. Optionally,
it receives some Supervisor
options
.
Stops a PostgreSQL listener connection pool
. Optionally, it receives a stop
reason
(defaults to :normal
) and timeout (defaults to :infinity
).
Link to this section Functions
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
get_connection(tag, namespace)
View Source
get_connection(
Yggdrasil.Postgres.Connection.tag(),
Yggdrasil.Postgres.Connection.namespace()
) :: {:ok, pid()} | {:error, term()}
get_connection( Yggdrasil.Postgres.Connection.tag(), Yggdrasil.Postgres.Connection.namespace() ) :: {:ok, pid()} | {:error, term()}
Gets a connection for a tag
and namespace
.
start_link(tag, namespace, options \\ [])
View Source
start_link(
Yggdrasil.Postgres.Connection.tag(),
Yggdrasil.Postgres.Connection.namespace(),
Supervisor.options()
) :: Supervisor.on_start()
start_link( Yggdrasil.Postgres.Connection.tag(), Yggdrasil.Postgres.Connection.namespace(), Supervisor.options() ) :: Supervisor.on_start()
Starts a connection pool using an initial tag
and namespace
. Optionally,
it receives some Supervisor
options
.
stop(pool, reason \\ :normal, timeout \\ :infinity)
View Source
stop(Supervisor.supervisor(), term(), :infinity | non_neg_integer()) :: :ok
stop(Supervisor.supervisor(), term(), :infinity | non_neg_integer()) :: :ok
Stops a PostgreSQL listener connection pool
. Optionally, it receives a stop
reason
(defaults to :normal
) and timeout (defaults to :infinity
).