Geolix v0.10.1 Geolix.Storage.Metadata

Geolix metadata storage.

Usage

iex> set(:some_database_name, %Geolix.Metadata{ database_type: "doctest" })
:ok
iex> get(:some_database_name)
%Geolix.Metadata{ database_type: "doctest" }
iex> get(:some_database_name, :database_type)
"doctest"

iex> get(:unregistered_database)
nil
iex> get(:unregistered_database, :database_type)
nil

Summary

Functions

Fetches a metadata entry for a database

Returns the value of the requested key from a metadata entry

Returns the names of all registered metadata entries

Stores a set of metadata for a specific database

Starts the metadata agent

Functions

get(database)

Specs

get(atom) :: Geolix.Metadata.t | nil

Fetches a metadata entry for a database.

get(database, key)

Specs

get(atom, atom) :: any

Returns the value of the requested key from a metadata entry.

If either the key or the whole metadata entry are not found then nil will be returned.

registered()

Specs

registered :: list

Returns the names of all registered metadata entries.

set(database, metadata)

Specs

set(atom, Geolix.Metadata.t) :: :ok

Stores a set of metadata for a specific database.

start_link()

Specs

start_link :: Agent.on_start

Starts the metadata agent.