Leapcell: The Best of Serverless Web Hosting

Prisma Tutorial: A Practical Exercise Based on Koa and Postgresql

序文

Prismaは、次世代のORM（Object Relational Mapping）ツールと見なされており、TypeScriptをベースに開発されており、強力な型安全性を提供しています。この記事では、Koa.jsを使用してシンプルなWebサービスを構築し、MySQLデータベースと組み合わせて、Prismaを通じてデータの作成、読み取り、更新、削除（CRUD）操作を実装する方法を示します。

Prismaの概要

Prismaは、次世代のORMツールと称されています。Prismaはオープンソースのデータベースツールチェーンプロジェクトであり、その機能は単なるORMだけにとどまりません。PostgreSQL、MySQL、MongoDB、SQL Server、SQLiteなど、複数のデータベースをサポートしています。この記事では、MySQLを例にして説明します。

Prismaを初めて使用する際、その手順は比較的煩雑で、大きく以下のステップに分けられます：

依存関係をインストールする
Prismaプロジェクトを初期化する
Prisma Schemaを設計する（データベース情報とモデルを定義する）
データベースと同期する
Prisma Clientを生成する
Prisma Clientを使用してCRUD操作を完了する

次に、まず開発環境をセットアップし、その後Prismaを詳しく紹介します。

環境の初期化

Koa Webサービスの構築

まず、プロジェクトディレクトリを作成し、依存関係をインストールします：

mkdir koa-prisma
cd koa-prisma
pnpm init

# Koaの依存関係をインストール
pnpm add koa @koa/router koa-bodyparser

このうち、@koa/routerはルーティングミドルウェアで、ルーティング機能を統合するのに便利です；koa-bodyparserは、リクエストボディデータを解析し、ctx.request.bodyオブジェクトに格納するために使用されます。

次に、新しいindex.jsファイルを作成し、シンプルなWebサービスを構築します：

const Koa = require('koa')
const Router = require('@koa/router')
const bodyParser = require('koa-bodyparser')

const app = new Koa()

// ルータをインスタンス化し、共通のルートプレフィックスを/usersに設定
const router = new Router({
  prefix: '/users'
})

app.use(bodyParser())

// ユーザーリストを照会する
router.get('/', async ctx => {

})

// 単一のユーザーを照会する
router.get('/:id', async ctx => {

})

// ユーザーを作成する
router.post('/', async ctx => {

})

// ユーザーを更新する
router.patch('/:id', async ctx => {

})

// ユーザーを削除する
router.delete('/:id', async ctx => {

})

// ルーティングミドルウェアを登録する
app.use(router.routes()).use(router.allowedMethods())

app.listen(3000, () => {
  console.log('サーバーがポート3000で稼働しています')
})

上記のコードでは、5つのルーティングメソッドを定義しており、照会、挿入、更新、削除のデータベース操作に対応しています。Prismaの初期化を完了し、後でPrisma Clientを導入したら、これらのインターフェイスを実装できます。

nodemonコマンドを使用してサービスを起動します。このモジュールをグローバルにインストールすることをおすすめします：

nodemon src/index.js

Prisma CLI

Prismaの依存関係をインストールする

まず、Prismaの2つの依存モジュールをインストールします：

pnpm add -D prisma 
pnpm add @prisma/client

このうち、prismaはPrismaの様々な機能を呼び出すためのCLIコマンドで、データベースマイグレーション、Prisma Clientの作成などに使用されます。以下のコマンドを実行して、prismaの使用方法を表示します：

npx prisma --help

prismaは7つのコマンドを提供しています：

コマンド	説明
init	アプリケーションでPrismaを初期化する
generate	主にPrisma Clientを生成するために使用する
db	データベースのスキーマとライフサイクルを管理する
migrate	データベースをマイグレートする
studio	ウェブベースのワークベンチを起動してデータを管理する
validate	Prismaスキーマファイルの構文が正しいかチェックする
format	Prismaスキーマファイルをフォーマットする（デフォルトでは`prisma/schema.prisma`）

この記事では、これらのコマンドのうち3つを主に使用します。残りのコマンドは、自分で探索してみてください。

