Supabase (supabase_potion v0.4.0)
The main entrypoint for the Supabase SDK library.
Installation
The package can be installed by adding supabase_potion
to your list of dependencies in mix.exs
:
def deps do
[
{:supabase_potion, "~> 0.3"}
]
end
Usage
After installing :supabase_potion
, you can easily and dynamically manage different Supabase.Client
!
Config
The library offers a bunch of config options that can be used to control management of clients and other options.
manage_clients
- whether to manage clients automatically, defaults totrue
You can set up the library on your config.exs
:
config :supabase, manage_clients: false
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:
:conn
- connection information, the only required option as it is vital to theSupabase.Client
.:base_url
- The base url of the Supabase API, it is usually in the formhttps://<app-name>.supabase.co
.: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 totrue
:debug
- enable debug mode, defaults tofalse
:detect_session_in_url
- detect session in URL, defaults totrue
:flow_type
- authentication flow type, defaults to"web"
:persist_session
- persist session, defaults totrue
:storage
- storage type:storage_key
- storage key
Starting a Client
You then can start a Client calling Supabase.init_client/1
:
iex> Supabase.init_client(%{db: %{schema: "public"}})
{:ok, %Supabase.Client{}}
Acknowledgements
This package represents the base SDK for Supabase. That means that it not includes all of the functionality of the Supabase client integrations, so you need to install each feature separetely, as:
Supabase Storage
Supabase Storage is a service for developers to store large objects like images, videos, and other files. It is a hosted object storage service, like AWS S3, but with a simple API and strong consistency.
Supabase PostgREST
PostgREST is a web server that turns your PostgreSQL database directly into a RESTful API. The structural constraints and permissions in the database determine the API endpoints and operations.
Supabase Realtime
Supabase Realtime provides a realtime websocket API powered by PostgreSQL notifications. It allows you to listen to changes in your database, and instantly receive updates as soon as they happen.
Supabase Auth
Supabase Auth is a feature-complete user authentication system. It provides email & password sign in, email verification, password recovery, session management, and more, out of the box.
Supabase UI
Supabase UI is a set of UI components that help you quickly build Supabase-powered applications. It is built on top of Tailwind CSS and Headless UI, and is fully customizable. The package provides Phoenix.LiveView
components!
Summary
Functions
init_client(opts \\ %{})
@spec init_client(Supabase.Client.params() | %{}) :: {:ok, Supabase.Client.t()} | {:error, changeset()}