Packages

Endo is a library containing database schema reflection APIs for your applications, as well as implementations of queryable schemas to facilitate custom database reflection via Ecto.

Current section

Files

Jump to
endo lib endo adapter.ex
Raw

lib/endo/adapter.ex

defmodule Endo.Adapter do
@moduledoc """
Module defining the `Endo.Adapter` behaviour. Valid adapters will allow Endo to reflect
upon a module implementing said adater
"""
@callback list_tables(repo :: module(), filters :: Keyword.t()) :: [map()]
@callback to_endo(data :: map(), opts :: Keyword.t()) ::
Endo.Table.t() | Endo.Column.t() | Endo.Association.t() | Endo.Index.t()
end