supabase

README

An isomorphic Go client for Supabase.

Features

• Integration with Supabase.Realtime
  • Realtime listeners for database changes
• Integration with Postgrest
  • Access your database using a REST API generated from your schema & database functions
• Integration with Gotrue
  • User authentication, including OAuth, email/password, and native sign-in
• Integration with Supabase Storage
  • Store files in S3 with additional managed metadata
• Integration with Supabase Edge Functions
  • Run serverless functions on the edge

Quickstart

1. To get started, create a new project in the Supabase Admin Panel.
2. Grab your Supabase URL and Supabase Public Key from the Admin Panel (Settings -> API Keys).
3. Initialize the client!

Reminder: supabase-go has some APIs that require the service_key rather than the public_key (for instance: the administration of users, bypassing database roles, etc.). If you are using the service_key be sure it is not exposed client side. Additionally, if you need to use both a service account and a public/user account, please do so using a separate client instance for each.

Documentation

Get Started

First of all, you need to install the library:

  go get github.com/supabase-community/supabase-go

Then you can use

  client, err := supabase.NewClient(API_URL, API_KEY, &supabase.ClientOptions{})
  if err != nil {
    fmt.Println("cannot initalize client", err)
  }
  data, count, err := client.From("countries").Select("*", "exact", false).Execute()

Use authenticated client

 client, err := supabase.NewClient(API_URL, API_KEY, &supabase.ClientOptions{})
 if err != nil {
  fmt.Println("cannot initalize client", err)
 }
 client.SignInWithEmailPassword(USER_EMAIL, USER_PASSWORD)

Documentation

Index

• Constants
• type Client
  • func NewClient(url, key string, options *ClientOptions) (*Client, error)
  • func (c *Client) EnableTokenAutoRefresh(session types.Session)
  • func (c *Client) ExchangeCode(code, codeVerifier string) (types.Session, error)
  • func (c *Client) From(table string) *postgrest.QueryBuilder
  • func (c *Client) RefreshToken(refreshToken string) (types.Session, error)
  • func (c *Client) Rpc(name, count string, rpcBody interface{}) string
  • func (c *Client) SignInWithEmailPassword(email, password string) (types.Session, error)
  • func (c *Client) SignInWithPhonePassword(phone, password string) (types.Session, error)
  • func (c *Client) SignInWithProvider(provider types.Provider, redirectTo string) (*types.AuthorizeResponse, error)
  • func (c *Client) SignUp(email, password string, data map[string]interface{}) (*types.SignupResponse, error)
  • func (c *Client) SignUpWithEmailOTP(email string, options *SignUpOptions) error
  • func (c *Client) UpdateAuthSession(session types.Session)
  • func (c *Client) VerifyEmailOTP(email, code string) (*types.Session, error)
• type ClientOptions
• type SignUpOptions

Constants

const (
	REST_URL      = "/rest/v1"
	STORAGE_URL   = "/storage/v1"
	AUTH_URL      = "/auth/v1"
	FUNCTIONS_URL = "/functions/v1"
)

Types

type Client

type Client struct {
	Storage *storage_go.Client
	// Auth is an interface. We don't need a pointer to an interface.
	Auth      auth.Client
	Functions *functions.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(url, key string, options *ClientOptions) (*Client, error)

NewClient creates a new Supabase client. url is the Supabase URL. key is the Supabase API key. options is the Supabase client options.

func (*Client) EnableTokenAutoRefresh

func (c *Client) EnableTokenAutoRefresh(session types.Session)

func (*Client) ExchangeCode

func (c *Client) ExchangeCode(code, codeVerifier string) (types.Session, error)

ExchangeCode exchanges the authorization code for a session token after OAuth sign-in. The codeVerifier is the PKCE verifier returned from SignInWithProvider.

func (*Client) From

func (c *Client) From(table string) *postgrest.QueryBuilder

Wrap postgrest From method From returns a QueryBuilder for the specified table.

func (*Client) RefreshToken

func (c *Client) RefreshToken(refreshToken string) (types.Session, error)

func (*Client) Rpc

func (c *Client) Rpc(name, count string, rpcBody interface{}) string

Wrap postgrest Rpc method Rpc returns a string for the specified function.

func (*Client) SignInWithEmailPassword

func (c *Client) SignInWithEmailPassword(email, password string) (types.Session, error)

func (*Client) SignInWithPhonePassword

func (c *Client) SignInWithPhonePassword(phone, password string) (types.Session, error)

func (*Client) SignInWithProvider

func (c *Client) SignInWithProvider(provider types.Provider, redirectTo string) (*types.AuthorizeResponse, error)

SignInWithProvider initiates OAuth sign-in with the specified provider. It returns the authorization URL that the user should be redirected to, along with the PKCE verifier that should be stored for the token exchange.

func (*Client) SignUp

func (c *Client) SignUp(email, password string, data map[string]interface{}) (*types.SignupResponse, error)

SignUp registers a new user with email and password. Optionally accepts user metadata.

func (*Client) SignUpWithEmailOTP

func (c *Client) SignUpWithEmailOTP(email string, options *SignUpOptions) error

SignUpWithEmailOTP initiates a signup flow using email OTP verification. It sends a one-time password to the user's email.

func (*Client) UpdateAuthSession

func (c *Client) UpdateAuthSession(session types.Session)

func (*Client) VerifyEmailOTP

func (c *Client) VerifyEmailOTP(email, code string) (*types.Session, error)

VerifyEmailOTP completes the signup process by verifying the OTP code. Returns the new user session if verification is successful.

type ClientOptions

type ClientOptions struct {
	Headers map[string]string
	Schema  string
}

type SignUpOptions

type SignUpOptions struct {
	Data       map[string]interface{}
	RedirectTo string
}