Supabase Elixir

Supabase Community Elixir SDK

def deps do
  [
    {:supabase_potion, "~> 0.6"}, # base SDK
    {:supabase_storage, "~> 0.4"}, # storage integration
    {:supabase_gotrue, "~> 0.4"}, # auth integration
    {:supabase_postgrest, "~> 1.0"}, # postgrest integration
  ]
end

Individual product client documentation:

• PostgREST
• Storage
• Auth

Clients

A Supabase.Client holds general information about Supabase, that can be used to intereact with any of the children integrations, for example: Supabase.Storage or Supabase.UI.

Supabase.Client is defined as:

• :base_url - The base url of the Supabase API, it is usually in the form https://<app-name>.supabase.io.
• :api_key - The API key used to authenticate requests to the Supabase API.
• :access_token - Token with specific permissions to access the Supabase API, it is usually the same as the API key.
• :db - default database options
  • :schema - default schema to use, defaults to "public"
• :global - global options config
  • :headers - additional headers to use on each request
• :auth - authentication options
  • :auto_refresh_token - automatically refresh the token when it expires, defaults to true
  • :debug - enable debug mode, defaults to false
  • :detect_session_in_url - detect session in URL, defaults to true
  • :flow_type - authentication flow type, defaults to "web"
  • :persist_session - persist session, defaults to true
  • :storage_key - storage key

Usage

There are two ways to create a Supabase.Client:

1. one off clients
2. self managed clients

One off clients

One off clients are clients that are created and managed by your application. They are useful for quick interactions with the Supabase API.

iex> Supabase.init_client("https://<supabase-url>", "<supabase-api-key>")
iex> {:ok, %Supabase.Client{}}

Any additional config can be passed as the third argument as an Enumerable:

iex> Supabase.init_client("https://<supabase-url>", "<supabase-api-key>",
  db: [schema: "another"],
  auth: [flow_type: :pkce],
  global: [headers: %{"custom-header" => "custom-value"}]
)
iex> {:ok, %Supabase.Client{}}

Initialized clients are elixir structs without any managed state.

You can also implement the Supabase.Client.Behaviour callbacks to cntralize client init logic.

Self managed clients

Self managed clients are clients that are created and managed by a separate process on your application. They are useful for long running applications that need to interact with the Supabase API.

If you don't have experience with processes or is a Elixir begginner, you should take a deep look into the Elixir official getting started section about processes, concurrency and distribution before to proceed.

• Processes
• Agent getting started
• GenServer getting started
• Supervison trees getting started

So, to define a self managed client, you need to define a module that will hold the client state and the client process as an Agent.

defmodule MyApp.Supabase.Client do
  use Supabase.Client, otp_app: :my_app
end

For that to work, you also need to configure the client in your app configuration, it can be a compile-time config on config.exs or a runtime config in runtime.exs:

import Config

# `:my_app` here is the same `otp_app` option you passed
config :my_app, MyApp.Supabase.Client,
  base_url: "https://<supabase-url>", # required
  api_key: "<supabase-api-key>", # required
  access_token: "<supabase-token>", # optional
   # additional options
  db: [schema: "another"],
  auth: [flow_type: :implicit, debug: true],
  global: [headers: %{"custom-header" => "custom-value"}]

Then, you can start the client process in your application supervision tree, generally in your application.ex module:

defmodule MyApp.Application do
  use Application

  def start(_type, _args) do
    children = [
      MyApp.Supabase.Client
    ]

    opts = [strategy: :one_for_one, name: MyApp.Supervisor]
    Supervisor.start_link(children, opts)
  end
end

To interact with the client process:

iex> {:ok, client} = MyApp.Supabase.Client.get_client()
iex> Supabase.GoTrue.sign_in_with_password(client, email: "", password: "")