A client for interacting with Supabase. This module is responsible for managing the connection options for your Supabase project.

Usage

Generally, you can start a client by calling Supabase.init_client/3:

iex> base_url = "https://<app-name>.supabase.io"
iex> api_key = "<supabase-api-key>"
iex> Supabase.init_client(base_url, api_key, %{})
{:ok, %Supabase.Client{}}

That way of initialisation is useful when you want to manage the connection options yourself or create one off clients.

However, starting a client directly means you have to manage the connection options yourself. To make it easier, you can use the Supabase.Client module to manage the connection options for you.

To achieve this you can use the Supabase.Client module in your module:

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

This will automatically start an Agent process to manage the connection options for you. But for that to work, you need to configure your defined Supabase client in your config.exs:

config :my_app, MyApp.Supabase.Client,
  base_url: "https://<app-name>.supabase.co",
  api_key: "<supabase-api-key>",
  conn: %{access_token: "<supabase-access-token>"}, # optional
  db: %{schema: "another"}, # default to public
  auth: %{debug: true} # optional

Another alternative would be to configure your Supabase Client at runtime, while starting your application:

defmodule MyApp.Application do
  use Application

  def start(_type, _args) do
    children = [
      {MyApp.Supabase.Client, [
        base_url: "https://<app-name>.supabase.co",
        api_key: "<supabase-api-key>"
      ]}
    ]

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

For more information on how to configure your Supabase Client with additional options, please refer to the Supabase official documentation

Examples

%Supabase.Client{
  conn: %{
    base_url: "https://<app-name>.supabase.io",
    api_key: "<supabase-api-key>",
    access_token: "<supabase-access-token>"
  },
  db: %Supabase.Client.Db{
    schema: "public"
  },
  global: %Supabase.Client.Global{
    headers: %{}
  },
  auth: %Supabase.Client.Auth{
    auto_refresh_token: true,
    debug: false,
    detect_session_in_url: true,
    flow_type: :implicit,
    persist_session: true,
    storage: nil,
    storage_key: "sb-<host>-auth-token"
  }
}

iex> Supabase.Client.retrieve_connection(%Supabase.Client{})
%Supabase.Client.Conn{
  base_url: "https://<app-name>.supabase.io",
  api_key: "<supabase-api-key>",
  access_token: "<supabase-access-token>"
}