跳至主要内容

Prisma ORM 和 SQLite 快速入门

SQLite 是一款轻量级、基于文件的数据库，非常适合开发、原型设计和小型应用程序。它无需设置，并将数据存储在本地文件中。

本指南将介绍如何从头开始设置新的 TypeScript 项目，使用 Prisma ORM 将其连接到 SQLite，并生成 Prisma Client 以便轻松、类型安全地访问数据库。

先决条件​

您需要

  • 您的机器上安装了 Node.js v20.19+、v22.12+ 或 v24.0+
  • JavaScript 或 TypeScript 基础知识

1. 创建新项目​

创建一个项目目录并进入该目录

mkdir hello-prisma
cd hello-prisma

初始化一个 TypeScript 项目

npm init -y
npm install typescript tsx @types/node --save-dev
npx tsc --init

2. 安装所需的依赖项​

安装本快速入门所需的软件包

npm install prisma @types/node @types/better-sqlite3 --save-dev 
npm install @prisma/client @prisma/adapter-better-sqlite3 dotenv
pnpm 用户使用 SQLite

如果使用 pnpm 10+ 和 pnpx，由于 SQLite 的原生依赖要求，在运行 Prisma Studio 时需要 --allow-build=better-sqlite3 标志。

每个包的作用如下

  • prisma - 用于运行 prisma init、prisma migrate 和 prisma generate 等命令的 Prisma CLI
  • @prisma/client - 用于查询数据库的 Prisma Client 库
  • @prisma/adapter-better-sqlite3 - 连接 Prisma Client 到数据库的 SQLite 驱动适配器
  • @types/better-sqlite3 - better-sqlite3 的 TypeScript 类型定义
  • dotenv - 从您的 .env 文件加载环境变量

3. 配置 ESM 支持​

更新 tsconfig.json 以兼容 ESM

tsconfig.json
{
  "compilerOptions": {
    "module": "ESNext",
    "moduleResolution": "node",
    "target": "ES2023",
    "strict": true,
    "esModuleInterop": true,
    "ignoreDeprecations": "6.0"
  }
}

更新 package.json 以启用 ESM

package.json
{
  "type": "module",
}

4. 初始化 Prisma ORM​

现在，您可以通过在 Prisma CLI 前面加上 npx 来调用它

npx prisma

接下来，使用以下命令创建 Prisma Schema 文件，设置您的 Prisma ORM 项目

npx prisma init --datasource-provider sqlite --output ../generated/prisma

此命令执行以下操作

  • 创建一个 prisma/ 目录，其中包含一个 schema.prisma 文件，其中包含您的数据库连接和模式模型
  • 在根目录中创建一个 .env 文件用于环境变量
  • 创建一个 prisma.config.ts 文件用于 Prisma 配置

生成的 prisma.config.ts 文件如下所示

prisma.config.ts
import 'dotenv/config'
import { defineConfig, env } from 'prisma/config'

export default defineConfig({
  schema: 'prisma/schema.prisma',
  migrations: {
    path: 'prisma/migrations',
  },
  datasource: {
    url: env('DATABASE_URL'),
  },
})

生成的 schema 使用带有自定义输出路径的 ESM 优先的 prisma-client 生成器

prisma/schema.prisma
generator client {
  provider = "prisma-client"
  output   = "../generated/prisma"
}

datasource db {
  provider = "sqlite"
}

应创建一个包含以下值的 .env 文件

.env
DATABASE_URL="file:./dev.db"

5. 定义您的数据模型​

打开 prisma/schema.prisma 并添加以下模型

prisma/schema.prisma
generator client {
  provider = "prisma-client"
  output   = "../generated/prisma"
}

datasource db {
  provider = "sqlite"
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}

model Post {
  id        Int     @id @default(autoincrement())
  title     String
  content   String?
  published Boolean @default(false)
  author    User    @relation(fields: [authorId], references: [id])
  authorId  Int
}

6. 创建并应用您的第一个迁移​

创建您的第一个迁移以设置数据库表

npx prisma migrate dev --name init

此命令根据您的模式创建数据库表。

现在运行以下命令生成 Prisma Client

npx prisma generate

7. 实例化 Prisma Client​

现在您已经安装了所有依赖项，您可以实例化 Prisma Client。您需要将 Prisma ORM 驱动程序适配器的实例传递给 PrismaClient 构造函数

