typeorm
Version:
Data-Mapper ORM for TypeScript and ES2021+. Supports MySQL/MariaDB, PostgreSQL, MS SQL Server, Oracle, SAP HANA, SQLite, MongoDB databases.
965 lines (964 loc) • 106 kB
JavaScript
import { TypeORMError } from "../../error";
import { QueryFailedError } from "../../error/QueryFailedError";
import { QueryRunnerAlreadyReleasedError } from "../../error/QueryRunnerAlreadyReleasedError";
import { TransactionNotStartedError } from "../../error/TransactionNotStartedError";
import { BaseQueryRunner } from "../../query-runner/BaseQueryRunner";
import { QueryResult } from "../../query-runner/QueryResult";
import { Table } from "../../schema-builder/table/Table";
import { TableColumn } from "../../schema-builder/table/TableColumn";
import { TableForeignKey } from "../../schema-builder/table/TableForeignKey";
import { TableIndex } from "../../schema-builder/table/TableIndex";
import { TableUnique } from "../../schema-builder/table/TableUnique";
import { View } from "../../schema-builder/view/View";
import { Broadcaster } from "../../subscriber/Broadcaster";
import { BroadcasterResult } from "../../subscriber/BroadcasterResult";
import { InstanceChecker } from "../../util/InstanceChecker";
import { OrmUtils } from "../../util/OrmUtils";
import { VersionUtils } from "../../util/VersionUtils";
import { Query } from "../Query";
import { MetadataTableType } from "../types/MetadataTableType";
/**
* Runs queries on a single mysql database connection.
*/
export class MysqlQueryRunner extends BaseQueryRunner {
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
constructor(driver, mode) {
super();
this.driver = driver;
this.connection = driver.connection;
this.broadcaster = new Broadcaster(this);
this.mode = mode;
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Creates/uses database connection from the connection pool to perform further operations.
* Returns obtained database connection.
*/
connect() {
if (this.databaseConnection)
return Promise.resolve(this.databaseConnection);
if (this.databaseConnectionPromise)
return this.databaseConnectionPromise;
if (this.mode === "slave" && this.driver.isReplicated) {
this.databaseConnectionPromise = this.driver
.obtainSlaveConnection()
.then((connection) => {
this.databaseConnection = connection;
return this.databaseConnection;
});
}
else {
// master
this.databaseConnectionPromise = this.driver
.obtainMasterConnection()
.then((connection) => {
this.databaseConnection = connection;
return this.databaseConnection;
});
}
return this.databaseConnectionPromise;
}
/**
* Releases used database connection.
* You cannot use query runner methods once its released.
*/
release() {
this.isReleased = true;
if (this.databaseConnection)
this.databaseConnection.release();
return Promise.resolve();
}
/**
* Starts transaction on the current connection.
*/
async startTransaction(isolationLevel) {
this.isTransactionActive = true;
try {
await this.broadcaster.broadcast("BeforeTransactionStart");
}
catch (err) {
this.isTransactionActive = false;
throw err;
}
if (this.transactionDepth === 0) {
if (isolationLevel) {
await this.query("SET TRANSACTION ISOLATION LEVEL " + isolationLevel);
}
await this.query("START TRANSACTION");
}
else {
await this.query(`SAVEPOINT typeorm_${this.transactionDepth}`);
}
this.transactionDepth += 1;
await this.broadcaster.broadcast("AfterTransactionStart");
}
/**
* Commits transaction.
* Error will be thrown if transaction was not started.
*/
async commitTransaction() {
if (!this.isTransactionActive)
throw new TransactionNotStartedError();
await this.broadcaster.broadcast("BeforeTransactionCommit");
if (this.transactionDepth > 1) {
await this.query(`RELEASE SAVEPOINT typeorm_${this.transactionDepth - 1}`);
}
else {
await this.query("COMMIT");
this.isTransactionActive = false;
}
this.transactionDepth -= 1;
await this.broadcaster.broadcast("AfterTransactionCommit");
}
/**
* Rollbacks transaction.
* Error will be thrown if transaction was not started.
*/
async rollbackTransaction() {
if (!this.isTransactionActive)
throw new TransactionNotStartedError();
await this.broadcaster.broadcast("BeforeTransactionRollback");
if (this.transactionDepth > 1) {
await this.query(`ROLLBACK TO SAVEPOINT typeorm_${this.transactionDepth - 1}`);
}
else {
await this.query("ROLLBACK");
this.isTransactionActive = false;
}
this.transactionDepth -= 1;
await this.broadcaster.broadcast("AfterTransactionRollback");
}
/**
* Executes a raw SQL query.
*/
async query(query, parameters, useStructuredResult = false) {
if (this.isReleased)
throw new QueryRunnerAlreadyReleasedError();
const databaseConnection = await this.connect();
this.driver.connection.logger.logQuery(query, parameters, this);
await this.broadcaster.broadcast("BeforeQuery", query, parameters);
const broadcasterResult = new BroadcasterResult();
const queryStartTime = Date.now();
return new Promise(async (ok, fail) => {
try {
const enableQueryTimeout = this.driver.options.enableQueryTimeout;
const maxQueryExecutionTime = this.driver.options.maxQueryExecutionTime;
const queryPayload = enableQueryTimeout && maxQueryExecutionTime
? { sql: query, timeout: maxQueryExecutionTime }
: query;
databaseConnection.query(queryPayload, parameters, async (err, raw) => {
// log slow queries if maxQueryExecution time is set
const maxQueryExecutionTime = this.driver.options.maxQueryExecutionTime;
const queryEndTime = Date.now();
const queryExecutionTime = queryEndTime - queryStartTime;
if (maxQueryExecutionTime &&
queryExecutionTime > maxQueryExecutionTime)
this.driver.connection.logger.logQuerySlow(queryExecutionTime, query, parameters, this);
if (err) {
this.driver.connection.logger.logQueryError(err, query, parameters, this);
this.broadcaster.broadcastAfterQueryEvent(broadcasterResult, query, parameters, false, undefined, undefined, err);
return fail(new QueryFailedError(query, parameters, err));
}
this.broadcaster.broadcastAfterQueryEvent(broadcasterResult, query, parameters, true, queryExecutionTime, raw, undefined);
const result = new QueryResult();
result.raw = raw;
try {
result.records = Array.from(raw);
}
catch {
// Do nothing.
}
if (raw?.hasOwnProperty("affectedRows")) {
result.affected = raw.affectedRows;
}
if (useStructuredResult) {
ok(result);
}
else {
ok(result.raw);
}
});
}
catch (err) {
fail(err);
}
finally {
await broadcasterResult.wait();
}
});
}
/**
* Returns raw data stream.
*/
stream(query, parameters, onEnd, onError) {
if (this.isReleased)
throw new QueryRunnerAlreadyReleasedError();
return new Promise(async (ok, fail) => {
try {
const databaseConnection = await this.connect();
this.driver.connection.logger.logQuery(query, parameters, this);
const databaseQuery = databaseConnection.query(query, parameters);
if (onEnd)
databaseQuery.on("end", onEnd);
if (onError)
databaseQuery.on("error", onError);
ok(databaseQuery.stream());
}
catch (err) {
fail(err);
}
});
}
/**
* Returns all available database names including system databases.
*/
async getDatabases() {
return Promise.resolve([]);
}
/**
* Returns all available schema names including system schemas.
* If database parameter specified, returns schemas of that database.
*/
async getSchemas(database) {
throw new TypeORMError(`MySql driver does not support table schemas`);
}
/**
* Checks if database with the given name exist.
*/
async hasDatabase(database) {
const result = await this.query(`SELECT * FROM \`INFORMATION_SCHEMA\`.\`SCHEMATA\` WHERE \`SCHEMA_NAME\` = '${database}'`);
return result.length ? true : false;
}
/**
* Loads currently using database
*/
async getCurrentDatabase() {
const query = await this.query(`SELECT DATABASE() AS \`db_name\``);
return query[0]["db_name"];
}
/**
* Checks if schema with the given name exist.
*/
async hasSchema(schema) {
throw new TypeORMError(`MySql driver does not support table schemas`);
}
/**
* Loads currently using database schema
*/
async getCurrentSchema() {
const query = await this.query(`SELECT SCHEMA() AS \`schema_name\``);
return query[0]["schema_name"];
}
/**
* Checks if table with the given name exist in the database.
*/
async hasTable(tableOrName) {
const parsedTableName = this.driver.parseTableName(tableOrName);
const sql = `SELECT * FROM \`INFORMATION_SCHEMA\`.\`COLUMNS\` WHERE \`TABLE_SCHEMA\` = '${parsedTableName.database}' AND \`TABLE_NAME\` = '${parsedTableName.tableName}'`;
const result = await this.query(sql);
return result.length ? true : false;
}
/**
* Checks if column with the given name exist in the given table.
*/
async hasColumn(tableOrName, column) {
const parsedTableName = this.driver.parseTableName(tableOrName);
const columnName = InstanceChecker.isTableColumn(column)
? column.name
: column;
const sql = `SELECT * FROM \`INFORMATION_SCHEMA\`.\`COLUMNS\` WHERE \`TABLE_SCHEMA\` = '${parsedTableName.database}' AND \`TABLE_NAME\` = '${parsedTableName.tableName}' AND \`COLUMN_NAME\` = '${columnName}'`;
const result = await this.query(sql);
return result.length ? true : false;
}
/**
* Creates a new database.
*/
async createDatabase(database, ifNotExist) {
const up = ifNotExist
? `CREATE DATABASE IF NOT EXISTS \`${database}\``
: `CREATE DATABASE \`${database}\``;
const down = `DROP DATABASE \`${database}\``;
await this.executeQueries(new Query(up), new Query(down));
}
/**
* Drops database.
*/
async dropDatabase(database, ifExist) {
const up = ifExist
? `DROP DATABASE IF EXISTS \`${database}\``
: `DROP DATABASE \`${database}\``;
const down = `CREATE DATABASE \`${database}\``;
await this.executeQueries(new Query(up), new Query(down));
}
/**
* Creates a new table schema.
*/
async createSchema(schemaPath, ifNotExist) {
throw new TypeORMError(`Schema create queries are not supported by MySql driver.`);
}
/**
* Drops table schema.
*/
async dropSchema(schemaPath, ifExist) {
throw new TypeORMError(`Schema drop queries are not supported by MySql driver.`);
}
/**
* Creates a new table.
*/
async createTable(table, ifNotExist = false, createForeignKeys = true) {
if (ifNotExist) {
const isTableExist = await this.hasTable(table);
if (isTableExist)
return Promise.resolve();
}
const upQueries = [];
const downQueries = [];
upQueries.push(this.createTableSql(table, createForeignKeys));
downQueries.push(this.dropTableSql(table));
// we must first drop indices, than drop foreign keys, because drop queries runs in reversed order
// and foreign keys will be dropped first as indices. This order is very important, because we can't drop index
// if it related to the foreign key.
// createTable does not need separate method to create indices, because it create indices in the same query with table creation.
table.indices.forEach((index) => downQueries.push(this.dropIndexSql(table, index)));
// if createForeignKeys is true, we must drop created foreign keys in down query.
// createTable does not need separate method to create foreign keys, because it create fk's in the same query with table creation.
if (createForeignKeys)
table.foreignKeys.forEach((foreignKey) => downQueries.push(this.dropForeignKeySql(table, foreignKey)));
// if table has column with generated type, we must add the expression to the metadata table
const generatedColumns = table.columns.filter((column) => column.generatedType && column.asExpression);
for (const column of generatedColumns) {
const currentDatabase = await this.getCurrentDatabase();
const insertQuery = this.insertTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: column.name,
value: column.asExpression,
});
const deleteQuery = this.deleteTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: column.name,
});
upQueries.push(insertQuery);
downQueries.push(deleteQuery);
}
return this.executeQueries(upQueries, downQueries);
}
/**
* Drop the table.
*/
async dropTable(target, ifExist, dropForeignKeys = true) {
// It needs because if table does not exist and dropForeignKeys or dropIndices is true, we don't need
// to perform drop queries for foreign keys and indices.
if (ifExist) {
const isTableExist = await this.hasTable(target);
if (!isTableExist)
return Promise.resolve();
}
// if dropTable called with dropForeignKeys = true, we must create foreign keys in down query.
const createForeignKeys = dropForeignKeys;
const tablePath = this.getTablePath(target);
const table = await this.getCachedTable(tablePath);
const upQueries = [];
const downQueries = [];
if (dropForeignKeys)
table.foreignKeys.forEach((foreignKey) => upQueries.push(this.dropForeignKeySql(table, foreignKey)));
table.indices.forEach((index) => upQueries.push(this.dropIndexSql(table, index)));
upQueries.push(this.dropTableSql(table));
downQueries.push(this.createTableSql(table, createForeignKeys));
// if table had columns with generated type, we must remove the expression from the metadata table
const generatedColumns = table.columns.filter((column) => column.generatedType && column.asExpression);
for (const column of generatedColumns) {
const currentDatabase = await this.getCurrentDatabase();
const deleteQuery = this.deleteTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: column.name,
});
const insertQuery = this.insertTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: column.name,
value: column.asExpression,
});
upQueries.push(deleteQuery);
downQueries.push(insertQuery);
}
await this.executeQueries(upQueries, downQueries);
}
/**
* Creates a new view.
*/
async createView(view, syncWithMetadata = false) {
const upQueries = [];
const downQueries = [];
upQueries.push(this.createViewSql(view));
if (syncWithMetadata)
upQueries.push(await this.insertViewDefinitionSql(view));
downQueries.push(this.dropViewSql(view));
if (syncWithMetadata)
downQueries.push(await this.deleteViewDefinitionSql(view));
await this.executeQueries(upQueries, downQueries);
}
/**
* Drops the view.
*/
async dropView(target) {
const viewName = InstanceChecker.isView(target) ? target.name : target;
const view = await this.getCachedView(viewName);
const upQueries = [];
const downQueries = [];
upQueries.push(await this.deleteViewDefinitionSql(view));
upQueries.push(this.dropViewSql(view));
downQueries.push(await this.insertViewDefinitionSql(view));
downQueries.push(this.createViewSql(view));
await this.executeQueries(upQueries, downQueries);
}
/**
* Renames a table.
*/
async renameTable(oldTableOrName, newTableName) {
const upQueries = [];
const downQueries = [];
const oldTable = InstanceChecker.isTable(oldTableOrName)
? oldTableOrName
: await this.getCachedTable(oldTableOrName);
const newTable = oldTable.clone();
const { database } = this.driver.parseTableName(oldTable);
newTable.name = database ? `${database}.${newTableName}` : newTableName;
// rename table
upQueries.push(new Query(`RENAME TABLE ${this.escapePath(oldTable)} TO ${this.escapePath(newTable)}`));
downQueries.push(new Query(`RENAME TABLE ${this.escapePath(newTable)} TO ${this.escapePath(oldTable)}`));
// rename index constraints
newTable.indices.forEach((index) => {
const oldIndexName = this.connection.namingStrategy.indexName(oldTable, index.columnNames);
// Skip renaming if Index has user defined constraint name
if (index.name !== oldIndexName)
return;
// build new constraint name
const columnNames = index.columnNames
.map((column) => `\`${column}\``)
.join(", ");
const newIndexName = this.connection.namingStrategy.indexName(newTable, index.columnNames, index.where);
// build queries
let indexType = "";
if (index.isUnique)
indexType += "UNIQUE ";
if (index.isSpatial)
indexType += "SPATIAL ";
if (index.isFulltext)
indexType += "FULLTEXT ";
const indexParser = index.isFulltext && index.parser
? ` WITH PARSER ${index.parser}`
: "";
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(newTable)} DROP INDEX \`${index.name}\`, ADD ${indexType}INDEX \`${newIndexName}\` (${columnNames})${indexParser}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(newTable)} DROP INDEX \`${newIndexName}\`, ADD ${indexType}INDEX \`${index.name}\` (${columnNames})${indexParser}`));
// replace constraint name
index.name = newIndexName;
});
// rename foreign key constraint
newTable.foreignKeys.forEach((foreignKey) => {
const oldForeignKeyName = this.connection.namingStrategy.foreignKeyName(oldTable, foreignKey.columnNames, this.getTablePath(foreignKey), foreignKey.referencedColumnNames);
// Skip renaming if foreign key has user defined constraint name
if (foreignKey.name !== oldForeignKeyName)
return;
// build new constraint name
const columnNames = foreignKey.columnNames
.map((column) => `\`${column}\``)
.join(", ");
const referencedColumnNames = foreignKey.referencedColumnNames
.map((column) => `\`${column}\``)
.join(",");
const newForeignKeyName = this.connection.namingStrategy.foreignKeyName(newTable, foreignKey.columnNames, this.getTablePath(foreignKey), foreignKey.referencedColumnNames);
// build queries
let up = `ALTER TABLE ${this.escapePath(newTable)} DROP FOREIGN KEY \`${foreignKey.name}\`, ADD CONSTRAINT \`${newForeignKeyName}\` FOREIGN KEY (${columnNames}) ` +
`REFERENCES ${this.escapePath(this.getTablePath(foreignKey))}(${referencedColumnNames})`;
if (foreignKey.onDelete)
up += ` ON DELETE ${foreignKey.onDelete}`;
if (foreignKey.onUpdate)
up += ` ON UPDATE ${foreignKey.onUpdate}`;
let down = `ALTER TABLE ${this.escapePath(newTable)} DROP FOREIGN KEY \`${newForeignKeyName}\`, ADD CONSTRAINT \`${foreignKey.name}\` FOREIGN KEY (${columnNames}) ` +
`REFERENCES ${this.escapePath(this.getTablePath(foreignKey))}(${referencedColumnNames})`;
if (foreignKey.onDelete)
down += ` ON DELETE ${foreignKey.onDelete}`;
if (foreignKey.onUpdate)
down += ` ON UPDATE ${foreignKey.onUpdate}`;
upQueries.push(new Query(up));
downQueries.push(new Query(down));
// replace constraint name
foreignKey.name = newForeignKeyName;
});
await this.executeQueries(upQueries, downQueries);
// rename old table and replace it in cached tabled;
oldTable.name = newTable.name;
this.replaceCachedTable(oldTable, newTable);
}
/**
* Change table comment.
*/
async changeTableComment(tableOrName, newComment) {
const upQueries = [];
const downQueries = [];
const table = InstanceChecker.isTable(tableOrName)
? tableOrName
: await this.getCachedTable(tableOrName);
newComment = this.escapeComment(newComment);
const comment = this.escapeComment(table.comment);
if (newComment === comment) {
return;
}
const newTable = table.clone();
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(newTable)} COMMENT ${newComment}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} COMMENT ${comment}`));
await this.executeQueries(upQueries, downQueries);
// change table comment and replace it in cached tabled;
table.comment = newTable.comment;
this.replaceCachedTable(table, newTable);
}
/**
* Creates a new column from the column in the table.
*/
async addColumn(tableOrName, column) {
const table = InstanceChecker.isTable(tableOrName)
? tableOrName
: await this.getCachedTable(tableOrName);
const clonedTable = table.clone();
const upQueries = [];
const downQueries = [];
const skipColumnLevelPrimary = clonedTable.primaryColumns.length > 0;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD ${this.buildCreateColumnSql(column, skipColumnLevelPrimary, false)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP COLUMN \`${column.name}\``));
// create or update primary key constraint
if (column.isPrimary && skipColumnLevelPrimary) {
// if we already have generated column, we must temporary drop AUTO_INCREMENT property.
const generatedColumn = clonedTable.columns.find((column) => column.isGenerated &&
column.generationStrategy === "increment");
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${column.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(column, true)}`));
}
const primaryColumns = clonedTable.primaryColumns;
let columnNames = primaryColumns
.map((column) => `\`${column.name}\``)
.join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
primaryColumns.push(column);
columnNames = primaryColumns
.map((column) => `\`${column.name}\``)
.join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
// if we previously dropped AUTO_INCREMENT property, we must bring it back
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(column, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${column.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
}
}
if (column.generatedType && column.asExpression) {
const currentDatabase = await this.getCurrentDatabase();
const insertQuery = this.insertTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: column.name,
value: column.asExpression,
});
const deleteQuery = this.deleteTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: column.name,
});
upQueries.push(insertQuery);
downQueries.push(deleteQuery);
}
// create column index
const columnIndex = clonedTable.indices.find((index) => index.columnNames.length === 1 &&
index.columnNames[0] === column.name);
if (columnIndex) {
upQueries.push(this.createIndexSql(table, columnIndex));
downQueries.push(this.dropIndexSql(table, columnIndex));
}
else if (column.isUnique) {
const uniqueIndex = new TableIndex({
name: this.connection.namingStrategy.indexName(table, [
column.name,
]),
columnNames: [column.name],
isUnique: true,
});
clonedTable.indices.push(uniqueIndex);
clonedTable.uniques.push(new TableUnique({
name: uniqueIndex.name,
columnNames: uniqueIndex.columnNames,
}));
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD UNIQUE INDEX \`${uniqueIndex.name}\` (\`${column.name}\`)`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${uniqueIndex.name}\``));
}
await this.executeQueries(upQueries, downQueries);
clonedTable.addColumn(column);
this.replaceCachedTable(table, clonedTable);
}
/**
* Creates a new columns from the column in the table.
*/
async addColumns(tableOrName, columns) {
for (const column of columns) {
await this.addColumn(tableOrName, column);
}
}
/**
* Renames column in the given table.
*/
async renameColumn(tableOrName, oldTableColumnOrName, newTableColumnOrName) {
const table = InstanceChecker.isTable(tableOrName)
? tableOrName
: await this.getCachedTable(tableOrName);
const oldColumn = InstanceChecker.isTableColumn(oldTableColumnOrName)
? oldTableColumnOrName
: table.columns.find((c) => c.name === oldTableColumnOrName);
if (!oldColumn)
throw new TypeORMError(`Column "${oldTableColumnOrName}" was not found in the "${table.name}" table.`);
let newColumn = undefined;
if (InstanceChecker.isTableColumn(newTableColumnOrName)) {
newColumn = newTableColumnOrName;
}
else {
newColumn = oldColumn.clone();
newColumn.name = newTableColumnOrName;
}
await this.changeColumn(table, oldColumn, newColumn);
}
/**
* Changes a column in the table.
*/
async changeColumn(tableOrName, oldColumnOrName, newColumn) {
const table = InstanceChecker.isTable(tableOrName)
? tableOrName
: await this.getCachedTable(tableOrName);
let clonedTable = table.clone();
const upQueries = [];
const downQueries = [];
const oldColumn = InstanceChecker.isTableColumn(oldColumnOrName)
? oldColumnOrName
: table.columns.find((column) => column.name === oldColumnOrName);
if (!oldColumn)
throw new TypeORMError(`Column "${oldColumnOrName}" was not found in the "${table.name}" table.`);
if ((newColumn.isGenerated !== oldColumn.isGenerated &&
newColumn.generationStrategy !== "uuid") ||
oldColumn.type !== newColumn.type ||
oldColumn.length !== newColumn.length ||
(oldColumn.generatedType &&
newColumn.generatedType &&
oldColumn.generatedType !== newColumn.generatedType) ||
(!oldColumn.generatedType &&
newColumn.generatedType === "VIRTUAL") ||
(oldColumn.generatedType === "VIRTUAL" && !newColumn.generatedType)) {
await this.dropColumn(table, oldColumn);
await this.addColumn(table, newColumn);
// update cloned table
clonedTable = table.clone();
}
else {
if (newColumn.name !== oldColumn.name) {
// We don't change any column properties, just rename it.
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${oldColumn.name}\` \`${newColumn.name}\` ${this.buildCreateColumnSql(oldColumn, true, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${newColumn.name}\` \`${oldColumn.name}\` ${this.buildCreateColumnSql(oldColumn, true, true)}`));
// rename index constraints
clonedTable.findColumnIndices(oldColumn).forEach((index) => {
const oldUniqueName = this.connection.namingStrategy.indexName(clonedTable, index.columnNames);
// Skip renaming if Index has user defined constraint name
if (index.name !== oldUniqueName)
return;
// build new constraint name
index.columnNames.splice(index.columnNames.indexOf(oldColumn.name), 1);
index.columnNames.push(newColumn.name);
const columnNames = index.columnNames
.map((column) => `\`${column}\``)
.join(", ");
const newIndexName = this.connection.namingStrategy.indexName(clonedTable, index.columnNames, index.where);
// build queries
let indexType = "";
if (index.isUnique)
indexType += "UNIQUE ";
if (index.isSpatial)
indexType += "SPATIAL ";
if (index.isFulltext)
indexType += "FULLTEXT ";
const indexParser = index.isFulltext && index.parser
? ` WITH PARSER ${index.parser}`
: "";
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${index.name}\`, ADD ${indexType}INDEX \`${newIndexName}\` (${columnNames})${indexParser}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${newIndexName}\`, ADD ${indexType}INDEX \`${index.name}\` (${columnNames})${indexParser}`));
// replace constraint name
index.name = newIndexName;
});
// rename foreign key constraints
clonedTable
.findColumnForeignKeys(oldColumn)
.forEach((foreignKey) => {
const foreignKeyName = this.connection.namingStrategy.foreignKeyName(clonedTable, foreignKey.columnNames, this.getTablePath(foreignKey), foreignKey.referencedColumnNames);
// Skip renaming if foreign key has user defined constraint name
if (foreignKey.name !== foreignKeyName)
return;
// build new constraint name
foreignKey.columnNames.splice(foreignKey.columnNames.indexOf(oldColumn.name), 1);
foreignKey.columnNames.push(newColumn.name);
const columnNames = foreignKey.columnNames
.map((column) => `\`${column}\``)
.join(", ");
const referencedColumnNames = foreignKey.referencedColumnNames
.map((column) => `\`${column}\``)
.join(",");
const newForeignKeyName = this.connection.namingStrategy.foreignKeyName(clonedTable, foreignKey.columnNames, this.getTablePath(foreignKey), foreignKey.referencedColumnNames);
// build queries
let up = `ALTER TABLE ${this.escapePath(table)} DROP FOREIGN KEY \`${foreignKey.name}\`, ADD CONSTRAINT \`${newForeignKeyName}\` FOREIGN KEY (${columnNames}) ` +
`REFERENCES ${this.escapePath(this.getTablePath(foreignKey))}(${referencedColumnNames})`;
if (foreignKey.onDelete)
up += ` ON DELETE ${foreignKey.onDelete}`;
if (foreignKey.onUpdate)
up += ` ON UPDATE ${foreignKey.onUpdate}`;
let down = `ALTER TABLE ${this.escapePath(table)} DROP FOREIGN KEY \`${newForeignKeyName}\`, ADD CONSTRAINT \`${foreignKey.name}\` FOREIGN KEY (${columnNames}) ` +
`REFERENCES ${this.escapePath(this.getTablePath(foreignKey))}(${referencedColumnNames})`;
if (foreignKey.onDelete)
down += ` ON DELETE ${foreignKey.onDelete}`;
if (foreignKey.onUpdate)
down += ` ON UPDATE ${foreignKey.onUpdate}`;
upQueries.push(new Query(up));
downQueries.push(new Query(down));
// replace constraint name
foreignKey.name = newForeignKeyName;
});
// rename old column in the Table object
const oldTableColumn = clonedTable.columns.find((column) => column.name === oldColumn.name);
clonedTable.columns[clonedTable.columns.indexOf(oldTableColumn)].name = newColumn.name;
oldColumn.name = newColumn.name;
}
if (this.isColumnChanged(oldColumn, newColumn, true, true)) {
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${oldColumn.name}\` ${this.buildCreateColumnSql(newColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${newColumn.name}\` ${this.buildCreateColumnSql(oldColumn, true)}`));
if (oldColumn.generatedType && !newColumn.generatedType) {
// if column changed from generated to non-generated, delete record from typeorm metadata
const currentDatabase = await this.getCurrentDatabase();
const deleteQuery = this.deleteTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: oldColumn.name,
});
const insertQuery = this.insertTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: oldColumn.name,
value: oldColumn.asExpression,
});
upQueries.push(deleteQuery);
downQueries.push(insertQuery);
}
else if (!oldColumn.generatedType &&
newColumn.generatedType) {
// if column changed from non-generated to generated, insert record into typeorm metadata
const currentDatabase = await this.getCurrentDatabase();
const insertQuery = this.insertTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: newColumn.name,
value: newColumn.asExpression,
});
const deleteQuery = this.deleteTypeormMetadataSql({
schema: currentDatabase,
table: table.name,
type: MetadataTableType.GENERATED_COLUMN,
name: newColumn.name,
});
upQueries.push(insertQuery);
downQueries.push(deleteQuery);
}
else if (oldColumn.asExpression !== newColumn.asExpression) {
// if only expression changed, just update it in typeorm_metadata table
const currentDatabase = await this.getCurrentDatabase();
const updateQuery = this.connection
.createQueryBuilder()
.update(this.getTypeormMetadataTableName())
.set({ value: newColumn.asExpression })
.where("`type` = :type", {
type: MetadataTableType.GENERATED_COLUMN,
})
.andWhere("`name` = :name", { name: oldColumn.name })
.andWhere("`schema` = :schema", {
schema: currentDatabase,
})
.andWhere("`table` = :table", { table: table.name })
.getQueryAndParameters();
const revertUpdateQuery = this.connection
.createQueryBuilder()
.update(this.getTypeormMetadataTableName())
.set({ value: oldColumn.asExpression })
.where("`type` = :type", {
type: MetadataTableType.GENERATED_COLUMN,
})
.andWhere("`name` = :name", { name: newColumn.name })
.andWhere("`schema` = :schema", {
schema: currentDatabase,
})
.andWhere("`table` = :table", { table: table.name })
.getQueryAndParameters();
upQueries.push(new Query(updateQuery[0], updateQuery[1]));
downQueries.push(new Query(revertUpdateQuery[0], revertUpdateQuery[1]));
}
}
if (newColumn.isPrimary !== oldColumn.isPrimary) {
// if table have generated column, we must drop AUTO_INCREMENT before changing primary constraints.
const generatedColumn = clonedTable.columns.find((column) => column.isGenerated &&
column.generationStrategy === "increment");
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${generatedColumn.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(generatedColumn, true)}`));
}
const primaryColumns = clonedTable.primaryColumns;
// if primary column state changed, we must always drop existed constraint.
if (primaryColumns.length > 0) {
const columnNames = primaryColumns
.map((column) => `\`${column.name}\``)
.join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
}
if (newColumn.isPrimary === true) {
primaryColumns.push(newColumn);
// update column in table
const column = clonedTable.columns.find((column) => column.name === newColumn.name);
column.isPrimary = true;
const columnNames = primaryColumns
.map((column) => `\`${column.name}\``)
.join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
}
else {
const primaryColumn = primaryColumns.find((c) => c.name === newColumn.name);
primaryColumns.splice(primaryColumns.indexOf(primaryColumn), 1);
// update column in table
const column = clonedTable.columns.find((column) => column.name === newColumn.name);
column.isPrimary = false;
// if we have another primary keys, we must recreate constraint.
if (primaryColumns.length > 0) {
const columnNames = primaryColumns
.map((column) => `\`${column.name}\``)
.join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
}
}
// if we have generated column, and we dropped AUTO_INCREMENT property before, we must bring it back
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(generatedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${generatedColumn.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
}
}
if (newColumn.isUnique !== oldColumn.isUnique) {
if (newColumn.isUnique === true) {
const uniqueIndex = new TableIndex({
name: this.connection.namingStrategy.indexName(table, [
newColumn.name,
]),
columnNames: [newColumn.name],
isUnique: true,
});
clonedTable.indices.push(uniqueIndex);
clonedTable.uniques.push(new TableUnique({
name: uniqueIndex.name,
columnNames: uniqueIndex.columnNames,
}));
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD UNIQUE INDEX \`${uniqueIndex.name}\` (\`${newColumn.name}\`)`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${uniqueIndex.name}\``));
}
else {
const uniqueIndex = clonedTable.indices.find((index) => {
return (index.columnNames.length === 1 &&
index.isUnique === true &&
!!index.columnNames.find((columnName) => columnName === newColumn.name));
});
clonedTable.indices.splice(clonedTable.indices.indexOf(uniqueIndex), 1);
const tableUnique = clonedTable.uniques.find((unique) => unique.name === uniqueIndex.name);
clonedTable.uniques.splice(clonedTable.uniques.indexOf(tableUnique), 1);
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${uniqueIndex.name}\``));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD UNIQUE INDEX \`${uniqueIndex.name}\` (\`${newColumn.name}\`)`));
}
}
}
await this.executeQueries(upQueries, downQueries);
this.replaceCachedTable(table, clonedTable);
}
/**
* Changes a column in the table.
*/
async changeColumns(tableOrName, changedColumns) {
for (const { oldColumn, newColumn } of changedColumns) {
await this.changeColumn(tableOrName, oldColumn, newColumn);
}
}
/**
* Drops column in the table.
*/
async dropColumn(tableOrName, columnOrName) {
const table = InstanceChecker.isTable(tableOrName)
? tableOrName
: await this.getCachedTable(tableOrName);
const column = InstanceChecker.isTableColumn(columnOrName)
? columnOrName
: table.findColumnByName(columnOrName);
if (!column)
throw new TypeORMError(`Column "${columnOrName}" was not found in table "${table.name}"`);
const clonedTable = table.clone();
const upQueries = [];
const downQueries = [];
// drop primary key constraint
if (column.isPrimary) {
// if table have generated column, we must drop AUTO_INCREMENT before changing primary constraints.
const generatedColumn = clonedTable.columns.find((column) => column.isGenerated &&
column.generationStrategy === "increment");
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${generatedColumn.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(generatedColumn, true)}`));
}
// dropping primary key constraint
const columnNames = clonedTable.primaryColumns
.map((primaryColumn) => `\`${primaryColumn.name}\``)
.join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(clonedTable)} DROP PRIMARY KEY`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(clonedTable)} ADD PRIMARY KEY (${columnNames})`));
// update column in table
const tableColumn = clonedTable.findColumnByName(column.name);
tableColumn.isPrimary = false;
// if primary key have multiple columns, we must recreate it without dropped column
if (clonedTable.primaryColumns.length > 0) {
const columnNames = clonedTable.primaryColumns
.map((primaryColumn) => `\`${primaryColumn.name}\``)
.join(", ");