BuildingAI 升级开发文档

migration -> Upgrade -> data/versions/<version>

packages/@buildingai/db/src/migrations/

packages/@buildingai/db/dist/migrations/

{timestamp}-{version}-{description}.js

1776000000000-26.1.0-add-report-table.ts

packages/@buildingai/upgrade/src/scripts/<version>/index.ts

packages/@buildingai/upgrade/src/scripts/26.1.0/index.ts

packages/@buildingai/upgrade/src/scripts/26.1.0.ts

scripts/<version>/index.js

import { BaseUpgradeScript, UpgradeContext } from "../../index";

export class Upgrade extends BaseUpgradeScript {
    readonly version = "26.1.0";

    async execute(context: UpgradeContext): Promise<void> {
        this.log("Start upgrading data for 26.1.0");

        const { dataSource } = context;

        await dataSource.query(`
            UPDATE report
            SET summary = ''
            WHERE summary IS NULL
        `);

        this.success("Upgrade finished");
    }
}

export default Upgrade;

await context.dataSource.query(
    `
    UPDATE "config"
    SET value = $1
    WHERE key = $2
    `,
    [JSON.stringify({ enabled: true }), "site_settings"],
);

const repo = context.dataSource.getRepository("User");

const users = await repo.find({
    where: { status: "active" },
});

for (const user of users) {
    user.nickname = user.nickname || user.username;
}

await repo.save(users);

const manager = context.dataSource.manager;

const items = await manager.find("Config", {
    where: { group: "system" },
});

const queryRunner = context.dataSource.createQueryRunner();
await queryRunner.connect();
await queryRunner.startTransaction();

try {
    await queryRunner.query(`
        UPDATE "report"
        SET "status" = 'ready'
        WHERE "status" IS NULL
    `);

    await queryRunner.query(`
        INSERT INTO "audit_log" ("action")
        VALUES ('upgrade-26.1.0')
    `);

    await queryRunner.commitTransaction();
} catch (error) {
    await queryRunner.rollbackTransaction();
    throw error;
} finally {
    await queryRunner.release();
}

migration -> Upgrade