DOCS

Home

Getting Started

Database

Auth

Edge Functions

Realtime

Storage

Platform

Resources

Self-Hosting

Integrations

Client Library Reference

JavaScript

Flutter

Python

Tools

Management API

Supabase CLI

Back to Home

Getting Started

Features

Architecture

Framework Quickstarts

ReactJS

NextJS

Flutter

SvelteKit

SolidJS

Vue

Web app tutorials

Next.js

React

Vue 3

Nuxt 3

Angular

RedwoodJS

SolidJS

Svelte

SvelteKit

Mobile tutorials

Flutter

Expo

Ionic React

Ionic Vue

Ionic Angular

Back to Home

functions

Quickstart

Auth

CI/CD Workflow

CORS

Debugging

Import Maps

Local Development

Managing Secrets

Schedule Functions

Examples

Cloudflare Turnstile

GitHub Actions

OG Image

Storage Caching

Stripe Webhooks

Telegram Bot

Back to Home

realtime

Overview

Quickstart

Channels

Postgres Changes

Rate Limits

Back to Home

storage

Overview

Quickstart

Access Control

CDN

Image Transformations

Back to Home

Supabase CLI

Overview

Local Development

Managing Environments

Reference

Commands

Configuration

Back to Home

platform

Add-ons

Compute Add-ons

Custom Domains

Database Backups

Platform Management

Access Control

Database Usage

HTTP Status Codes

Logging

Metrics

Migrating and Upgrading

Network Restrictions

Performance Tuning

Permissions

Single sign-on

Enable SSO for your organization

SSO with Azure AD

SSO with Google Workspace

SSO with Okta

Go-live Checklist

Production Readiness

Troubleshooting

HTTP and Project Issues

Back to Home

resources

Glossary

Migrate to Supabase

Firebase Auth

Firestore Data

Firebase Storage

Heroku

Back to Home

Self-Hosting

Overview

Self-Hosting with Docker

Auth Server

Reference

Configuration

Storage Server

Reference

Configuration

Realtime Server

Reference

Configuration

Back to Home

integrations

Overview

Auth

Auth0

Authsignal

Clerk

keyri

Stytch

SuperTokens

Caching / Offline-first

Polyscale

Developer Tools

Estuary

pgMustard

Prisma

Sequin

Snaplet

Vercel

WeWeb

Zuplo

Low-code

Appsmith

Dashibase

DhiWise

Directus

Draftbit

Plasmic

ILLA

Messaging

OneSignal

Back to Home

API Reference

Client libraries

supabase-js

supabase-dart

Other tools

Supabase CLI

Management API

Back to Main Menu

javascript

Introduction

Installing

Initializing

Typescript Support

Database

Fetch data

Insert data

Update data

Upsert data

Delete data

Call a Postgres function

Using filters

Using Modifiers

Auth

Overview

Create a new user

Sign in a user

Sign in a user through OTP

Sign in a user through OAuth

Sign out a user

Verify and log in through OTP

Retrieve a session

Retrieve a new session

Retrieve a user

Update a user

Set the session data

Listen to auth events

Send a password reset request

Enroll a factor

Create a challenge

Verify a challenge

Create and verify a challenge

Unenroll a factor

Get Authenticator Assurance Level

Auth Admin

Functions

Invoke a function

Realtime

Subscribe to channel

Unsubscribe from a channel

Unsubscribe from all channels

Retrieve all channels

Storage

Create a bucket

Retrieve a bucket

List all buckets

Update a bucket

Delete a bucket

Empty a bucket

Upload a file

Download a file

List all files in a bucket

Replace an existing file

Move an existing file

Copy an existing file

Delete files in a bucket

Create a signed URL

Create signed URLs

Retrieve public URL

Misc

Release Notes

Back to Main Menu

Supabase CLI

Introduction

Global flags

General

Initialize a local project

Log in to a Supabase account

Link to a Supabase project

Start a container

Stop all containers

Retrieve container status

Testing

Run tests

Run tests (pgTAP)

Generate Types

Run code generation tools

Generate types (Postgres schema)

Generate types (TypeScript)

Database

Manage local databases

Dump schema from remote database

Push migration to remote database

Reset local database

Diff local database

Lint local database

Manage remote databases

Commit remote database changes

Migrations

Manage database migrations

Create a migration

List all migrations

Repair migration history table

Projects

Manage projects

Create a project

List all projects

Organizations

Manage organizations

List all organizations

Edge Functions

Manage edge functions

Create a function

Download a function

Serve a function

Deploy a function

Delete a function

Secrets

Manage secrets

Set a secret

List all secrets

Unset a secret

Custom Domains

Manage custom domains

Activate custom hostname

Create a custom hostname

Retrieve custom hostname config

Re-verify custom hostname config

Delete custom hostname config

Vanity Subdomains

Manage vanity subdomains

Activate a vanity subdomain

Retrieve vanity subdomain

Check subdomain availability

Delete vanity subdomain

Network Bans

Manage network bans

Retrieve network bans

Remove a network ban

Network Restrictions

Manage network restrictions

Retrieve network restrictions

Update network restrictions

Autocompletion Scripts

Generate autocompletion scripts

Generate zsh script

Generate powershell script

Generate fish script

Generate bash script

Back to Main Menu

Self-Hosting Auth

Introduction

Usage

Generates an email action link

Get a user

Update a user

Deletes a user

List all users

Returns the created user

Redirects the user to the 3rd party oauth provider to start the oauth1 0 or oauth2 0 authentication process

Receives the redirect from an external provider during the oauth authentication process starts the process of creating an access and refresh token

The healthcheck endpoint for gotrue returns the current gotrue version

Sends an invite link to the user

Logs out the user

Passwordless sign in method for email or phone

Sends a password recovery email link to the users email

Returns the configuration settings for the gotrue server

Password based signup with either email or phone

Signs in a user with a password

Refreshes a users refresh token

Get information for the logged in user

Returns the updated user

Verifies a sign up

Back to Main Menu

Self-Hosting Realtime

Introduction

Home

Using Modifiers

Modifiers can be used on select() queries.

If a Stored Procedure returns a table response, you can also apply modifiers to the rpc() function.

Need some help?

Not to worry, our specialist engineers are here to help. Submit a support ticket through the Dashboard.

Supabase 2022—Contributing Changelog Author Styleguide Open Source SupaSquad