lib/prisma.ts
import "dotenv/config";
import { PrismaBetterSqlite3 } from "@prisma/adapter-better-sqlite3";
import { PrismaClient } from "../generated/prisma/client";

const connectionString = `${process.env.DATABASE_URL}`;

const adapter = new PrismaBetterSqlite3({ url: connectionString });
const prisma = new PrismaClient({ adapter });

export { prisma };
将 SQLite 与 Bun 一起使用

当目标为 Bun 时，请使用 @prisma/adapter-libsql 适配器，而不是 @prisma/adapter-better-sqlite3。Bun 不支持 better-sqlite3 所依赖的原生 SQLite 驱动（请参阅 node:sqlite 参考）。像这样实例化 Prisma Client：

import 'dotenv/config';
import { PrismaLibSql } from '@prisma/adapter-libsql';
import { PrismaClient } from '../generated/prisma/client';

const adapter = new PrismaLibSql({
  url: process.env.DATABASE_URL ?? '',
});

const prisma = new PrismaClient({ adapter });

export { prisma };

8. 编写您的第一个查询​

创建一个 script.ts 文件来测试您的设置

script.ts
import { prisma } from './lib/prisma'

async function main() {
  // Create a new user with a post
  const user = await prisma.user.create({
    data: {
      name: 'Alice',
      email: 'alice@prisma.io',
      posts: {
        create: {
          title: 'Hello World',
          content: 'This is my first post!',
          published: true,
        },
      },
    },
    include: {
      posts: true,
    },
  })
  console.log('Created user:', user)

  // Fetch all users with their posts
  const allUsers = await prisma.user.findMany({
    include: {
      posts: true,
    },
  })
  console.log('All users:', JSON.stringify(allUsers, null, 2))
}

main()
  .then(async () => {
    await prisma.$disconnect()
  })
  .catch(async (e) => {
    console.error(e)
    await prisma.$disconnect()
    process.exit(1)
  })

运行脚本

npx tsx script.ts

您应该会在控制台中看到创建的用户和所有用户！

9. 使用 Prisma Studio 探索您的数据​

Prisma Studio 是一个用于数据库的可视化编辑器。使用以下命令启动它

npx prisma studio --config ./prisma.config.ts

这会打开一个 Web 界面，您可以在其中查看和编辑数据。

支持的数据库

Prisma Studio 目前支持 PostgreSQL、MySQL 和 SQLite。有关更多详细信息，请参阅Prisma Studio 支持的数据库。

Prisma Studio 的 SQLite 要求
  • 目前，SQLite 的数据库 URL 中的文件路径必须包含 file: 协议
  • Node.js 22.5+：可直接使用内置的 node:sqlite 模块
    • 可能需要 NODE_OPTIONS=--experimental-sqlite 环境变量
  • Node.js 20：需要安装 better-sqlite3 作为依赖项
  • Deno >= 2.2：通过 内置 SQLite 模块 支持
  • Bun：Prisma Studio 对 SQLite 的支持即将推出，目前尚未可用
使用 npx 和 better-sqlite3

如果您的运行时中没有 node:sqlite 可用，或者不想将 better-sqlite3 作为硬依赖项安装（它会增加约 10MB），您可以使用 npx 临时安装所需的包

npx -p better-sqlite3 -p prisma prisma studio --url file:./dev.db

此命令

  • 临时安装 better-sqlite3，而无需将其添加到您的项目依赖项中
  • 使用指定的 SQLite 数据库文件运行 Prisma Studio
  • 避免了项目中 better-sqlite3 的 10MB 开销

后续步骤​

您已成功设置 Prisma ORM。接下来您可以探索

  • 了解有关 Prisma Client 的更多信息：探索 Prisma Client API 以进行高级查询、筛选和关系操作
  • 数据库迁移：了解 Prisma Migrate 以演进您的数据库模式
  • 性能优化：发现查询优化技术
  • 构建完整的应用程序：查看我们的框架指南，将 Prisma ORM 与 Next.js、Express 等集成
  • 加入社区：在 Discord 上与其他开发者联系

更多信息​

打开方式
复制为 Markdown
在 Claude 中打开
在 ChatGPT 中打开
在 T3.chat 中打开
在 GitHub 中编辑
© . This site is unofficial and not affiliated with Prisma Data, Inc.