Menu

Home
GitHub(opens in a new tab)

Start with Supabase

Overview
Build with AI tools
The Supabase way to build
API Keys
Local Development
Architecture
Migrating to new API keys

Start with Supabase › Framework Quickstarts

React
Next.js
TanStack Start
Astro
Vue
Nuxt
SvelteKit
SolidJS
RedwoodJS
Refine
Hono
iOS SwiftUI
Android Kotlin
Expo React Native
Flutter
Flask (Python)
Reflex (Python)
Laravel PHP
Ruby on Rails
Spring Boot

Start with Supabase › Web app demos

Next.js
React
Vue 3
Nuxt 3
Angular
RedwoodJS
SolidJS
Svelte
SvelteKit
Refine

Start with Supabase › Mobile tutorials

Flutter
Expo React Native
Android Kotlin
Ionic React
Ionic Vue
Ionic Angular
Swift

Database

Overview

Database › Fundamentals

Connecting to your database
Importing data
Securing your data

Database › Fundamentals › Connecting to your database

Connecting to your database
Connection pooling and limits
Serverless drivers

Database › Working with your database (basics)

Managing tables and data
Views
Working with arrays
Managing indexes
Querying joins and nested tables
JSON and unstructured data

Database › Working with your database (intermediate)

Implementing cascade deletes
Deleting data and dropping objects safely
Managing enums
Managing database functions
Debugging database functions
Managing database triggers
Managing database webhooks
Using Full Text Search
Partitioning your tables
Migrating to pg_partman
Managing connections
Managing event triggers

Database › OrioleDB

Overview

Database › Multigres

Overview
Compatibility

Database › Access and security

Row Level Security
Row Level Security Performance
Column Level Security
Managing Postgres Roles
Using Custom Postgres Roles
Managing secrets with Vault
Superuser Access and Unsupported Operations

Database › Configuration, optimization, and testing

Database configuration
Query optimization
Database Advisors
Testing your database
Customizing Postgres config
Postgres log configuration

Database › Debugging

Timeouts
Inspect the database
Debugging performance issues
Supavisor

Database › ORM Quickstarts

Prisma
Drizzle
Postgres.js

Database › ORM Quickstarts › Prisma

Connecting with Prisma
Prisma troubleshooting

Database › GUI quickstarts

pgAdmin
PSQL
DBeaver
Metabase
Beekeeper Studio

Database › Database replication

Overview
Pipelines
Manual replication

Database › Database replication › Pipelines

Setting up
BigQuery
ClickHouse
DuckLake
Snowflake
Monitoring
FAQ

Database › Database replication › Manual replication

Setting up
Monitoring
FAQ

Database › Extensions

Overview
HypoPG: Hypothetical indexes
plv8 (deprecated)
http: RESTful Client
index_advisor: Query optimization
PGAudit: Postgres Auditing
pgjwt (deprecated)
PGroonga: Multilingual Full Text Search
pgRouting: Geospatial Routing
pg_cron: Schedule Recurring Jobs
pg_graphql: GraphQL Support
pg_hashids: Short UIDs
pg_jsonschema: JSON Schema Validation
pg_net: Async Networking
pg_partman: Partition management
pg_plan_filter: Restrict Total Cost
postgres_fdw: query data from an external Postgres server
pgvector: Embeddings and vector similarity
pg_stat_statements: SQL Planning and Execution Statistics
pg_repack: Storage Optimization
PostGIS: Geo queries
pgmq: Queues
pgsodium (pending deprecation): Encryption Features
pgTAP: Unit Testing
plpgsql_check: PL/pgSQL Linter
timescaledb (deprecated)
uuid-ossp: Unique Identifiers
RUM: inverted index for full-text search

Database › Foreign Data Wrappers

Overview

Database › Examples

Drop All Tables in Schema
Select First Row per Group
Print Postgres Version
Replicating from Supabase to External Postgres

Auth

Overview
Architecture

Auth › Getting Started

Next.js
Astro
React
React Native
React Native with Expo & Social Sign-in

Auth › Concepts

Users
Identities
Sessions

Auth › Concepts › Sessions

User sessions
Implicit flow
PKCE flow

Auth › Flows (How-tos)

