@directus/api/dist/database/migrations/20251028A-add-retention-indexes.js

Directus is a real-time API and App dashboard for managing SQL database content

import { FieldsService } from '../../services/fields.js';
import { getSchema } from '../../utils/get-schema.js';
import { transaction } from '../../utils/transaction.js';
import { getHelpers } from '../helpers/index.js';
import { getDatabaseClient } from '../index.js';
const RETENTION_INDEXES = [
    { collection: 'directus_activity', field: 'timestamp', ignore: [] },
    // MySQL is ignored because it already has an index on revisions.parent
    { collection: 'directus_revisions', field: 'parent', ignore: ['mysql'] },
];
export async function up(knex) {
    const client = getDatabaseClient(knex);
    const helpers = getHelpers(knex);
    const schema = await getSchema();
    const service = new FieldsService({ knex, schema });
    for (const { collection, field, ignore } of RETENTION_INDEXES) {
        if (ignore.includes(client))
            continue;
        const existingColumn = await service.columnInfo(collection, field);
        if (!existingColumn.is_indexed) {
            await helpers.schema.createIndex(collection, field, { attemptConcurrentIndex: true });
        }
    }
}
export async function down(knex) {
    const client = getDatabaseClient(knex);
    const helpers = getHelpers(knex);
    const schema = await getSchema();
    const service = new FieldsService({ knex, schema });
    for (const { collection, field, ignore } of RETENTION_INDEXES) {
        if (ignore.includes(client))
            continue;
        const existingColumn = await service.columnInfo(collection, field);
        if (existingColumn.is_indexed) {
            await transaction(knex, async (trx) => {
                await trx.schema.alterTable(collection, async (table) => {
                    table.dropIndex([field], helpers.schema.generateIndexName('index', collection, field));
                });
            });
        }
    }
}