mirror of
https://github.com/supabase/supabase.git
synced 2026-07-26 17:32:31 -04:00
608040b8cb
Contributes to DOCS-1052 ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Resolves MDX linting errors related to "simple" where it applies. There was a couple cases that did not apply. For example, a product with "Simple" in the name. These changes are made in context, either by removing or using a more descriptive synonym like "minimal" or "basic". ## Tophatting 1. Read each of the diffs. 2. See that the text still makes sense in context. For extra due diligence, you can run `pnpm lint:mdx` locally and see the 'simple' errors that remain and whether they are worth addressing. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit * **Documentation** * Updated many guide, tutorial, and troubleshooting pages with clearer “basic”/“minimal” wording across setup steps, local testing instructions, security cautions, and RLS guidance. * Refined headings, example descriptions, and inline comments for consistency (including deployment, MCP, metrics API, and search/function phrasing). * Improved readability with small snippet formatting tweaks (whitespace plus import/comment ordering) and added a self-hosting debugging note for Envoy admin endpoints via a short-lived `curl` container. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Chris Chinchilla <chris.ward@supabase.io> Co-authored-by: Nik Richers <nrichers@gmail.com>
137 lines
5.4 KiB
Plaintext
137 lines
5.4 KiB
Plaintext
---
|
|
id: 'serverless-drivers'
|
|
title: 'Serverless Drivers'
|
|
description: 'Connecting to your Postgres database in serverless environments.'
|
|
subtitle: 'Connecting to your Postgres database in serverless environments.'
|
|
---
|
|
|
|
Supabase provides several options for connecting to your Postgres database from serverless environments.
|
|
|
|
[supabase-js](/docs/reference/javascript/introduction) is an isomorphic JavaScript client that uses the [auto-generated REST API](/docs/guides/api) and therefore works in any environment that supports HTTPS connections. This API has a built-in [connection pooler](/docs/guides/database/connecting-to-postgres#connection-pooler) and can serve thousands of simultaneous requests, and therefore is ideal for Serverless workloads.
|
|
|
|
## Vercel Edge Functions
|
|
|
|
Vercel's [Edge runtime](https://vercel.com/docs/functions/runtimes/edge-runtime) is built on top of the [V8 engine](https://v8.dev/), that provides a limited set of Web Standard APIs.
|
|
|
|
### Quickstart
|
|
|
|
Choose one of these Vercel Deploy Templates which use our [Vercel Deploy Integration](https://vercel.com/integrations/supabase) to automatically configure your connection strings as environment variables on your Vercel project!
|
|
|
|
<div>
|
|
<div className="grid grid-cols-12 gap-6 not-prose">
|
|
<Link
|
|
href="https://supabase.link/nextjs-with-supabase-starter"
|
|
className="col-span-12 md:col-span-4"
|
|
passHref
|
|
>
|
|
<GlassPanel title="supabase-js" hasLightIcon={true} background={false} showIconBg={true}>
|
|
A Next.js App Router template configured with cookie-based auth using Supabase, TypeScript
|
|
and Tailwind CSS.
|
|
</GlassPanel>
|
|
</Link>
|
|
<Link
|
|
href="https://supabase.link/nextjs-supabase-kysely"
|
|
className="col-span-12 md:col-span-4"
|
|
passHref
|
|
>
|
|
<GlassPanel title="Kysely" hasLightIcon={true} background={false} showIconBg={true}>
|
|
Basic Next.js template that uses Supabase as the database and Kysely as the query builder.
|
|
</GlassPanel>
|
|
</Link>
|
|
</div>
|
|
</div>
|
|
|
|
### Manual configuration
|
|
|
|
In your [`Database Settings`](/dashboard/project/_?showConnect=true&method=transaction) and copy the URI from the `Transaction pooler` section and save it as the `POSTGRES_URL` environment variable. Remember to replace the password placeholder with your actual database password and add the following suffix `?workaround=supabase-pooler.vercel`.
|
|
|
|
```txt .env.local
|
|
POSTGRES_URL="postgres://postgres.cfcxynqnhdybqtbhjemm:[YOUR-PASSWORD]@aws-0-ap-southeast-1.pooler.supabase.com:6543/postgres?workaround=supabase-pooler.vercel"
|
|
```
|
|
|
|
<Tabs scrollable defaultActiveId="drizzle" type="underlined" size="small">
|
|
|
|
<TabPanel id="drizzle" label="Drizzle">
|
|
|
|
```ts lib/drizzle.ts
|
|
import { sql } from '@vercel/postgres'
|
|
import { InferInsertModel, InferSelectModel } from 'drizzle-orm'
|
|
import { pgTable, serial, text, timestamp, uniqueIndex } from 'drizzle-orm/pg-core'
|
|
import { drizzle } from 'drizzle-orm/vercel-postgres'
|
|
|
|
export const UsersTable = pgTable(
|
|
'users',
|
|
{
|
|
id: serial('id').primaryKey(),
|
|
name: text('name').notNull(),
|
|
email: text('email').notNull(),
|
|
image: text('image').notNull(),
|
|
createdAt: timestamp('createdAt').defaultNow().notNull(),
|
|
},
|
|
(users) => {
|
|
return {
|
|
uniqueIdx: uniqueIndex('unique_idx').on(users.email),
|
|
}
|
|
}
|
|
)
|
|
|
|
export type User = InferSelectModel<typeof UsersTable>
|
|
export type NewUser = InferInsertModel<typeof UsersTable>
|
|
|
|
// Connect to Vercel Postgres
|
|
export const db = drizzle(sql)
|
|
```
|
|
|
|
</TabPanel>
|
|
<TabPanel id="kysely" label="Kysely">
|
|
|
|
```ts lib/kysely.ts
|
|
import { createKysely } from '@vercel/postgres-kysely'
|
|
import { ColumnType, Generated } from 'kysely'
|
|
|
|
interface UserTable {
|
|
// Columns that are generated by the database should be marked
|
|
// using the `Generated` type. This way they are automatically
|
|
// made optional in inserts and updates.
|
|
id: Generated<number>
|
|
name: string
|
|
email: string
|
|
image: string
|
|
|
|
// You can specify a different type for each operation (select, insert and
|
|
// update) using the `ColumnType<SelectType, InsertType, UpdateType>`
|
|
// wrapper. Here we define a column `createdAt` that is selected as
|
|
// a `Date`, can optionally be provided as a `string` in inserts and
|
|
// can never be updated:
|
|
createdAt: ColumnType<Date, string | undefined, never>
|
|
}
|
|
|
|
// Keys of this interface are table names.
|
|
export interface Database {
|
|
users: UserTable
|
|
}
|
|
|
|
export const db = createKysely<Database>()
|
|
export { sql } from 'kysely'
|
|
```
|
|
|
|
</TabPanel>
|
|
</Tabs>
|
|
|
|
## Cloudflare Workers
|
|
|
|
Cloudflare's Workers runtime also uses the [V8 engine](https://v8.dev/) but provides polyfills for a subset of Node.js APIs and [TCP Sockets API](https://developers.cloudflare.com/workers/runtime-apis/tcp-sockets/), giving you a couple of options:
|
|
|
|
- [supabase-js](https://developers.cloudflare.com/workers/databases/native-integrations/supabase/)
|
|
- [Postgres.js](https://github.com/porsager/postgres?tab=readme-ov-file#cloudflare-workers-support)
|
|
- [node-postgres](https://developers.cloudflare.com/workers/tutorials/postgres/)
|
|
|
|
## Supabase Edge Functions
|
|
|
|
Supabase Edge Functions uses the [Deno runtime](https://deno.com/) which has native support for TCP connections allowing you to choose your favorite client:
|
|
|
|
- [supabase-js](/docs/guides/functions/connect-to-postgres#using-supabase-js)
|
|
- [Deno Postgres driver](/docs/guides/functions/connect-to-postgres#using-a-postgres-client)
|
|
- [Postgres.js](https://github.com/porsager/postgres)
|
|
- [Drizzle](/docs/guides/functions/connect-to-postgres#using-drizzle)
|