Prismaを初期化する

以下のコマンドを実行して、初期化を完了します：

npx prisma init

このコマンドは、現在のディレクトリに.envファイルとprismaディレクトリを作成し、prismaディレクトリにschema.prismaファイルを作成します。

.envファイルは環境変数を格納するために使用され、通常いくつかの設定情報が含まれます。prismaディレクトリは、Prismaに関連するファイルを格納するために使用されます。現在はschema.prismaファイルのみがあります。このファイルはPrismaのスキーマファイルで、データベース接続情報とモデルを定義するために使用されます。

Prisma Schemaを設計する

VSCプラグインをインストールする

スキーマファイルを編集する前に、VS CodeにPrismaプラグインをインストールすることをおすすめします。このプラグインは、コードの強調表示、フォーマット、オートコンプリート、定義へのジャンプ、.prismaファイルのチェックなどの機能を提供し、開発体験を大幅に向上させます。

ジェネレータを設定する

generateを使用してジェネレータを定義し、providerプロパティを通じてprisma-client-jsと宣言します（現在はこれのみがサポートされています）。prisma generateコマンドを実行すると、Prisma Clientが生成され、これはデータのCRUD操作を完了するために使用されます：

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

データソースを設定する

datasourceを使用してデータソースを定義し、Prismaがデータベースに接続するために必要な情報を設定します。providerは接続するデータベースの種類を指定し、デフォルトではpostgresqlです。これをmysqlに変更します。urlはデータベースのURLを指定します。設定を分離するために、通常.envファイルに定義し、env()関数を通じて読み取ります：

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

デフォルトの.envファイルのデータベース接続はPostgresql用です：

DATABASE_URL=postgresql://johndoe:mypassword@localhost:5432/mydb?schema=public

MySQLデータベースの接続URLは、以下の必須項目で構成されます：

名前	プレースホルダ	説明
ホスト	HOST	データベースのIPまたはドメイン名、例えばlocalhost
ポート	PORT	データベースのポート、例えば3306
ユーザー	USER	データベースのユーザー名、例えばroot
パスワード	PASSWORD	データベースのパスワード
データベース	DATABASE	データベース名、例えばmydb

上記のルールに従って、MySQLのURLを定義します：

DATABASE_URL="postgresql://leapcell:leapcell123@localhost:9006/prisma"

ユーザーモデルを定義する

ORMツールとして、Prismaのモデルは以下の機能を持っています：

アプリケーションドメインのエンティティを形成する
データベースのテーブル（PostgreSQLなどの関係型データベース）またはコレクション（MongoDB）にマッピングする
Prisma Client APIの照会の基盤を形成する
TypeScriptでは、Prisma Clientはモデルとそのバリアントの型定義を提供し、データベースアクセスの型安全性を保証する

モデルを定義する際、@id()や@default()などのPrismaの組み込みユーティリティ関数を使用します。例えば、@id()は主キーを宣言するために使用され、@default()はデフォルト値を設定するために使用されます。以下はUserモデルの定義です：

model User {
  id          Int         @id @default(autoincrement())
  name        String
  email       String      @unique
  password    String
  createdTime DateTime    @default(now()) @map("created_time")
  updatedTime DateTime    @updatedAt @map("updated_time")

  @@map("user")
}

以下の点に注意する必要があります：

モデル名はデフォルトで作成されるデータテーブルの名前です。ここではモデル名はUserで、テーブル名は@@map("user")を通じて小文字のuserに設定できます。
各モデルには主キーが必須であり、@idを使用して宣言します。
Prismaはフィールドの型（例えばInt、String）をデータベースの対応する型（例えばintとvarchar）に変換します。
@uniqueは一意の値制約を示し、userテーブルのemailフィールドの値は重複できません。
JS、TS、およびデータベースの命名規則に合わせるため、@map()を使用して作成時刻と更新時刻の命名をマッピングします。

データベースを同期する

新しいプロジェクトの場合、以下のコマンドを使用してPrismaモデルをデータベースに同期できます：

npx prisma db push

プロジェクトに既にデータがある場合は、prisma migrateを使用してマイグレーションする必要がありますが、これはこの記事では扱いません。

