strapi/packages/core/database/lib/schema/index.js

'use strict';

const createSchemaBuilder = require('./builder');
const createSchemaStorage = require('./schema-storage');
const { diffSchemas } = require('./schema-diff');
const { metadataToSchema, createTable } = require('./schema');

const addInternalTables = schema => {
  schema.addTable(
    createTable({
      tableName: 'strapi_database_schema',
      attributes: {
        id: {
          type: 'increments',
        },
        schema: {
          type: 'json',
        },
        createdAt: {
          type: 'datetime',
        },
      },
    })
  );
};

const createSchemaProvider = db => {
  const currentSchema = metadataToSchema(db.metadata);

  // Add Internal tables to schema
  addInternalTables(currentSchema);

  return {
    builder: createSchemaBuilder(db),
    schemaStorage: createSchemaStorage(db),

    /**
     * Drops the database schema
     */
    async drop() {
      const DBSchema = await this.schemaStorage.read();

      if (!DBSchema) {
        return;
      }

      await this.builder.dropSchema(DBSchema);
    },

    /**
     * Creates the database schema
     */
    async create() {
      await this.builder.createSchema(currentSchema);
      await this.schemaStorage.create(currentSchema);
    },

    /**
     * Resets the database schema
     */
    async reset() {
      await this.drop();
      await this.create();
    },

    // TODO: support options to migrate softly or forcefully
    // TODO: support option to disable auto migration & run a CLI command instead to avoid doing it at startup
    async sync() {
      // load previous schema
      const DBSchema = await this.schemaStorage.read();

      if (!DBSchema) {
        return this.create();
      }

      // run migrations

      // reload updated schema

      // diff schema
      const { status, diff } = diffSchemas(DBSchema, currentSchema);

      // TODO: replace by schemaDiff.hasChanged()
      if (status === 'UNCHANGED') {
        // NOTE: should we still update the schema in DB ?
        return;
      }

      // update schema
      await this.builder.updateSchema(diff);

      // persist new schema
      await this.schemaStorage.update(currentSchema);
    },
  };
};

module.exports = createSchemaProvider;