Prisma Client Python安装与使用指南

2024-09-22 16:29:24作者：裘晴惠Vivianne

1. 项目目录结构及介绍

Prisma Client Python 是一个专为Python设计的自动生成且完全类型安全的数据库客户端，它与Prisma框架紧密集成，支持轻松高效的数据库操作。以下是一个典型的项目结构，基于 prisma-client-py 初始化后的样子：

my_project/
├── schema.prisma          # Prisma数据模型定义文件
├── main.py                 # 示例应用入口文件
├── requirements.txt        # 项目依赖列表
├── prisma/                 # 自动生成的Prisma Client代码存放路径（在生成后）
│   └── ...
├── .env                    # 可选，包含数据库连接等环境变量
├── pyproject.toml         # 项目配置文件，定义依赖及编译选项
└── README.md               # 项目说明文档

schema.prisma：核心文件，用于定义数据模型。
main.py：示例或应用程序的启动文件，演示如何使用Prisma Client。
requirements.txt：列出所有Python依赖项，确保环境一致性。
prisma/：运行prisma generate后，生成的客户端代码将放在此处。
.env: 存储私密配置如数据库URL，非强制但推荐。
pyproject.toml: 现代Python项目常见的配置文件，定义了项目元数据和依赖。

2. 项目的启动文件介绍

启动文件通常命名为main.py，展示如何初始化并使用Prisma Client Python进行数据库操作。基础示例如下：

from prisma import Prisma

async def main():
    # 初始化Prisma Client
    prisma = Prisma()
    await prisma.connect()

    # 数据库操作示例：创建用户
    user = await prisma.user.create(
        data={
            'name': '示例用户',
            'email': 'example@example.com',
        }
    )
    print(user)

    # 完成操作后断开连接
    await prisma.disconnect()

if __name__ == '__main__':
    import asyncio
    asyncio.run(main())

此文件展示了如何建立与数据库的连接，执行简单的数据创建操作，并最终安全地关闭连接。

3. 项目的配置文件介绍

schema.prisma - 数据模型配置

尽管.env和pyproject.toml也是配置的一部分，但在Prisma Client Python中，最重要的配置文件是schema.prisma。这个文件定义了你的数据模型，数据库连接信息，以及可选的生成器设置。

示例内容:

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

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

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
}