Function alterTable

packages/sql/src/schema/SchemaHelper.ts:483–643

Returns SQL statements to apply a table difference (add/drop/alter columns, indexes, foreign keys).

(diff: TableDifference, safe?: boolean)

  /** Returns SQL statements to apply a table difference (add/drop/alter columns, indexes, foreign keys). */
  alterTable(diff: TableDifference, safe?: boolean): string[] {
    const ret: string[] = [];
    const [schemaName, tableName] = this.splitTableName(diff.name);

    if (this.platform.supportsNativeEnums()) {
      const changedNativeEnums: [enumName: string, itemsNew: string[], itemsOld: string[]][] = [];

      for (const { column, changedProperties } of Object.values(diff.changedColumns)) {
        if (!column.nativeEnumName) {
          continue;
        }

        const key =
          schemaName && schemaName !== this.platform.getDefaultSchemaName() && !column.nativeEnumName.includes('.')
            ? schemaName + '.' + column.nativeEnumName
            : column.nativeEnumName;

        if (changedProperties.has('enumItems') && key in diff.fromTable.nativeEnums) {
          changedNativeEnums.push([column.nativeEnumName, column.enumItems!, diff.fromTable.nativeEnums[key].items]);
        }
      }

      Utils.removeDuplicates(changedNativeEnums).forEach(([enumName, itemsNew, itemsOld]) => {
        // postgres allows only adding new items
        const newItems = itemsNew.filter(val => !itemsOld.includes(val));

        if (enumName.includes('.')) {
          const [enumSchemaName, rawEnumName] = enumName.split('.');
          ret.push(
            ...newItems.map(val => this.getAlterNativeEnumSQL(rawEnumName, enumSchemaName, val, itemsNew, itemsOld)),
          );
          return;
        }

        ret.push(...newItems.map(val => this.getAlterNativeEnumSQL(enumName, schemaName, val, itemsNew, itemsOld)));
      });
    }

    for (const index of Object.values(diff.removedIndexes)) {
      ret.push(this.dropIndex(diff.name, index));
    }

    for (const index of Object.values(diff.changedIndexes)) {
      ret.push(this.dropIndex(diff.name, index));
    }

    for (const check of Object.values(diff.removedChecks)) {
      ret.push(this.dropConstraint(diff.name, check.name));
    }

    for (const check of Object.values(diff.changedChecks)) {
      ret.push(this.dropConstraint(diff.name, check.name));
    }

    if (!safe) {
      for (const trigger of Object.values(diff.removedTriggers)) {
        ret.push(this.dropTrigger(diff.toTable, trigger));
      }