DOCS

Home
Getting Started
Database
Serverless APIs
Auth
Edge Functions
Realtime
Storage
Platform
Resources
Self-Hosting
Integrations
Client Library Reference
JavaScript
Flutter
PythonCommunity
C#Community
SwiftCommunity
Tools
Management API
Supabase CLI

Back to Home
Getting Started
Features
Architecture
Framework Quickstarts
React
NextJS
RedwoodJS
Flutter
SvelteKit
SolidJS
Vue
Web app tutorials
NextJS
React
Vue 3
Nuxt 3
Angular
RedwoodJS
SolidJS
Svelte
SvelteKit
Mobile tutorials
Flutter
Expo
Ionic React
Ionic Vue
Ionic Angular
AI & ML
Vector Search with OpenAI

Back to Home
Database
Database Connections
Tables and Data
Database Functions
Database Webhooks
Full Text Search
Database Testing
Extensions
Overview
HypoPG: Hypothetical indexes
plv8: Javascript Language
http: RESTful Client
PGAudit: Postgres Auditing
pgjwt: JSON Web Tokens
PGroonga: Multilingual Full Text Search
pgRouting: Geospatial Routing
pg_cron: Job Scheduling
pg_graphql: GraphQL Support
pg_hashids: Short UIDs
pg_jsonschema: JSON Schema Validation
pg_net: Async Networking
pg_plan_filter: Restrict Total Cost
pg_stat_monitor: Extended Query Performance Monitoring
pgvector: Embeddings and vector similarity
pg_stat_statements: SQL Planning and Execution Statistics
pg_repack: Storage Optimization
PostGIS: Geo queries
pg-safeupdate: Required Where Clauses
pgsodium: Encryption Features
pgTAP: Unit Testing
plpgsql_check: PL/pgSQL Linter
timescaledb: Time-series data
uuid-ossp: Unique Identifiers
RUM: inverted index for full-text search
wrappers: 3rd Party Integrations
Postgres resources
Managing Indexes
Drop All Tables in Schema
Select First Row per Group
Print PostgreSQL Version
Configuration
Timeouts
Replication
Passwords
Timezones

Back to Home
Serverless APIs
Overview
Quickstart
Guides
Creating API routes
How API Keys work
Securing your API
Querying joins and nested tables
REST & REALTIME
Auto-generated Docs
Client Libraries
Generating Types
GRAPHQL
GraphiQL Documentation

Back to Home
Auth
Overview
Quickstarts
Auth with React
Authentication
Email Login
Magic Link Login
Phone Login
Social Login
Enterprise SSO
Email Templates
Authorization
Enable Captcha Protection
Managing User Data
Multi-Factor Authentication
Row Level Security
Server-side Rendering
Auth Helpers
Overview
Auth UI
Next.js (pages)
Next.js (app)
Remix
SvelteKit
Deep Dive
Part One: JWTs
Part Two: Row Level Security
Part Three: Policies
Part Four: GoTrue
Part Five: Google OAuth

Back to Home
Edge Functions
Overview
Quickstart
Features
TypeScript Support
Debugging Edge Functions
Managing packages using Import Maps
Globally Distributed Deployments
Guides
Developing Functions locally
Deploying with Git
Managing Secrets and Environment Variables
Integrating With Supabase Auth
Integrating with Supabase Storage
CORS support for Invoking from the browser
Scheduling Functions
Connecting directly to Postgres
Examples
Generating OpenAI GPT3 completions
Generating OG images
CAPTCHA support with Cloudflare Turnstile
Building a Discord Bot
Building a Telegram Bot
Handling Stripe Webhooks
Integrating with Upstash Redis
Rate Limiting Edge Functions
Taking Screenshots with Puppeteer

Back to Home
Realtime
Overview
Quickstart
Features
Channels
Extensions
Broadcast
Presence
Postgres Changes
Guides
Subscribing to Database Changes
Bring Your Own Database
Using Realtime with Next.js
Deep dive
Rate Limits
Architecture
Protocol

Back to Home
Storage
Overview
Quickstart
Uploads
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 Size
HTTP Status Codes
Logging
Metrics
Migrating and Upgrading
Network Restrictions
Performance Tuning
Permissions
SSL Enforcement
Billing
Spend cap
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
Examples
Glossary
Migrate to Supabase
Firebase Auth
Firestore Data
Firebase Storage
Heroku
Render
Amazon RDS

Back to Home
Self-Hosting
Overview
Self-Hosting with Docker
Auth Server
Reference
Configuration
Storage Server
Reference
Configuration
Realtime Server
Reference
Configuration
Analytics Server
Reference
Configuration
Functions Server
Reference

Back to Home
Integrations
Overview
Auth
Auth0
Authsignal
Clerk
keyri
Stytch
SuperTokens
Caching / Offline-first
Polyscale
Developer Tools
Estuary
OpenAI
pgMustard
Prisma
Sequin
Snaplet
Vercel
Upstash Redis
WeWeb
Zuplo
Low-code
Appsmith
DhiWise
Directus
Draftbit
FlutterFlow
Plasmic
ILLA
Messaging
OneSignal

Back to Home
API Reference
Client libraries
supabase-js
supabase-dart
supabase-csharp
supbase-python
supbase-swift
Other tools
Supabase CLI
Management API

Back to Main Menu

JavaScript

v1.0

