New Package: drizzle-seed
Drizzle ORM に待望の drizzle-seed パッケージがリリースされました(2024-11-22)。
ドキュメントはこちら
これまでは migration ファイルを作成して INSERT 文を書いていました。
特徴
決定論的データ生成(Deterministic Data Generation)
決定論的データ生成とは、同じ seed 値を使って生成したデータは毎回同じになるということです。
マイクラのワールド生成の仕組みと同じですね。
擬似乱数生成(Pseudorandom Number Generator (pRNG))
数値シーケンスの生成が使用されますが、前述の seed 値によってランダム性が制御されるため、再現が可能です。
ドキュメントでは以下の 3 つのメリットが示されています。
pRNG を使用する利点:
- 一貫性: テストが毎回同じデータで実行されるようにします。
- デバッグ: 一貫したデータ セットを提供することで、バグの再現と修正が容易になります。
- コラボレーション: チーム メンバーはシード番号を共有して同じデータ セットで作業できます。
https://orm.drizzle.team/docs/seed-overview#benefits-of-using-a-prng
(Google 翻訳使用)
使ってみた
example プロジェクトはこちらです。今回は DB に PostgreSQL を使用しています。
drizzle のスキーマ作成や DB への反映(drizzle-kit push)は済んでいる前提でインストールから！
npm i drizzle-seed
使い方
基本的には DB インスタンスとスキーマを seed 関数に渡すだけ。
デフォルトでは 10 件のデータが生成されます。
import { seed } from 'drizzle-seed';
import * as schema from './schema';
import dotenv from 'dotenv';
import { drizzle } from 'drizzle-orm/node-postgres';
dotenv.config();
async function main() {
const db = drizzle(process.env.DATABASE_URL!);
await seed(db, schema);
}
main();
// tsxで実行
> npx tsx db/seeds.ts
オプション
seed 関数には 2 つのオプションが指定できます。
count
生成するデータ件数を指定するオプションです。
await seed(db, schema, { count: 1000 });
seed
seed 値を指定することで毎回同じデータを生成する＝再現が可能です。
await seed(db, schema, { seed: 12345 });
リセット
DB のリセットは reset 関数を使用します。
seed 関数と同じように DB インスタンスとスキーマを渡すだけ！
import * as schema from './schema';
import { reset } from 'drizzle-seed';
import dotenv from 'dotenv';
import { drizzle } from 'drizzle-orm/node-postgres';
dotenv.config();
async function main() {
const db = drizzle(process.env.DATABASE_URL!);
await reset(db, schema);
}
main();
// tsxで実行
> npx tsx db/reset.ts
改良(Refinements)
refine関数を使用して seed の挙動を改良することも可能です。
スキーマで定義したテーブルの変数名をキーとしたオブジェクトに対して、drizzle-seed が提供するジェネレーター関数を使用して改良します。
明示的に改良しなくても、スキーマで定義したカラムの型や名前から推論してくれるのか適切なジェネレーター関数を使用してくれたりします。
withは親テーブルに関連するエンティティを生成します。親テーブルごとに生成する数も指定できます。
await seed(db, schema).refine((f) => ({
users: {
columns: {
id: f.int({
minValue: 1,
isUnique: true,
}),
name: f.fullName(),
// emailは設定しなくてもf.email()を使ってメールアドレスを生成してくれる
},
count: 10,
with: {
posts: 10,
},
},
}));
ジェネレーター関数
intやboolean, stringといったプリミティブ型？はもちろん、以下のようなよく使いそうなデータのジェネレーター関数が揃っています！
- タイムスタンプ
datetimetimestampdatetimeyear
- 名前
firstNamelastNamefullName
- 住所
countrystatepostCodecitystreetAddress
- 連絡先
emailphoneNumber
- 文章
-
loremIpsum- 生成する文章数を指定できる
-
- 2D データ
pointline
加重ランダム(Weighted Random)
weighted random API を使用することで生成されるデータを確率的に制御することができます。
例えば example プロジェクトでは、ユーザーの年齢層の割合を weight で設定しています。
現時点では制限されていること
- テーブル間の参照を適切に推論できない
- with オプションではスキーマに定義された全てのテーブルが表示され、手動で選択する必要がある
- ※ with オプションは 1:n の場合のみ機能する
- table 関数の 3 番目のパラメータ(
extraConfig?)に対する型は未サポート- 実行時には機能するが、型レベルでは機能しない
Cloudflare D1 でも使用できるのか(確認中)
ローカル D1 のインスタンスをどうやって渡せばいいのかわからず、色々やってみてはいるもののまだ動かせていませんでしたが、
自分と同じように D1 で seed が使用できないという Post を発見し、Drizzle ORM の公式アカウントからbettersqlite3を使えばできるよ！というリプライがついていました。
あとで試してみてできたら追記します！
最後に
ここまで読んでいただいてありがとうございました！
Discussion