Which package to use
Server-Side Rendering
Password-based
Email (Magic link or OTP)
Phone sign-in
Passkey
Social Sign-in (OAuth)
Enterprise SSO
Custom OAuth/OIDC Providers
Anonymous Sign-Ins
Web3 (Ethereum or Solana)
Mobile Deep Linking
Identity Linking
Multi-Factor Authentication
Signout

Auth › Flows (How-tos) › Server-Side Rendering

Overview
Creating a client
Migrating from Auth Helpers
Advanced guide

Auth › Flows (How-tos) › Social Sign-in (OAuth)

Overview
Google
Facebook
Apple
Azure (Microsoft)
Twitter
GitHub
Gitlab
Bitbucket
Discord
Figma
Kakao
Keycloak
LinkedIn
Notion
Slack
Spotify
Twitch
WorkOS
Zoom

Auth › Flows (How-tos) › Enterprise SSO

Overview
SAML 2.0

Auth › Flows (How-tos) › Multi-Factor Authentication

Overview
App Authenticator (TOTP)
Phone

Auth › Debugging

Error Codes

Auth › OAuth 2.1 Server

Overview
Getting Started
OAuth Flows
MCP Authentication
Token Security & RLS

Auth › Third-party auth

Overview
Clerk
Firebase Auth
Auth0
AWS Cognito (Amplify)
WorkOS
Custom OIDC

Auth › Configuration

General Configuration
Email Templates
Redirect URLs
Auth Hooks
Custom SMTP
Test Auth Flows
User Management

Auth › Configuration › Auth Hooks

Overview
Custom access token hook
Send SMS hook
Send email hook
MFA verification hook
Password verification hook
Before User Created hook

Auth › Security

Password Security
Rate Limits
Bot Detection (CAPTCHA)
Audit Logs
JSON Web Tokens (JWT)
JWT Signing Keys
Row Level Security
Column Level Security

Auth › Security › JSON Web Tokens (JWT)

Overview
Claims Reference

Storage

Overview

Storage › File Buckets

Quickstart
Fundamentals
Creating Buckets
Pricing

Storage › File Buckets › Security

Ownership
Access Control

Storage › File Buckets › Uploads

Standard Uploads
Resumable Uploads
S3 Uploads
Limits

Storage › File Buckets › Serving

Serving assets
Image Transformations
Bandwidth & Storage Egress

Storage › File Buckets › Management

Copy / Move Objects
Delete Objects
Download Objects

Storage › File Buckets › S3

Authentication
API Compatibility

Storage › File Buckets › CDN

Fundamentals
Smart CDN
Purging Cache
Metrics

Storage › File Buckets › Debugging

Logs
Error Codes

Storage › File Buckets › Schema

Database Design
Helper Functions
Custom Roles

Storage › File Buckets › Going to production

Scaling

Storage › Analytics Buckets

Introduction
Creating Buckets
Iceberg Catalog
Query with Postgres
Limits
Pricing

Storage › Analytics Buckets › Examples

Using DuckDB
Using PyIceberg
Using Apache Spark

Storage › Vector Buckets

Introduction
Creating Buckets
Working with Indexes
Storing Vectors
Querying Vectors
Local Development
Limits

Edge Functions

Overview

Edge Functions › Getting started

Quickstart (Dashboard)
Quickstart (CLI)
Development Environment
Architecture

Edge Functions › Configuration

Environment variables
Managing Dependencies
Function Configuration

Edge Functions › Development

Error Handling
Routing
Deploy to Production

Edge Functions › Debugging

Local Debugging with DevTools
Testing your Functions
Logging
Error codes

Edge Functions › Platform

Regional invocations
Status codes
Recursive/Nested function calls
Limits
Pricing

Edge Functions › Integrations

Supabase Auth
Supabase Database (Postgres)
Supabase Storage

Edge Functions › Integrations › Supabase Auth

Securing your functions
Authorization headers
Legacy JWT secret

Edge Functions › Advanced Features

Background Tasks
File Storage
WebSockets
Custom Routing
Wasm Modules
AI Models

Edge Functions › Examples

