Back to Supabase

Integrating with Supabase Database (Postgres)

apps/docs/content/guides/functions/connect-to-postgres.mdx

1.26.043.5 KB
Original Source

Connect to your Postgres database from an Edge Function by using the supabase-js client. You can also use other Postgres clients like Deno Postgres


Using supabase-js

The supabase-js client handles authorization with Row Level Security and automatically formats responses as JSON. This is the recommended approach for most applications:

ts
import { createClient } from 'npm:@supabase/supabase-js@2'

Deno.serve(async (req) => {
  try {
    const supabase = createClient(
      Deno.env.get('SUPABASE_URL') ?? '',
      Deno.env.get('SUPABASE_PUBLISHABLE_KEY') ?? '',
      { global: { headers: { Authorization: req.headers.get('Authorization')! } } }
    )

    const { data, error } = await supabase.from('countries').select('*')

    if (error) {
      throw error
    }

    return new Response(JSON.stringify({ data }), {
      headers: { 'Content-Type': 'application/json' },
      status: 200,
    })
  } catch (err) {
    return new Response(String(err?.message ?? err), { status: 500 })
  }
})

This enables:

  • Automatic Row Level Security enforcement
  • Built-in JSON serialization
  • Consistent error handling
  • TypeScript support for database schema

Using a Postgres client

Because Edge Functions are a server-side technology, it's safe to connect directly to your database using any popular Postgres client. This means you can run raw SQL from your Edge Functions.

Here is how you can connect to the database using Deno Postgres driver and run raw SQL. Check out the full example.

<$CodeSample path="/edge-functions/supabase/functions/postgres-on-the-edge/index.ts" title="Select from table with auth RLS" language="typescript"

/>


Using Drizzle

You can use Drizzle together with Postgres.js. Both can be loaded directly from npm:

Set up dependencies in import_map.json:

json
{
  "imports": {
    "drizzle-orm": "npm:[email protected]",
    "drizzle-orm/": "npm:/[email protected]/",
    "postgres": "npm:[email protected]"
  }
}

Use in your function:

ts
import { drizzle } from 'drizzle-orm/postgres-js'
import postgres from 'postgres'
import { countries } from '../_shared/schema.ts'

const connectionString = Deno.env.get('SUPABASE_DB_URL')!

Deno.serve(async (_req) => {
  // Disable prefetch as it is not supported for "Transaction" pool mode
  const client = postgres(connectionString, { prepare: false })
  const db = drizzle(client)
  const allCountries = await db.select().from(countries)

  return Response.json(allCountries)
})

You can find the full example on GitHub.


SSL connections

Production

Deployed edge functions are pre-configured to use SSL for connections to the Supabase database. You don't need to add any extra configurations.

Local development

If you want to use SSL connections during local development, follow these steps:

  1. Download the SSL certificate from Database Settings
  2. Add to your local .env file, add these two variables:
bash
SSL_CERT_FILE=/path/to/cert.crt # set the path to the downloaded cert
DENO_TLS_CA_STORE=mozilla,system

Then, restart your local development server:

bash
supabase functions serve your-function