Prisma Generator 项目启动与配置教程

1. 项目目录结构及介绍

Prisma Generator 项目的目录结构如下：

create-prisma-generator/
├── .gitignore          # 忽略文件列表
├── .vscode             # Visual Studio Code 的配置文件
├── build               # 构建文件目录
│   └── ...
├── docs                # 文档目录
│   └── ...
├── jest                # Jest 测试配置文件
│   └── ...
├── packages            # 包含所有子包的目录
│   ├── ...
│   └── ...
├── prisma              # Prisma 配置文件目录
│   ├── schema.prisma   # Prisma schema 文件
│   └── ...
├── scripts             # 脚本文件目录
│   └── ...
├── src                 # 源代码目录
│   ├── ...
│   └── ...
├── test                # 测试文件目录
│   └── ...
└── ...                 # 其他文件和目录

主要目录说明：

• .gitignore: 指定在 Git 仓库中应该忽略的文件和目录。
• .vscode: 存储 Visual Studio Code 编辑器的配置文件。
• build: 构建相关的文件和目录。
• docs: 项目文档存放目录。
• jest: Jest 测试框架的配置文件。
• packages: 存储项目中的子包。
• prisma: Prisma 配置文件目录。
• scripts: 脚本文件存放目录，用于执行各种自动化任务。
• src: 源代码目录，包含项目的核心代码。
• test: 测试文件存放目录。

2. 项目的启动文件介绍

项目的启动文件通常位于 src 目录下，具体文件名可能因项目而异。以下是一个常见的启动文件 index.js 的示例：

// index.js
const { PrismaClient } = require('@prisma/client');

const prisma = new PrismaClient();

async function main() {
    // 在这里执行数据库操作
    const users = await prisma.user.findMany();
    console.log(users);
}

main()
  .catch(e => {
    throw e;
  })
  .finally(async () => {
    await prisma.$disconnect();
  });

这个文件创建了一个 Prisma 客户端实例，并定义了一个异步函数 main 来执行数据库操作。最后，它调用 main 函数，并处理可能出现的错误。

3. 项目的配置文件介绍

项目的配置文件通常位于 prisma 目录下的 schema.prisma 文件。这个文件定义了 Prisma 客户端如何与数据库交互，以及数据库模型的结构。

以下是一个 schema.prisma 文件的示例：

// schema.prisma
datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

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

这个配置文件定义了一个数据源 db，指定了使用 PostgreSQL 数据库，并从环境变量 DATABASE_URL 获取数据库连接字符串。同时，它定义了一个生成器 client，用于生成 Prisma 客户端。最后，它定义了一个 User 模型，包含 id、email、name 和 posts 字段。