RailsでマイグレーションされたDBスキーマをPrismaのschemaに取り込む

bisque 2021/10/15に更新

RailsでマイグレーションされたDBを、Node.jsからPrismaを使ってアクセスできるようにPrismaのschemaを整えます。

既存のDBはPostgreSQLです。

bisque 2021/10/15に更新

まずは `prisma db pull` する

既存のDBを取り込む手順がドキュメントにありますので、それに従いschemaを作成します。

prismaのcliを追加

yarn add -D prisma

prismaの初期化

npx prisma init

.env にDBの接続設定を設定。
prisma db pull を実行して既存のスキーマをschema.prismaにインポートする

npx prisma db pull

./prisma/schema.prisma に既存のDBのスキーマが書き込まれました。

このあと npx prisma generate で型定義も生成できます。

bisque 2021/10/15

ネーミングルールを合わせる

modelのルール
- 正規表現: [A-Za-z][A-Za-z0-9_]*
- PascalCase推奨
- 単数形
- 予約語は使えない（これとこれ）
modelのfieldのルール
- 正規表現: [A-Za-z][A-Za-z0-9_]*
- 必ず小文字から始まる
- camelCase推奨

Node.js（TypeScript）のコードに snake_case が紛れ込むと、のちのち混乱のもとになりますので、schemaファイルで名前を合わせておきます。

modelの名前のmapping

以下は prisma db pull を実行した直後の状態です。

model books {
  id                          BigInt    @id @default(autoincrement())
}

books を Book にするのが推奨される名前です。

model Book {
  @@map("books")
  id                          BigInt    @id @default(autoincrement())
}

modelのfieldの名前のmapping

fieldの名前も同様にマッピングします。

  created_at                  DateTime  @db.Timestamp(6)
  updated_at                  DateTime  @db.Timestamp(6)

  createdAt                  DateTime  @db.Timestamp(6)  @map("created_at")
  updatedAt                  DateTime  @db.Timestamp(6)  @map("updated_at")

bisque 2021/10/18に更新

bigintをJSON.strinfigyできない

Railsのデフォルトのidフィールドはbigint型として定義されますが、このままstringifyしようとすると Do not know how to serialize a BigInt となります。

ワークアラウンドとして JSON.stringify をカスタマイズする方法が載っています。

また、 fast-json-stringify を使うのもいいかもしれません。こちらはtoStringしてからintegerに変換するようです。（未確認）

fastify ではシリアライザにfast-json-stringifyが使われているので、レスポンスのschema定義をすれば数値として出力されました。

  fastify.route({
    method: "GET",
    url: "/",
    handler: async (req, res) => {
      const book = await fastify.prisma.book.findFirst();
      if (!book) {
        return res.code(404);
      }
      return book;
    },
    schema: {
      response: {
        200: {
          id: { type: "number" },
        },
      },
    },
  });

=> {"id":9}

bisque 2021/10/18に更新

Railsがデフォルトをbigintにしているのは、後からintをbigintに変えることが大変だからなんだけど、intを超える可能性が限りなくゼロに近いのであれば、prismaの型定義はInt型と定義するでも良いかもしれません。

model Book {
  @@map("books")
  id                          Int    @id @default(autoincrement()) // 本当はBigInt
}

bisque 2021/10/18に更新

リレーションシップ

ActiveRecordで設定していた belongs_to や has_many などのアソシエーションは、prismaではスキーマ定義で設定します。

belongs_to :user の場合

model Book {
  userId                      Int       @map("user_id")
  user                        User      @relation(fields: [userId], references: [id])

has_many :books の場合

model User {
  books                    Book[]

これで、以下のように型やメソッドが追加されます。

      const book = await fastify.prisma.book.findFirst({
        include: { user: true },
      });
      book!.user;

      const user = await fastify.prisma.user.findFirst({
        include: { books: true },
      });

      user!.books;