关于 data-seeding
介绍如何为项目数据库填充数据的技能,涵盖脚本模式与运行命令。内容包括可重复执行的种子、按环境区分的数据、选择性运行及事务插入。
主要功能
- 01运行全部或指定种子脚本
- 02使用 Faker.js 生成逼真数据
- 03按环境区分种子数据
- 04通过 upsert 或检查避免重复
- 05批量插入与事务处理
适用场景
- 01填充开发数据库
- 02准备测试专用数据集
- 03安全地重复运行种子脚本
- 04以事务方式插入关联记录
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ motormetrics/ motormetrics --skill data-seeding安装后在 Claude Code 中输入/data-seeding确认已加载。
详细介绍
数据填充技能
种子脚本位于 packages/database/src/seed/。
运行种子脚本
pnpm -F @sgcarstrends/database db:seed # Run all seeds
pnpm -F @sgcarstrends/database db:seed:cars # Seed specific table
基本种子模式
// packages/database/src/seed/cars.ts
import { db } from "../index";
import { cars } from "../db/schema";
import { nanoid } from "nanoid";
export async function seedCars() {
console.log("Seeding cars...");
const carData = [
{ id: nanoid(), make: "Toyota", model: "Camry", vehicleClass: "Sedan", fuelType: "Petrol", month: "2024-01", number: 150 },
{ id: nanoid(), make: "Honda", model: "Civic", vehicleClass: "Sedan", fuelType: "Petrol", month: "2024-01", number: 120 },
];
await db.insert(cars).values(carData);
console.log(`Seeded ${carData.length} cars`);
}
主种子运行器
// packages/database/src/seed/index.ts
export async function seed() {
console.log("Starting database seed...");
await clearDatabase(); // Optional: clear existing data
await seedCars();
await seedCOE();
await seedPosts();
console.log("Database seeded successfully!");
}
async function clearDatabase() {
// Delete in reverse order of dependencies
await db.delete(posts);
await db.delete(coe);
await db.delete(cars);
}
使用 Faker.js 填充数据
pnpm -F @sgcarstrends/database add -D @faker-js/faker
import { faker } from "@faker-js/faker";
export async function seedRealisticCars(count = 100) {
const makes = ["Toyota", "Honda", "BMW", "Mercedes"];
const carData = Array.from({ length: count }, () => ({
id: nanoid(),
make: faker.helpers.arrayElement(makes),
model: faker.vehicle.model(),
month: faker.date.between({ from: "2020-01-01", to: "2024-12-31" }).toISOString().slice(0, 7),
number: faker.number.int({ min: 10, max: 500 }),
}));
// Batch insert for performance
const batchSize = 50;
for (let i = 0; i < carData.length; i += batchSize) {
await db.insert(cars).values(carData.slice(i, i + batchSize));
}
}
环境专属种子
export async function seed() {
const env = process.env.NODE_ENV || "development";
switch (env) {
case "development":
await seedDevelopment(); // Small, predictable dataset
break;
case "test":
await seedTesting(); // Minimal, deterministic data
break;
case "staging":
await seedStaging(); // Larger, production-like dataset
break;
}
}
幂等种子(Upsert)
await db.insert(cars).values(carData).onConflictDoUpdate({
target: cars.id,
set: { make: carData[0].make, number: carData[0].number, updatedAt: new Date() },
});
插入前检查
export async function seedIfEmpty() {
const existing = await db.select().from(cars).limit(1);
if (existing.length > 0) {
console.log("Database has data, skipping seed");
return;
}
await seedCars();
}
事务
await db.transaction(async (tx) => {
await tx.insert(cars).values([...carData]);
await tx.insert(coe).values([...coeData]);
});
用于选择性填充数据的 CLI
// packages/database/scripts/seed-cli.ts
const seeders = { cars: seedCars, coe: seedCOE, posts: seedPosts, all: seedAll };
const target = process.argv[2] as keyof typeof seeders;
if (!target || !seeders[target]) {
console.error("Usage: pnpm db:seed [cars|coe|posts|all]");
process.exit(1);
}
seeders[target]().then(() => process.exit(0)).catch(() => process.exit(1));
最佳实践
- 幂等:可安全地多次运行(使用 upsert 或插入前检查)
- 环境专属:为 dev/test/staging 环境提供不同的数据
- 批量插入:大型数据集使用批处理
- 关系:先填充父表
- 事务:用于原子化的数据填充
- 日志记录:提供清晰的进度反馈
参考
packages/database/AGENTS.md,了解架构详情- 迁移请参阅
schema-design技能
评论
支持 Markdown