#Migration

import { Migration } from '@nocobase/server';

export default class extends Migration {
  on = 'afterLoad';
  appVersion = '<1.0.0';

  async up() {
    // Logic nâng cấp
  }
}

on: 'beforeLoad' | 'afterSync' | 'afterLoad';

appVersion: string;

// Chỉ chạy khi nâng cấp từ phiên bản thấp hơn 1.0.0
appVersion = '<1.0.0';

// Chỉ chạy khi nâng cấp từ phiên bản thấp hơn 0.21.0-alpha.13
appVersion = '<0.21.0-alpha.13';

// Để trống thì chạy mỗi lần upgrade
appVersion = '';

get app(): Application

async up() {
  // Lấy phiên bản ứng dụng
  const version = this.app.version;

  // Lấy logger
  this.app.log.info('Migration started');
}

get db(): Database

async up() {
  const repo = this.db.getRepository('users');
  await repo.update({
    filter: { status: 'inactive' },
    values: { status: 'disabled' },
  });
}

get plugin(): Plugin

async up() {
  const pluginName = this.plugin.name;
}

get sequelize(): Sequelize

async up() {
  await this.sequelize.query(`UPDATE users SET status = 'active' WHERE status IS NULL`);
}

get queryInterface(): QueryInterface

async up() {
  const { DataTypes } = require('@nocobase/database');

  // Thêm cột
  await this.queryInterface.addColumn('users', 'nickname', {
    type: DataTypes.STRING,
  });

  // Thêm ràng buộc unique
  await this.queryInterface.addConstraint('users', {
    type: 'unique',
    fields: ['email'],
  });
}

get pm(): PluginManager

async up() {
  const plugins = await this.pm.repository.find();
  for (const plugin of plugins) {
    // Sửa hàng loạt bản ghi Plugin
  }
}

async up(): Promise<void>

async down(): Promise<void>

import { Migration } from '@nocobase/server';

export default class extends Migration {
  appVersion = '<1.0.0';

  async up() {
    const repo = this.db.getRepository('roles');
    await repo.update({
      filter: {
        $or: [{ allowConfigure: true }, { name: 'root' }],
      },
      values: {
        snippets: ['ui.*', 'pm', 'pm.*'],
        allowConfigure: false,
      },
    });
  }

  async down() {}
}

import { DataTypes } from '@nocobase/database';
import { Migration } from '@nocobase/server';

export default class extends Migration {
  on = 'beforeLoad';
  appVersion = '<0.14.0-alpha.2';

  async up() {
    const tableName = this.pm.collection.getTableNameWithSchema();
    const field = this.pm.collection.getField('packageName');

    // Kiểm tra trước xem field đã tồn tại chưa
    const exists = await field.existsInDb();
    if (exists) return;

    await this.queryInterface.addColumn(tableName, field.columnName(), {
      type: DataTypes.STRING,
    });

    await this.queryInterface.addConstraint(tableName, {
      type: 'unique',
      fields: [field.columnName()],
    });
  }
}

import { Migration } from '@nocobase/server';

export default class extends Migration {
  on = 'afterSync';
  appVersion = '<1.0.0-alpha.3';

  async up() {
    const items = await this.pm.repository.find();
    for (const item of items) {
      if (item.name.startsWith('@nocobase/plugin-')) {
        item.set('name', item.name.substring('@nocobase/plugin-'.length));
        await item.save();
      }
    }
  }
}

import { Migration } from '@nocobase/server';

export default class extends Migration {
  on = 'afterLoad';
  appVersion = '<phiên bản hiện tại>';

  async up() {
    // coding
  }
}