InfluxElixir.Connection (InfluxElixir v0.1.13)

Copy Markdown View Source

Named connection manager for InfluxDB instances.

Stores and retrieves initialized connections keyed by name. Values are stored in a persistent term for fast, lock-free reads from any process.

Important

Stored values are initialized connections (the result of Client.init_connection/1), not raw keyword configs. The type depends on the configured client implementation:

  • Client.HTTP — keyword list (host, token, etc.)
  • Client.Local — map with ETS table reference (%{table: _, databases: _, profile: _})

Usage

Connections are automatically registered by InfluxElixir.ConnectionSupervisor during startup. The supervisor calls Client.init_connection/1 to convert raw config into a usable connection before storing it here. The facade module (InfluxElixir) resolves atom names transparently, so most consumer code simply passes the connection name:

InfluxElixir.health(:trading)
InfluxElixir.write(:trading, "cpu value=1.0", database: "prices")

For direct registry access:

{:ok, conn} = InfluxElixir.Connection.get(:trading)
conn = InfluxElixir.Connection.fetch!(:trading)

Storage

Uses :persistent_term for near-zero-cost reads. Writes happen only during connection setup/teardown (rare), so the copy-on-write cost of :persistent_term is acceptable.

Summary

Functions

delete(name)

Removes a connection config by name.

fetch!(name)

Retrieves the connection config for the given name, raising on miss.

finch_name(name)

Returns the Finch pool name for a given connection name.

get(name)

Retrieves the connection config for the given name.

put(name, connection)

Stores a validated connection config under the given name.

Functions

delete(name)

@spec delete(atom()) :: :ok

Removes a connection config by name.

Returns :ok regardless of whether the name existed.

Parameters

  • name - atom identifying the connection

fetch!(name)

@spec fetch!(atom()) :: term()

Retrieves the connection config for the given name, raising on miss.

Parameters

  • name - atom identifying the connection

Examples

iex> InfluxElixir.Connection.put(:test, host: "localhost", token: "t")
iex> conn = InfluxElixir.Connection.fetch!(:test)
iex> conn[:host]
"localhost"

finch_name(name)

@spec finch_name(atom()) :: atom()

Returns the Finch pool name for a given connection name.

This is a convenience wrapper around InfluxElixir.ConnectionSupervisor.finch_name/1.

Parameters

  • name - atom identifying the connection

get(name)

@spec get(atom()) :: {:ok, term()} | {:error, :not_found}

Retrieves the connection config for the given name.

Returns {:ok, connection} or {:error, :not_found}.

Parameters

  • name - atom identifying the connection

Examples

iex> InfluxElixir.Connection.put(:test, host: "localhost", token: "t")
iex> {:ok, conn} = InfluxElixir.Connection.get(:test)
iex> conn[:host]
"localhost"

put(name, connection)

@spec put(atom(), term()) :: :ok

Stores a validated connection config under the given name.

Parameters

  • name - atom identifying the connection
  • connection - initialized connection value (from Client.init_connection/1)

Examples

iex> InfluxElixir.Connection.put(:test, host: "localhost", token: "t")
:ok