Incant.DataSource behaviour (incant v0.1.0)

Copy Markdown

Behaviour for non-Ecto and analytical data sources.

Summary

Types

capability()

Callbacks

capabilities()
query(t)
schema()

Types

capability()

@type capability() ::
  :filter
  | :sort
  | :paginate
  | :aggregate
  | :group
  | :timeseries
  | :search
  | :export
  | :live_update
  | :mutate
  | :drilldown

Callbacks

capabilities()

@callback capabilities() :: [capability()]

query(t)

@callback query(Incant.Query.t()) :: {:ok, Incant.Result.t()} | {:error, term()}

schema()

@callback schema() :: term()