Npm Prisma

Directory Structure

.
|-- package.json
|-- prisma
|   |-- dev.db
|   |-- migrations
|   |   |-- *_init
|   |   |   `-- migration.sql
|   |   `-- migration_lock.toml
|   `-- schema.prisma
|-- src
|   `-- index.ts
`-- tsconfig.json

Environment Build

npm

npm install prisma --save-dev

npm

npm install @prisma/client

.env

DATABASE_URL="file:./dev.db"

schema.prisma作成

npm

npx prisma init --datasource-provider sqlite

Migrate

npm

npx prisma migrate dev --name init

src/index.ts

import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

const deleteUsers = async () => {
  await prisma.user.deleteMany()
}

deleteUsers()

const createUsers = async () => {
  await prisma.user.createMany({
    data: [
      {
        id: 1,
        name: 'prisma',
        email: 'prisma@email.com',
      },
      {
        id: 2,
        name: 'drizzle',
        email: 'drizzle@email.com',
      },
      {
        id: 3,
        name: 'typeorm',
        email: 'typeorm@email.com',
      },
    ],
  })
}

const main = async () => {
  await createUsers()
  const users = await prisma.user.findMany()
  console.log(users)
}

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

Execution

[
  { id: 1, email: 'prisma@email.com', name: 'prisma' },
  { id: 2, email: 'drizzle@email.com', name: 'drizzle' },
  { id: 3, email: 'typeorm@email.com', name: 'typeorm' }
]

Mermaid

• prisma-erd-generator

npm

npm install prisma-erd-generator --save-dev

prisma/schema.prisma

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

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

generator erd {
  provider = "prisma-erd-generator"
  output = "er.md"
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String
}

mermaid

erDiagram

  "User" {
    Int id "🗝️"
    String email 
    String name 
    }

Generate

npm

npx prisma generate

Other Example

schema.prisma

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

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

generator erd {
  provider = "prisma-erd-generator"
  output = "er.md"
}

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
  authorId  Int
  author    User   @relation(fields: [authorId], references: [id])
}

mermaid

erDiagram

  "User" {
    Int id "🗝️"
    String email 
    String name 
    }
  

  "Post" {
    Int id "🗝️"
    String title 
    String content 
    }
  
    "User" o{--}o "Post" : "posts"
    "Post" o|--|| "User" : "author"

PlantUML

• prisma-generator-plantuml-erd

npm

npm install prisma-generator-plantuml-erd --save-dev

prisma/schema.prisma

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

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

generator erd_plantuml {
  provider   = "prisma-generator-plantuml-erd"
  output = "erd.puml"
  showUniqueKeyLabel = true
  isShowForeignKeyOnRelation = true
}

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
  authorId  Int
  author    User   @relation(fields: [authorId], references: [id])
}

txt

@startuml erd
skinparam linetype ortho
entity "User" as User {
+ id [PK] : Int 
--
  * email : [UK] String
  * name : String
}

entity "Post" as Post {
+ id [PK] : Int 
--
  * title : String
  * content : String
  # authorId : [FK] User
}

' Relations
Post }o--|| User: authorId
' ManyToMany Relations
' enum relations
@enduml

Generate

npm

npm install prisma-erd-generator --save-dev

Md

prisma/schema.prisma

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

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

generator erd_plantuml {
  provider   = "prisma-generator-plantuml-erd"
  exportPerTables      = true
  showUniqueKeyLabel = true
  isShowForeignKeyOnRelation = true
  markdownOutput       = "./example-tables.md"
  markdownIncludeERD      = true
}

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
  authorId  Int
  author    User   @relation(fields: [authorId], references: [id])
}

Generate

npm

npm install prisma-erd-generator --save-dev

Generated Md

Tables

• User
• Post

ER diagram

@startuml erd
skinparam linetype ortho
entity "User" as User {
+ id [PK] : Int 
--
  * email : [UK] String
  * name : String
}

entity "Post" as Post {
+ id [PK] : Int 
--
  * title : String
  * content : String
  # authorId : [FK] User
}

' Relations
Post }o--|| User: authorId
' ManyToMany Relations
' enum relations
@enduml

User

Description

Columns

Name	Type	Default	Nullable	Unique	Children	Parent	Comment
id	Int	autoincrement	false	true	Post
email	String		false	true
name	String		false	false

ER diagram

@startuml User
skinparam linetype ortho
entity "User" as User {
+ id [PK] : Int 
--
  * email : [UK] String
  * name : String
}

entity "Post" as Post {
+ id [PK] : Int 
--
  * title : String
  * content : String
  # authorId : [FK] User
}

' Relations
Post }o--|| User: authorId
' ManyToMany Relations
' enum relations
@enduml

Post

Description

Columns

Name	Type	Default	Nullable	Unique	Children	Parent	Comment
id	Int	autoincrement	false	true
title	String		false	false
content	String		false	false
authorId	Int		false	false		User

ER diagram

@startuml Post
skinparam linetype ortho
entity "User" as User {
+ id [PK] : Int 
--
  * email : [UK] String
  * name : String
}

entity "Post" as Post {
+ id [PK] : Int 
--
  * title : String
  * content : String
  # authorId : [FK] User
}

' Relations
Post }o--|| User: authorId
' ManyToMany Relations
' enum relations
@enduml

Options

exportPerTables

 各テーブルが出力される。デフォルト値はfalse。

showUniqueKeyLabel

 ER図上で一意のキーとしてもラベル付けされる[UK]。デフォルト値はfalse。

lineType

• ortho
• polyline
• unset

デフォルト値はortho。

isLeftToRightDirection

 trueにすると、PlantUMLがleft to right direction指定される。

lineLength

 線の長さを変更できる。デフォルト値は--。

Prisma Markdown

• Prisma Markdown

npm

npm install prisma-markdown --save-dev

prisma/schema.prisma

generator markdown {
  provider = "prisma-markdown"
  output   = "./ERD.md"
  title    = "Prisma Markdown"
}

Generate

npm

npx prisma generate

Generated Md

Prisma Markdown

Generated by prisma-markdown

• default

default

User

Properties

• id:
• email:
• name:

Post

Properties

• id:
• title:
• content:
• authorId: