🤮

フロントエンジニア向け!「DDL?トランザクション？なにそれ美味しいの？」を不味くする

2024/01/21に公開

PostgreSQL

はじめに

今年から転職し、新しい環境で開発をしています。
早速振られたタスクが「 DDL をトランザクションにする」というものでした。
どちらとも初めて聞くワードだったので DDL とトランザクションについて調べてみました。
最近は JS 製の ORM も多く、フロントエンドも DB 周りを開発する機会が増えてきたので自分と同じような方の参考になれば幸いです。

DDL とは

DDL（Data Definition Language）とは、データ定義言語と呼ばれる SQL の命令のことです。
DDL はデータベースのテーブルやビューを作成するCREATE 文や、テーブル、ビュー、インデックスなどの構造を変更するALTER 文、テーブルを削除するDROP 文、テーブル内のデータを全削除する TRUNCATE 文などがあります。
ちなみに SELECT、INSERT、UPDATE、DELETE などのデータ操作を行う SQL 文はデータ定義言語と言い、DML（Data Manipulation Language）と呼ばれます。

トランザクションとは

データベースにおける一連の処理を 1 つのまとまりとして扱う仕組みです。
トランザクション内の処理は、全て成功するか全て失敗するかのいずれかであり、途中で中断されることはありません。これにより、データの整合性を保つことができます。
JavaScript でいうところのバラバラになっている処理を 1 つの関数にまとめ、処理をtry-catchで処理するのに似ています。

DDL をトランザクションにするとは

まずトランザクションされていない DDL を実行してみます。

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100)
);

CREATE TABLE products (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100),
    stock INTEGER
    user_id INTEGER REFERENCES users(id)
);

この処理はusersテーブルを作成し、その後にproductsテーブルを作成しています。
もし、usersテーブルの作成に成功し、productsテーブルの作成に失敗した場合、usersテーブルは作成されたままになります。
場合によってはデータベースの状態が不整合になってしまうケースがあります。
そう言ったことを防ぐために、トランザクションを使用します。

-- トランザクションを開始する
BEGIN;

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100)
);

CREATE TABLE products (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100),
    stock INTEGER
    user_id INTEGER REFERENCES users(id)
);

-- ここでエラーが発生した場合の処理
ROLLBACK
-- 成功した場合の処理
COMMIT;

新たにBEGIN、ROLLBACK、COMMITという文が追加されています。

BEGIN：トランザクションを開始する
この宣言以降の SQL 文はトランザクションに含まれる
ROLLBACK：トランザクションを中断する
トランザクションを中断し、トランザクション開始前の状態に戻す
COMMIT：トランザクション内のデータベース操作を確定する
トランザクション内のデータベース操作を確定し、データベースへ反映する

ROLLBACKが実行されるとCOMMITが実行されるまでの処理は全て無効になります。
今回の場合、ROLLBACKが実行されるとusersテーブルもproductsテーブルも作成されません。
エラーが発生しなかった婆はROLLBACKが実行されず、COMMITが実行され、usersテーブルとproductsテーブルが作成されます。
また、SAVEPOINT チェックポイント名で途中の処理を保存することができ、ROLLBACK TO チェックポイント名でそこまでロールバックします。

-- トランザクションを開始する
BEGIN;

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100)
);

-- ここでチェックポイントを作成する
SAVEPOINT my_savepoint;

CREATE TABLE products (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100),
    stock INTEGER
    user_id INTEGER REFERENCES users(id)
);

-- my_savepointまでロールバックする
ROLLBACK TO my_savepoint;
-- 成功した場合の処理
COMMIT;

上記の場合はロールバックが発生するとusersテーブルは作成されますが、productsテーブルは作成されません。

注意点

PostgreSQL は DDL をロールバックすることができますが、他のデータベースではできない場合があります。
参考の記事を貼っておきます。

Prisma で DDL をトランザクションにする

トランザクションを使用しない場合

Prisma は TypeScript 製の ORM です。
Prisma にも transaction API が提供されているのでトランザクションを使用することができます。
今回は下記の seed ファイルを使用して DB にデータを保存するようにします。

prisma/seed.ts

import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

async function main() {
  try {
    const newUser = await prisma.user.create({
      data: {
        id: 1,
        name: 'John Smith'
      }
    })
    await prisma.product.create({
      data: {
        id: 1,
        name: 'Sample Product',
        stock: 10,
        userId: newUser.id
      }
    })
  } catch (e) {
    console.log(e)
  }
}