Auth Send Email Hook
Building an MCP Server with mcp-lite
CORS support for invoking from the browser
Scheduling Functions
Sending Push Notifications
Generating AI images
Generating OG images
Semantic AI Search
CAPTCHA support with Cloudflare Turnstile
Building a Discord Bot
Building a Telegram Bot
Handling Stripe Webhooks
Rate-limiting with Redis
Taking Screenshots with Puppeteer
Slack Bot responding to mentions
Image Transformation & Optimization
Resumable WebSockets with replay

Edge Functions › Third-Party Tools

Dart Edge on Supabase
mcp-lite (Model Context Protocol)
Browserless.io
Hugging Face
Monitoring with Sentry
OpenAI API
React Email
Sending Emails with Resend
Upstash Redis
Type-Safe SQL with Kysely
Text To Speech with ElevenLabs
Speech Transcription with ElevenLabs

Realtime

Overview
Getting Started

Realtime › Usage

Broadcast
Presence
Postgres Changes
Settings

Realtime › Security

Authorization

Realtime › Guides

Realtime Reports
Subscribing to Database Changes
Using Realtime with Next.js
Using Realtime Presence with Flutter
Listening to Postgres Changes with Flutter

Realtime › Deep dive

Limits
Pricing
Architecture
Concepts
Protocol
Benchmarks

Realtime › Debugging

Operational Error Codes

Data REST API

Overview
Quickstart
Client Libraries

Data REST API › Security

Securing your API
Custom Claims & RBAC

Data REST API › Tools

Auto-generated Docs
SQL to REST API Translator

Data REST API › Guides

Creating API routes
Generating TypeScript Types
Generating Python Types
Error Codes

Data REST API › Using the Data APIs

Managing tables and data
Views
Querying joins and nested tables
JSON and unstructured data
Managing database functions
Using full-text search
Debugging performance issues
Using custom schemas
Converting from SQL to JavaScript API

Data REST API › Debugging

Handling Errors in supabase-js

AI & Vectors

Overview
Concepts
Structured & unstructured

AI & Vectors › Learn

Vector columns
Vector indexes
Automatic embeddings
Engineering for scale
Choosing Compute Add-on
Going to Production
RAG with Permissions

AI & Vectors › Learn › Vector indexes

Overview
HNSW indexes
IVFFlat indexes

AI & Vectors › Search

Semantic search
Keyword search
Hybrid search

AI & Vectors › JavaScript Examples

OpenAI completions using Edge Functions
Generate image captions using Hugging Face
Generate Embeddings
Adding generative Q&A to your documentation
Adding generative Q&A to your Next.js site

AI & Vectors › Python Client

Choosing a Client

AI & Vectors › Python Examples

Developing locally with Vecs
Creating and managing collections
Text Deduplication
Face similarity search
Image search with OpenAI CLIP
Semantic search with Amazon Titan
Building ChatGPT Plugins

AI & Vectors › Third-Party Tools

LangChain
Hugging Face
Google Colab
LlamaIndex
Roboflow
Amazon Bedrock
Fireworks AI
Mixpeek

Cron

Overview

Cron › Getting Started

Install
Quickstart

Queues

Overview

Queues › Getting Started

Quickstart
Consuming Messages with Edge Functions
Expose Queues for local and self-hosted Supabase

Queues › References

API
PGMQ Extension

AI Tools

Overview
Agent Plugin
MCP server
Agent Skills
Prompts

AI Tools › Build AI features

Deploy MCP servers
Vectors / Embeddings

Local Dev / CLI

Overview
Install and run the CLI
Local development workflow

Local Dev / CLI › Guides

Database migrations
Running multiple local projects
Docker and native runtimes
Declarative database schemas
Diff engines
Seeding your database
Managing config and secrets
Restoring downloaded backup
Customizing email templates

Local Dev / CLI › Testing

Getting started
pgTAP advanced guide
Database testing
RLS policies testing

Deployment & Branching

Overview

Deployment & Branching › Environments

Managing environments
Database migrations

Deployment & Branching › Branching

Overview
Branching via GitHub
Branching via dashboard
Working with branches
Configuration
Integrations
Troubleshooting
Billing

Deployment & Branching › Terraform

Terraform reference

Deployment & Branching › Production readiness

Shared responsibility model
Maturity model
Production checklist
SOC 2 compliance

Self-Hosting

