Supabase.PostgREST.TransformBuilder.Behaviour behaviour (supabase_postgrest v1.0.1)

View Source

Defines the interface for the TransformBuilder module

Summary

Types

order_options()

@type order_options() :: [
  asc: boolean() | nil,
  null_first: boolean() | nil,
  foreign_table: String.t() | nil
]

Callbacks

csv(t)

explain(t, options)

@callback explain(Supabase.Fetcher.Request.t(), options :: explain) ::
  Supabase.Fetcher.Request.t()
when explain: [{opt, boolean()} | {:format, :json | :text}],
     opt: :analyze | :verbose | :settings | :buffers | :wal

geojson(t)

limit(t, count)

@callback limit(Supabase.Fetcher.Request.t(), count :: integer()) ::
  Supabase.Fetcher.Request.t()

limit(t, count, list)

@callback limit(Supabase.Fetcher.Request.t(), count :: integer(), [
  {:foreign_table, String.t()}
]) ::
  Supabase.Fetcher.Request.t()

maybe_single(t)

order(t, column, order_options)

range(t, from, to)

@callback range(Supabase.Fetcher.Request.t(), from :: integer(), to :: integer()) ::
  Supabase.Fetcher.Request.t()

range(t, from, to, list)

@callback range(Supabase.Fetcher.Request.t(), from :: integer(), to :: integer(), [
  {:foreign_table, String.t()}
]) :: Supabase.Fetcher.Request.t()

returning(t)

returning(t, arg2)

rollback(t)

single(t)