diff --git a/examples/aws-prisma/.gitignore b/examples/aws-prisma/.gitignore
new file mode 100644
index 000000000..11ddd8dbe
--- /dev/null
+++ b/examples/aws-prisma/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+# Keep environment variables out of version control
+.env
diff --git a/examples/aws-prisma/index.ts b/examples/aws-prisma/index.ts
new file mode 100644
index 000000000..99633c21b
--- /dev/null
+++ b/examples/aws-prisma/index.ts
@@ -0,0 +1,15 @@
+import { prisma } from "./prisma";
+
+async function createUser(name: string, email: string) {
+ return prisma.user.create({
+ data: { name, email },
+ });
+}
+
+export async function handler() {
+ const user = await createUser("Alice", `alice-${crypto.randomUUID()}@example.com`);
+ return {
+ statusCode: 201,
+ body: JSON.stringify({ user }),
+ };
+}
diff --git a/examples/aws-prisma/package.json b/examples/aws-prisma/package.json
new file mode 100644
index 000000000..5883b3fec
--- /dev/null
+++ b/examples/aws-prisma/package.json
@@ -0,0 +1,23 @@
+{
+ "name": "aws-prisma",
+ "version": "1.0.0",
+ "description": "",
+ "main": "index.js",
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "keywords": [],
+ "author": "",
+ "license": "ISC",
+ "devDependencies": {
+ "@types/aws-lambda": "^8.10.145",
+ "@types/node": "^22.5.4",
+ "prisma": "^5.19.1",
+ "ts-node": "^10.9.2",
+ "typescript": "^5.5.4"
+ },
+ "dependencies": {
+ "@prisma/client": "^5.19.1",
+ "sst": "latest"
+ }
+}
diff --git a/examples/aws-prisma/prisma.ts b/examples/aws-prisma/prisma.ts
new file mode 100644
index 000000000..e0ccce7e3
--- /dev/null
+++ b/examples/aws-prisma/prisma.ts
@@ -0,0 +1,16 @@
+import { Resource } from "sst";
+import { PrismaClient } from './.prisma/client';
+
+const globalForPrisma = global as unknown as { prisma: PrismaClient }
+
+export const prisma = globalForPrisma.prisma ||
+ new PrismaClient({
+ datasources: {
+ db: {
+ url: `postgresql://${Resource.MyPostgres.username}:${Resource.MyPostgres.password}@${Resource.MyPostgres.host}:${Resource.MyPostgres.port}/${Resource.MyPostgres.database}?connection_limit=1`,
+ },
+ },
+ });
+
+// Create single client in `sst dev`
+if (process.env.NODE_ENV !== 'production') globalForPrisma.prisma = prisma
diff --git a/examples/aws-prisma/prisma/migrations/0_init/migration.sql b/examples/aws-prisma/prisma/migrations/0_init/migration.sql
new file mode 100644
index 000000000..1e9eb8fd0
--- /dev/null
+++ b/examples/aws-prisma/prisma/migrations/0_init/migration.sql
@@ -0,0 +1,11 @@
+-- CreateTable
+CREATE TABLE "User" (
+ "id" SERIAL NOT NULL,
+ "name" TEXT,
+ "email" TEXT NOT NULL,
+
+ CONSTRAINT "User_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "User_email_key" ON "User"("email");
diff --git a/examples/aws-prisma/prisma/schema.prisma b/examples/aws-prisma/prisma/schema.prisma
new file mode 100644
index 000000000..895e4c104
--- /dev/null
+++ b/examples/aws-prisma/prisma/schema.prisma
@@ -0,0 +1,17 @@
+generator client {
+ provider = "prisma-client-js"
+ output = "../.prisma/client"
+ // For ARM
+ // binaryTargets = ["native", "linux-arm64-openssl-3.0.x"]
+}
+
+datasource db {
+ provider = "postgresql"
+ url = env("DATABASE_URL")
+}
+
+model User {
+ id Int @id @default(autoincrement())
+ name String?
+ email String @unique
+}
diff --git a/examples/aws-prisma/sst-env.d.ts b/examples/aws-prisma/sst-env.d.ts
new file mode 100644
index 000000000..e35101c72
--- /dev/null
+++ b/examples/aws-prisma/sst-env.d.ts
@@ -0,0 +1,23 @@
+/* tslint:disable */
+/* eslint-disable */
+import "sst"
+declare module "sst" {
+ export interface Resource {
+ "MyApi": {
+ "name": string
+ "type": "sst.aws.Function"
+ "url": string
+ }
+ "MyPostgres": {
+ "clusterArn": string
+ "database": string
+ "host": string
+ "password": string
+ "port": number
+ "secretArn": string
+ "type": "sst.aws.Postgres"
+ "username": string
+ }
+ }
+}
+export {}
diff --git a/examples/aws-prisma/sst.config.ts b/examples/aws-prisma/sst.config.ts
new file mode 100644
index 000000000..106228597
--- /dev/null
+++ b/examples/aws-prisma/sst.config.ts
@@ -0,0 +1,85 @@
+///
+
+/**
+ * ## Prisma in Lambda
+ *
+ * To use Prisma in a Lambda function you need:
+ *
+ * 1. [`@prisma/client`](https://www.npmjs.com/package/@prisma/client) package
+ * 2. The generated Prisma client from `npx prisma generate`
+ *
+ * You don't need a layer to deploy these because `nodejs.install` automatically uses the
+ * right binary for the target Lambda architecture.
+ *
+ * ```ts title="sst.config.ts"
+ * {
+ * nodejs: { install: ["@prisma/client"] }
+ * }
+ * ```
+ *
+ * However, this overwrites the default client in `node_modules/.prisma/client` that's generated
+ * by Prisma. So we need to use a different directory.
+ *
+ * ```prisma title="prisma/schema.prisma"
+ * generator client {
+ * provider = "prisma-client-js"
+ * output = "../.prisma/client"
+ * }
+ * ```
+ *
+ * And then we need to copy the generated client to the function.
+ *
+ * ```ts title="sst.config.ts"
+ * {
+ * copyFiles: [{
+ * from: ".prisma/client/"
+ * }]
+ * }
+ * ```
+ *
+ * We also need to import this client in the function.
+ *
+ * ```ts title="prisma.ts"
+ * import { PrismaClient } from "./.prisma/client";
+ * ```
+ *
+ * #### Prisma in serverless environments
+ *
+ * Prisma unfortunately is [not great in serverless environments](https://www.prisma.io/docs/orm/prisma-client/setup-and-configuration/databases-connections#serverless-environments-faas). For a couple of reasons:
+ *
+ * 1. It doesn't support Data API, so you need to manage the connection pool on your own.
+ * 2. Without the Data API, your functions need to run inside a VPC.
+ * - You cannot use `sst dev` without [connecting to the VPC](/docs/live#using-a-vpc).
+ * 3. Due to the internal architecture of their client, it's also has slower cold starts.
+ *
+ * Instead we recommend using Drizzle. This example is here for reference for people that are
+ * already using Prisma.
+ */
+export default $config({
+ app(input) {
+ return {
+ name: "aws-prisma",
+ removal: input?.stage === "production" ? "retain" : "remove",
+ home: "aws",
+ };
+ },
+ async run() {
+ const vpc = new sst.aws.Vpc("MyVpc", { nat: "managed" });
+ const rds = new sst.aws.Postgres("MyPostgres", { vpc });
+
+ const api = new sst.aws.Function("MyApi", {
+ vpc,
+ url: true,
+ link: [rds],
+ handler: "index.handler",
+ copyFiles: [{
+ from: ".prisma/client/",
+ }],
+ nodejs: { install: ["@prisma/client"] },
+ });
+
+ return {
+ api: api.url,
+ };
+ },
+});
diff --git a/examples/aws-prisma/tsconfig.json b/examples/aws-prisma/tsconfig.json
new file mode 100644
index 000000000..8bb6097f8
--- /dev/null
+++ b/examples/aws-prisma/tsconfig.json
@@ -0,0 +1,108 @@
+{
+ "compilerOptions": {
+ /* Visit https://aka.ms/tsconfig to read more about this file */
+
+ /* Projects */
+ // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+ // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
+ // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
+ // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
+ // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
+ // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
+
+ /* Language and Environment */
+ "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+ // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+ // "jsx": "preserve", /* Specify what JSX code is generated. */
+ // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
+ // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
+ // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+ // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+ // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+ // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+ // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
+ // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
+ // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
+
+ /* Modules */
+ "module": "commonjs", /* Specify what module code is generated. */
+ // "rootDir": "./", /* Specify the root folder within your source files. */
+ // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
+ // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
+ // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
+ // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
+ // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
+ // "types": [], /* Specify type package names to be included without being referenced in a source file. */
+ // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
+ // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
+ // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+ // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
+ // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
+ // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+ // "resolveJsonModule": true, /* Enable importing .json files. */
+ // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
+ // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */
+
+ /* JavaScript Support */
+ // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+ // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
+ // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+ /* Emit */
+ // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+ // "declarationMap": true, /* Create sourcemaps for d.ts files. */
+ // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
+ // "sourceMap": true, /* Create source map files for emitted JavaScript files. */
+ // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
+ // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+ // "outDir": "./", /* Specify an output folder for all emitted files. */
+ // "removeComments": true, /* Disable emitting comments. */
+ // "noEmit": true, /* Disable emitting files from a compilation. */
+ // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+ // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+ // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
+ // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
+ // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
+ // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+ // "newLine": "crlf", /* Set the newline character for emitting files. */
+ // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+ // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
+ // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
+ // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
+ // "declarationDir": "./", /* Specify the output directory for generated declaration files. */
+
+ /* Interop Constraints */
+ // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
+ // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+ // "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+ // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
+ "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+ // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+ "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+
+ /* Type Checking */
+ "strict": true, /* Enable all strict type-checking options. */
+ // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+ // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
+ // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+ // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+ // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
+ // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
+ // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
+ // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
+ // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
+ // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
+ // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
+ // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
+ // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
+ // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
+ // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
+ // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
+ // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
+ // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
+
+ /* Completeness */
+ // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
+ "skipLibCheck": true /* Skip type checking all .d.ts files. */
+ }
+}
diff --git a/examples/aws-swift/sst.config.ts b/examples/aws-swift/sst.config.ts
index e73e754cb..7ed8591bf 100644
--- a/examples/aws-swift/sst.config.ts
+++ b/examples/aws-swift/sst.config.ts
@@ -3,7 +3,7 @@
const swiftVersion = "5.10";
/**
- * ## Swift on Lambda
+ * ## Swift in Lambda
*
* Deploys a simple Swift application to Lambda using the `al2023` runtime.
*
diff --git a/www/src/content/docs/docs/examples.mdx b/www/src/content/docs/docs/examples.mdx
index b8efaedfd..9ff8700e5 100644
--- a/www/src/content/docs/docs/examples.mdx
+++ b/www/src/content/docs/docs/examples.mdx
@@ -421,6 +421,84 @@ return {
View the [full example](https://github.com/sst/ion/tree/dev/examples/aws-multi-region).
+---
+## Prisma in Lambda
+
+To use Prisma in a Lambda function you need:
+
+1. [`@prisma/client`](https://www.npmjs.com/package/@prisma/client) package
+2. The generated Prisma client from `npx prisma generate`
+
+You don't need a layer to deploy these because `nodejs.install` automatically uses the
+right binary for the target Lambda architecture.
+
+```ts title="sst.config.ts"
+{
+ nodejs: { install: ["@prisma/client"] }
+}
+```
+
+However, this overwrites the default client in `node_modules/.prisma/client` that's generated
+by Prisma. So we need to use a different directory.
+
+```prisma title="prisma/schema.prisma"
+generator client {
+ provider = "prisma-client-js"
+ output = "../.prisma/client"
+}
+```
+
+And then we need to copy the generated client to the function.
+
+```ts title="sst.config.ts"
+{
+ copyFiles: [{
+ from: ".prisma/client/"
+ }]
+}
+```
+
+We also need to import this client in the function.
+
+```ts title="prisma.ts"
+import { PrismaClient } from "./.prisma/client";
+```
+
+#### Prisma in serverless environments
+
+Prisma unfortunately is [not great in serverless environments](https://www.prisma.io/docs/orm/prisma-client/setup-and-configuration/databases-connections#serverless-environments-faas). For a couple of reasons:
+
+1. It doesn't support Data API, so you need to manage the connection pool on your own.
+2. Without the Data API, your functions need to run inside a VPC.
+ - Lambdas inside VPCs are slower.
+ - You cannot use `sst dev` without [connecting to the VPC](/docs/live#using-a-vpc).
+3. Due to the internal architecture of their client, it's also has slower cold starts.
+
+Instead we recommend using Drizzle. This example is here for reference for people that are
+already using Prisma.
+```ts title="sst.config.ts"
+const vpc = new sst.aws.Vpc("MyVpc", { nat: "managed" });
+const rds = new sst.aws.Postgres("MyPostgres", { vpc });
+
+const api = new sst.aws.Function("MyApi", {
+ vpc,
+ url: true,
+ link: [rds],
+ handler: "index.handler",
+ copyFiles: [{
+ from: ".prisma/client/",
+ }],
+ nodejs: { install: ["@prisma/client"] },
+});
+
+return {
+ api: api.url,
+};
+```
+
+View the [full example](https://github.com/sst/ion/tree/dev/examples/aws-prisma).
+
+
---
## Puppeteer in Lambda
@@ -635,7 +713,7 @@ View the [full example](https://github.com/sst/ion/tree/dev/examples/aws-static-
---
-## Swift on Lambda
+## Swift in Lambda
Deploys a simple Swift application to Lambda using the `al2023` runtime.