prisma db pushコマンドは、データベースのスキーマを作成し、Prismaスキーマを使用してデータベースを同期し、自動的にprisma generateコマンドを実行してPrisma Clientを生成します。

Prisma Clientを生成する

データベースを同期する際にprisma generateコマンドは既に実行されています。その後、Prisma Schemaファイルが変更された場合、例えばモデルを修正した場合は、このコマンドを再度実行してPrisma Clientを再生成する必要があります。

CRUD操作

Prisma Clientを初期化する

Prisma Clientがあれば、CRUD操作を実行できます。初期化コードは以下の通りです：

const { PrismaClient } = require('@prisma/client')

const prisma = new PrismaClient()

Prisma Clientのインスタンスprismaは豊富な型を持っており、その使い方はprisma.model.CRUDメソッドです。一般に使用されるAPIには以下のものがあります：

findMany：複数のレコードを照会する
findUnique：単一のレコードを照会する
create：レコードを作成する
update：レコードを更新する
delete：レコードを削除する

APIを使用してインターフェイス開発を完了する

ユーザーリストを照会する

findManyにパラメータを渡さない場合、それはuserテーブル全体のすべてのレコードを照会し、Userモデルインスタンスの配列を返します：

router.get('/', async ctx => {
  const users = await prisma.user.findMany()

  ctx.body = users
})

単一のユーザーを照会する

findUniqueメソッドのwhereを通じて照会条件を設定し、指定されたIDに基づいてユーザーレコードを照会し、Userモデルインスタンスを返します：

// 単一のユーザーを照会する
router.get('/:id', async ctx => {
  const id = parseInt(ctx.params.id)
  const user = await prisma.user.findUnique({
    where: { id }
  })

  ctx.body = user
})

ctx.params.idから取得されるIDは文字列型であることに注意してください。照会する前に整数型に変換する必要があります。

ユーザーを作成する

createメソッドを使用してデータを挿入し、リクエストボディから解析されたデータ（Userモデルを記述するオブジェクト）をdataプロパティに割り当てます：

router.post('/', async ctx => {
  const user = ctx.request.body
  const newUser = await prisma.user.create({
    data: user
  })

  ctx.body = newUser
})

ユーザーを更新する

updateメソッドを使用し、whereを通じて照会条件を設定し、対象のユーザーを照会した後、更新するデータをdataに割り当てます：

router.patch('/:id', async ctx => {
  const id = parseInt(ctx.params.id)
  const updateUser = ctx.request.body

  const user = await prisma.user.update({
    where: {
      id
    },
    data: updateUser
  })

  ctx.body = user
})

ユーザーを削除する

deleteメソッドを使用し、whereを通じて削除するレコードの照会条件を設定します：

router.delete('/:id', async ctx => {
  const id = parseInt(ctx.params.id)
  const user = await prisma.user.delete({
    where: {
      id
    }
  })

  ctx.body = user
})

updateとdeleteメソッドを使用する際、必ずwhere条件を設定してください。そうしないと、データテーブルのすべてのレコードが更新または削除されてしまい、危険です。

結論

この記事では、ユーザーの作成、読み取り、更新、削除の例を通じて、KoaプロジェクトにおけるPrismaの基本的な使い方を示しました。全体のプロセスは以下の通りにまとめることができます：

依存関係をインストールする
Prismaを初期化する
Prisma Schemaをセットアップする
データベースを同期する
Prisma Clientを作成する
Prisma Clientを使用してCRUDを実装する

Leapcell: The Best of Serverless Web Hosting

最後に、nodejsサービスをデプロイするのに最適なプラットフォームをおすすめします：Leapcell

🚀 好きな言語で構築する

JavaScript、Python、Go、またはRustで簡単に開発できます。

🌍 無料で無制限のプロジェクトをデプロイする

使用した分だけ支払います — リクエストがなければ、請求もありません。

⚡ 使った分だけ支払い、隠された費用はありません

アイドル料金はなく、シームレスなスケーラビリティが備わっています。

📖 ドキュメントを探索する

🔹 Twitterでフォローしてください： @LeapcellHQ