Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linbudu599/prisma-examples
Prisma: 下一代ORM, 不仅仅是ORM Demo 仓库
https://github.com/linbudu599/prisma-examples
Last synced: 10 days ago
JSON representation
Prisma: 下一代ORM, 不仅仅是ORM Demo 仓库
- Host: GitHub
- URL: https://github.com/linbudu599/prisma-examples
- Owner: linbudu599
- License: mit
- Created: 2021-01-09T12:24:53.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-29T22:20:24.000Z (over 1 year ago)
- Last Synced: 2024-10-12T14:10:50.148Z (26 days ago)
- Language: TypeScript
- Homepage:
- Size: 7.37 MB
- Stars: 25
- Watchers: 2
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Prisma-Examples
 
## Left Targets
- Example with MongoDB
- Example with Prisma Data Platform
## Getting Started
If you got any troubles running commands below, add `DEBUG=*` as command prefix to see internal logs.
```bash
pnpm install
# Optional: Install Prisma CLI Globally
# @prisma/cli has been deprecated and prisma instead should be installed
pnpm install prisma -g
# run all examples in a single command!
pnpm start
# avaliable examples:
# single model
pnpm dev:single
# multi models & relations
pnpm dev:multi
# advanced multi models example
pnpm dev:advanced
# GraphQL example(TypeGraphQL + Apollo-Server)
pnpm dev:graphql
# with TypeORM
pnpm dev:with-typeorm
# generate Prisma Client for all examples
pnpm gen:client
# common prisma commands
# sync Prisma Schema with database(in this repo, will generate sqlite file)
prisma db push
# generate Prisma Client from prisma schema
prisma generate
# execute this command to invoke database migration after Prisma Schema got modified
prisma migrate
# generate Prisma Schema from exist database
prisma introspect
# run test cases（GraphQL example）
pnpm test:graphql
```
## Advanced Multi-Models Example
### Relation
- `User` -> `Post`: **1-n**
- `User` -> `Profile`: **1-1** (Optional in User, Required in Profile)
- `User` -> `Fragment`: **1-n** (Optional in User, Optional in Fragment)
- `Post` -> `Category`: **m-n**(connected by `CtegoriesOnPosts` model)
- Self-Relation: `User.invitor`(**1-1**) & `User.invitation`(**1-n**)
## With TypeGraphQL + Apollo-Server
- [Generated Schema](src/typegraphql-apollo-server/graphql/shema.graphql)
- [Generated TypeScript Code](src/typegraphql-apollo-server/generated/index.ts)
- [Prisma Model](src/typegraphql-apollo-server/prisma/schema.prisma)
- [Resolvers](src/typegraphql-apollo-server/resolvers/)
- Explore
- `pnpm dev`
- open GraphiQL in [http://localhost:5999/graphql](http://localhost:5999/graphql)
- [Example GraphQL Query / Mutation](src/typegraphql-apollo-server/graphql/)(arguments in operations are from database initial data seeding)
- [GenQL: Type Safe Graphql Query Builder](https://github.com/remorses/genql): `pnpm gen:genql` (**Require local server online**)，[Example](src/typegraphql-apollo-server/graphql/genql.ts)
- Test:
- database in GraphQL example will be reset before running test cases.
## With Other ORMs
### With TypeORM(SQLite + SQLite)
[Example](src/with-typeorm/index.ts)
## With NestJS
- Create `PrismaService` which extends `PrismaClient`:
```typescript
import {
Injectable,
OnModuleInit,
OnModuleDestroy,
OnApplicationBootstrap,
OnApplicationShutdown,
} from "@nestjs/common";
import { PrismaClient } from "@prisma/client";
@Injectable()
export class PrismaService
extends PrismaClient
implements
OnModuleInit,
OnApplicationBootstrap,
OnModuleDestroy,
OnApplicationShutdown
{
constructor() {
super();
}
async onModuleInit() {
await this.$connect();
}
async onApplicationBootstrap() {
// await seeds();
}
async onModuleDestroy() {}
async onApplicationShutdown() {
await this.$disconnect();
}
}
```
- Register `PrismaService` as a provider, and `PrismaModule` as a Global module:
```typescript
import { Global, Module } from "@nestjs/common";
import { PrismaService } from "./prisma.service";
@Global()
@Module({
providers: [PrismaService],
exports: [PrismaService],
})
export default class PrismaModule {}
```
- Import `PrismaModule` in `AppModule`:
```typescript
import PrismaModule from "./prisma/prisma.module";
@Module({
imports: [PrismaModule],
})
export class AppModule
implements NestModule, OnApplicationBootstrap, OnApplicationShutdown
{
constructor(private readonly connection: Connection) {}
async configure(
consumer: MiddlewareConsumer
): Promise {}
// you can connect/disconnect prisma client here
async onApplicationBootstrap() {}
async onApplicationShutdown() {}
}
```
- Use `PrismaService`:
```typescript
import { Injectable } from "@nestjs/common";
import { PrismaService } from "../../prisma/prisma.service";
@Injectable()
export class UserService {
constructor(private prisma: PrismaService) {}
async queryAllUsers() {
const res = await this.prisma.user.findMany({});
return res;
}
}
```
## Unit Test
- see [prisma-unit-test](./prisma-unit-test) folder.