main()
  .catch((e) => {
    throw e
  })
  .finally(async () => {
    await prisma.$disconnect()
  })

動作確認のためまずはこのまま実行してみます。

$ pnpm ts-node --esm prisma/seed.ts

Prisma は DB の中を確認する GUI ツールが提供されているのでそちらで確認してみます。

$ pnpm prisma studio

userテーブルの画像

productテーブルの画像

それぞれテーブルが作れていることが確認できました！
では次は userのidを変更し、productのidを前回のままにします。
それぞれのid はユニークな値であるため、重複するとエラーが発生します。
今回はproductのidを重複させてエラーを発生させてみます。

prisma/seed.ts

/// ...

async function main() {
  try {
    const newUser = await prisma.user.create({
      data: {
        id: 2, // idを変更
        name: 'John Smith'
      }
    })
    // ここでエラーを発生させる
    await prisma.product.create({
      data: {
        id: 1, // 前回のまま
        name: 'Sample Product',
        stock: 10,
        userId: newUser.id
      }
    })
  } catch (e) {
    console.log(e)
  }
}
/// ...

idの完了したら再度 seed ファイルを実行し、DB を確認してみます。
下記のエラーが出ればproductのidが重複しているエラーなので一旦無視で大丈夫です。

PrismaClientKnownRequestError:
Invalid prisma.product.create() invocation:
Unique constraint failed on the fields: (id)

userテーブルの画像

productテーブルの画像

新たなuserは作成されていますが、productは作成されていません。
productはuserIdが設定されているのでproductをuserIdで検索した時に見つからないケースが発生します。
これが不整合の例です。
そう言ったことを防ぐために、トランザクションを使用します。

トランザクションを使用する場合

await prisma.$transaction([])を使用してトランザクションを使用します。
$transactionの引数にはPromiseを返す関数を渡します。

prisma/seed.ts

/// ...

async function main() {
  try {
    const [user, product] = await prisma.$transaction([
      prisma.user.create({
        data: {
          id: 1,
          name: 'John Smith'
        }
      }),
      prisma.product.create({
        data: {
          id: 1,
          name: 'Sample Product',
          stock: 10,
          userId: 1
        }
      })
    ])
    console.log(user)
    console.log(product)
  } catch (e) {
    console.log(e)
  }
}

/// ...

先ほどまではそれぞれ変数に代入していましたが、$transactionを使用すると配列で返ってくるので、分割代入を使用しています。
1 度データべースを削除してから seed ファイルを実行してみます。

userテーブルの画像

productテーブルの画像

無事にデータが作成されていることが確認できました！
では次に先ほど同様にuserのidを変更し、productのidをそのままにします。
seed ファイルを再度実行して先ほどと同様の重複エラーが発生することを確認します。
同じエラーであれば問題ないので DB を確認してみます。

userテーブルの画像

productテーブルの画像

productは作成されていないのも勿論ですが、userも作成されていません。
product作成時に重複エラーが発生したためロールバックが発生し、userも seed ファイル実行前に戻っています。
これがトランザクションです。

トランザクションのデメリット

トランザクションにはデメリットもあります。
自分なりに調べましたが、DB の理解が浅いため、他にも考えられるデメリットがあるかもしれません。

パフォーマンスの低下
複数のトランザクションを実行すると並列処理されることがあるので、パフォーマンスが低下する可能性がある
ロック競合
複数のトランザクションが同時に同じリソースにアクセスしようとするときに発生する
これにより、トランザクションの実行が遅延する可能性がある
デッドロック
複数のトランザクションがお互いに必要とするリソースをロックし合い、その結果、どのトランザクションも進行できなくなる状態
トランザクション同士がお互いに必要なリソースを解放することなく待ち続けることになる

まとめ

今回は DDL とトランザクションについて自分なりに調べた内容をまとめてみました。
タスクが振られた時は「オワター＼(^o^)／」と思っていましたが、調べてみると理解でき、タスクも無事に終わらせることができました。
サーバーサイドの開発ではこう言ったことも考えながら開発しているのだと感じ、とても勉強になりました。
新しい会社では「フルスタックになってね」と言われているので、フロントエンド、サーバサイド、インフラとしっかり勉強していきたいと思います。

トランザム!!