Overview
Deploy with Docker
Accessing Postgres
Configure new API keys
Learn about API Gateway
Add Reverse Proxy with HTTPS
Upgrade to Postgres 17
Remove superuser access
Update your deployment

Self-Hosting › How-to Guides

Run Self-Hosted Functions
Configure S3 Storage
Enable MCP server
Configure Social Sign-in (OAuth)
Configure Custom OAuth/OIDC
Configure Phone Sign-in & MFA
Add Custom Email Templates
Configure Auth Hooks
Configure Passkeys
Configure SAML 2.0 SSO
Restore Project from Platform
Copy Storage from Platform
Build Custom Extensions

Self-Hosting › Functions Server

Guide

Integrations

Overview
Partner Catalog
Vercel Marketplace
Stripe Projects

Integrations › Build Your Own

Supabase OAuth Integration
Supabase for Platforms
Supabase partner integration guide

Integrations › Build Your Own › Supabase OAuth Integration

Overview
OAuth scopes

Platform

Overview

Platform › Add-ons

Custom Domains
Database Backups
IPv4 Address
Read Replicas

Platform › Add-ons › Read Replicas

Overview
Getting started

Platform › Upgrades & Migrations

Upgrading
Migrating within Supabase

Platform › Upgrades & Migrations › Migrating within Supabase

Overview
Restore Dashboard backup
Backup and restore using CLI

Platform › Project & Account Management

Access Control
Personal Access Tokens
Multi-factor Authentication
Transfer Project
Restore to a new project
Project Pausing
Delete Project
Single Sign-On
Platform Webhooks

Platform › Project & Account Management › Multi-factor Authentication

Overview
Enforce MFA on organization

Platform › Project & Account Management › Single Sign-On

Overview
Understanding Login Flows
Choosing a Login Flow
SSO with Azure AD
SSO with Google Workspace
SSO with Okta
Multiple SSO Providers
Testing and Best Practices
Enterprise-Managed Authentication for MCP

Platform › Project & Account Management › Platform Webhooks

Overview
Events

Platform › Platform Configuration

Regions
Compute and Disk
Database Size
HIPAA Projects
Network Restrictions
Temporary Access
Performance Tuning
SSL Enforcement
Postgres Connection Logging
Default Platform Permissions
PrivateLink

Platform › Billing

About billing on Supabase
Get set up for billing
Manage your subscription
Manage your usage
Your monthly invoice
Control your costs
Credits
AWS Marketplace
Billing FAQ

Platform › Billing › Manage your usage

Overview
Compute
Egress
Disk Size
Disk Throughput
Disk IOPS
Monthly Active Users
Monthly Active Third-Party Users
Monthly Active SSO Users
Storage Size
Storage Image Transformations
Edge Function Invocations
Realtime Messages
Realtime Peak Connections
Custom Domains
Point-in-Time Recovery
IPv4
MFA Phone
Read Replicas
Branching
Logs
Logs Ingest
Logs Query
Log Drains
Pipelines

Platform › Billing › AWS Marketplace

Overview
Getting Started
Account Setup
Manage your subscription
Invoices
FAQ

Security

Overview

Security › Product security

Platform configuration
TLS for project APIs
Product configuration
Security testing
Platform Audit Logs

Security › Compliance

SOC 2
HIPAA
GDPR

Security › Guides

Production Checklist
Shared Responsibility Model
Row Level Security
Securing your API
Securing your npm installs

Observability

Overview

Observability › Read project data

Query logs with SQL
Logs in Studio
Log sources and fields
Inspect the database
Advisors
Reports
Metrics API

Observability › Read project data › Metrics API

Grafana Cloud
Grafana self-hosted
Vendor-agnostic setup

Observability › Detect and diagnose

Detection checks

Observability › Agent prompts

Overview
Health
Security
Performance
Resources

Observability › Configure and export

Configure logging
Log drains
Client-side tracing
Sentry integration

Resources

Overview
Glossary

pgmq: Queues

See the Supabase Queues docs.

Edit on GitHub

Adapted from supabase.com/docs/guides/database/extensions/pgmq by Supabase, licensed under Apache-2.0. Changes were made: this page is re-rendered from the original's source.

PreviousPostGIS: Geo queries Nextpgsodium (pending deprecation): Encryption Features

Wide content