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

View Source

Defines the interface for the main module Supabase.PostgREST

Summary

Types

media_type()

@type media_type() ::
  :json
  | :csv
  | :openapi
  | :geojson
  | :pgrst_plan
  | :pgrst_object
  | :pgrst_array

Callbacks

execute(t)

@callback execute(Supabase.Fetcher.Request.t()) :: Supabase.result(term())

execute_to(t, module)

@callback execute_to(Supabase.Fetcher.Request.t(), module()) :: Supabase.result(term())

execute_to_finch_request(t)

@callback execute_to_finch_request(Supabase.Fetcher.Request.t()) :: Finch.Request.t()

from(t, relation)

@callback from(Supabase.Client.t(), relation :: String.t()) ::
  Supabase.Fetcher.Request.t()

rpc(t, function_name, arguments, options)

@callback rpc(Supabase.Client.t(), function_name, arguments, options) ::
  Supabase.Fetcher.Request.t()
when function_name: String.t(),
     arguments: map(),
     options: [
       {:head | :get, boolean()} | {:count, :exact | :planned | :estimated}
     ]

schema(t, schema)

@callback schema(Supabase.Fetcher.Request.t(), schema :: String.t()) ::
  Supabase.Fetcher.Request.t()

with_custom_media_type(t, media_type)

@callback with_custom_media_type(Supabase.Fetcher.Request.t(), media_type()) ::
  Supabase.Fetcher.Request.t()