Introduction
Initializing
Upgrade guide
Database
Fetch data
Insert data
Update data
Upsert data
Delete data
Call a Postgres function
Using filters
Using Modifiers
Auth
Create a new user
Sign in a user
Sign out a user
Retrieve a session
Update a user
Update the access token
Retrieve a user
Retrieve a session
Retrieve a user
Listen to auth events
Send a password reset request
Functions
Invoke a function
Realtime
Subscribe to channel
Remove a subscription
Remove all subscriptions
Retrieve subscriptions
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

JavaScript

v1.0

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 in a user through SSO
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
Create signed upload URL
Upload to a signed URL
Retrieve public URL
Misc
Release Notes

Back to Main Menu

Flutter

v1.0

Introduction
Initializing
Upgrade guide
Database
Fetch data
Insert data
Update data
Upsert data
Delete data
Call a Postgres function
Using filters
Using Modifiers
Auth
Create a new user
Sign in a user
Sign in a user through OAuth
Sign out a user
Retrieve a session
Retrieve a user
Retrieve a session
Retrieve a session
Retrieve a user
Update a user
Listen to auth events
Send a password reset request
Functions
Invoke a function
Realtime
Listen to database changes
Subscribe to channel
Remove a subscription
Retrieve subscriptions
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
Delete files in a bucket
Create a signed URL
Retrieve public URL

Back to Main Menu

Flutter

v1.0

Introduction
Installing
Initializing
Database
Fetch data
Insert data
Update data
Upsert data
Delete data
Call a Postgres function
Using filters
Using Modifiers
Auth
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 user
Update a user
Listen to auth events
Functions
Invoke a function
Realtime
Listen to database changes
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
Delete files in a bucket
Create a signed URL
Retrieve public URL

Back to Main Menu

C#

v1.0

Introduction
Installing
Initializing
Database
Fetch data
Insert data
Update data
Upsert data
Delete data
Call a Postgres function
Using filters
Using Modifiers
Auth
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 user
Update a user
Listen to auth events
Functions
Invoke a function
Realtime
Subscribe to channel
Unsubscribe from a channel
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
Delete files in a bucket
Create a signed URL
Retrieve public URL

Back to Main Menu

swift

v1.0

Introduction
Initializing
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
Functions
Invoke a function
Realtime
Subscribe to channel
Unsubscribe from a channel
Storage
Create a bucket
Retrieve a bucket
List all buckets
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
Delete files in a bucket
Create a signed URL

Back to Main Menu

Python

v1.0

Introduction
Initializing
Database
Fetch data
Insert data
Auth
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
Set the session data
Functions
Invoke a function
Realtime
Subscribe to channel
Storage
Create a bucket
Retrieve a bucket
List all buckets
Delete a bucket
Empty a bucket
Upload a file
Download a file
List all files in a bucket
Move an existing file
Delete files in a bucket
Create a signed URL
Retrieve public URL

Back to Main Menu

Supabase CLI

v1.0

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 functions locally
Deploy a function
Delete a function
Secrets
Manage secrets
Set a secret
List all secrets
Unset a secret
Authentication
Manage SSO on your project
List all identity providers
Show information for an identity providers
Add an identity provider
Update an identity provider
Remove an identity provider
See your project's SSO information
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
SSL Enforcement
Manage SSL enforcement configuration
Get the current SSL enforcement configuration
Update SSL enforcement configuration
Autocompletion Scripts
Generate autocompletion scripts
Generate zsh script
Generate powershell script
Generate fish script
Generate bash script

Back to Main Menu

Management API

v1.0

Introduction
Projects
List all projects
Create a project
List all organizations
Create an organization
Secrets
List all secrets
Bulk create secrets
Bulk delete secrets
Typescript
Generate TypeScript types
Functions
Create a function
List all functions
Retrieve a function
Update a function
Delete a function
Retrieve a function body
Custom Hostname
Retrieve hostname configuration
Delete hostname configuration
Update hostname configuration
Verify DNS configuration
Activate custom hostname
pgsodium
Retrieve pgsodium config
Update pgsodium config
Network
Retrieve network bans
Delete network bans
Retrieve network restrictions
Update network restrictions

Back to Main Menu

Self-Hosting Auth

v1.0

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 Storage

v1.0

Introduction
Usage
Create a bucket
Gets all buckets
Empty a bucket
Get details of a bucket
Update properties of a bucket
Delete a bucket
Delete an object
Get object
Update the object at an existing key
Upload a new object
Delete multiple objects
Retrieve an object
Generate a presigned url to retrieve an object
Retrieve an object via a presigned URL
Generate presigned urls to retrieve objects
Moves an object
Search for objects under a prefix
Retrieve object info
Copies an object
Retrieve an object from a public bucket
Get object info

Back to Main Menu

Self-Hosting Realtime

v1.0

Introduction

Back to Main Menu

Self-Hosting Analytics

v1.0

Introduction
Management API
List endpoints
Create endpoint
Delete endpoint
Fetch endpoint
Update endpoint
List sources
Create source
Delete source
Fetch source
Update source
List teams
Create team
Delete team
Fetch team
Update team

Back to Main Menu

Self-Hosting Functions

v1.0

Introduction

Javascript Reference v1.0

---

Supabase 2022—ContributingChangelogAuthor StyleguideOpen SourceSupaSquad