Supabase.PostgREST.QueryBuilder.Behaviour behaviour (supabase_postgrest v1.2.2)

Defines the interface for the QueryBuilder module

Summary

agg_opt()

column()

insert_options()

options()

delete(t)

insert(t, map)

select(t, arg2)

update(t, map)

upsert(t, map)

@type agg_opt() :: {:as, column()}

@type column() :: String.t() | atom()

@type insert_options() :: [
  count: :exact,
  returning: boolean() | :representation,
  on_conflict: any()
]

@type options() :: [count: :exact, returning: boolean() | :representation]

@callback avg(column(), [agg_opt()]) :: String.t()

@callback count(column(), [agg_opt()]) :: String.t()

@callback delete(Supabase.Fetcher.Request.t()) :: Supabase.Fetcher.Request.t()

@callback delete(Supabase.Fetcher.Request.t(), options()) :: Supabase.Fetcher.Request.t()

@callback insert(Supabase.Fetcher.Request.t(), map()) :: Supabase.Fetcher.Request.t()

@callback insert(Supabase.Fetcher.Request.t(), map(), insert_options()) ::
  Supabase.Fetcher.Request.t()

@callback max(column(), [agg_opt()]) :: String.t()

@callback min(column(), [agg_opt()]) :: String.t()

@callback select(Supabase.Fetcher.Request.t(), [String.t()] | String.t()) ::
  Supabase.Fetcher.Request.t()

@callback select(Supabase.Fetcher.Request.t(), [String.t()] | String.t(), options()) ::
  Supabase.Fetcher.Request.t()

@callback sum(column(), [agg_opt()]) :: String.t()

@callback update(Supabase.Fetcher.Request.t(), map()) :: Supabase.Fetcher.Request.t()

@callback update(Supabase.Fetcher.Request.t(), map(), options()) ::
  Supabase.Fetcher.Request.t()

@callback upsert(Supabase.Fetcher.Request.t(), map()) :: Supabase.Fetcher.Request.t()

@callback upsert(Supabase.Fetcher.Request.t(), map(), insert_options()) ::
  Supabase.Fetcher.Request.t()