geolix

defmodule Geolix.Adapter do
  @moduledoc """
  Adapter behaviour module.
  """

  @optional_callbacks [
    database_workers: 0,
    load_database:    1
  ]


  @doc """
  Returns the children to be supervised by `Geolix.Database.Supervisor`.

  If no automatic supervision should take place or it is intended to use a
  adapter specific supervisor (i.e. using the application config) this callback
  should be either unimplemented or return an empty list.
  """
  @callback database_workers() :: list

  @doc """
  Loads a given database into Geolix.

  Requires at least the fields `:id` and `:adapter`. Any other required
  fields depend on the adapter's requirements.
  """
  @callback load_database(map) :: :ok

  @doc """
  Looks up IP information.

  The passed `opts` are expected to contain a key `:where` to define
  which database should be queried. If that key is not set then `nil`
  should be returned instead.
  """
  @callback lookup(ip :: tuple, opts :: Keyword.t) :: map | nil
end