typeorm
Version:
Data-Mapper ORM for TypeScript and ES2023+. Supports MySQL/MariaDB, PostgreSQL, MS SQL Server, Oracle, SAP HANA, SQLite, MongoDB databases.
1,012 lines • 135 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SqlServerQueryRunner = void 0;
const error_1 = require("../../error");
const NamedPlaceholdersNotSupportedError_1 = require("../../error/NamedPlaceholdersNotSupportedError");
const QueryFailedError_1 = require("../../error/QueryFailedError");
const QueryRunnerAlreadyReleasedError_1 = require("../../error/QueryRunnerAlreadyReleasedError");
const TransactionNotStartedError_1 = require("../../error/TransactionNotStartedError");
const BaseQueryRunner_1 = require("../../query-runner/BaseQueryRunner");
const QueryLock_1 = require("../../query-runner/QueryLock");
const QueryResult_1 = require("../../query-runner/QueryResult");
const Table_1 = require("../../schema-builder/table/Table");
const TableCheck_1 = require("../../schema-builder/table/TableCheck");
const TableColumn_1 = require("../../schema-builder/table/TableColumn");
const TableForeignKey_1 = require("../../schema-builder/table/TableForeignKey");
const TableIndex_1 = require("../../schema-builder/table/TableIndex");
const TableUnique_1 = require("../../schema-builder/table/TableUnique");
const View_1 = require("../../schema-builder/view/View");
const Broadcaster_1 = require("../../subscriber/Broadcaster");
const BroadcasterResult_1 = require("../../subscriber/BroadcasterResult");
const InstanceChecker_1 = require("../../util/InstanceChecker");
const OrmUtils_1 = require("../../util/OrmUtils");
const Query_1 = require("../Query");
const validate_isolation_level_1 = require("../validate-isolation-level");
const MetadataTableType_1 = require("../types/MetadataTableType");
/**
* Runs queries on a single SQL Server database connection.
*/
class SqlServerQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
constructor(driver, mode) {
super();
// -------------------------------------------------------------------------
// Private Properties
// -------------------------------------------------------------------------
this.lock = new QueryLock_1.QueryLock();
this.driver = driver;
this.dataSource = driver.dataSource;
this.broadcaster = new Broadcaster_1.Broadcaster(this);
this.mode = mode;
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Creates/uses database connection from the connection pool to perform further operations.
* Returns obtained database connection.
*/
connect() {
return Promise.resolve();
}
/**
* Releases used database connection.
* You cannot use query runner methods once its released.
*/
release() {
this.isReleased = true;
return Promise.resolve();
}
/**
* Starts transaction.
*
* @param isolationLevel
*/
async startTransaction(isolationLevel) {
isolationLevel ??= this.dataSource.options.isolationLevel;
(0, validate_isolation_level_1.validateIsolationLevel)(this.driver.supportedIsolationLevels, isolationLevel);
if (this.isReleased)
throw new QueryRunnerAlreadyReleasedError_1.QueryRunnerAlreadyReleasedError();
this.isTransactionActive = true;
try {
await this.broadcaster.broadcast("BeforeTransactionStart");
}
catch (err) {
this.isTransactionActive = false;
throw err;
}
await new Promise(async (ok, fail) => {
const transactionCallback = (err) => {
if (err) {
this.isTransactionActive = false;
return fail(err);
}
ok();
};
if (this.transactionDepth === 0) {
const pool = await (this.mode === "slave"
? this.driver.obtainSlaveConnection()
: this.driver.obtainMasterConnection());
this.databaseConnection = pool.transaction();
this.dataSource.logger.logQuery("BEGIN TRANSACTION");
if (isolationLevel) {
this.databaseConnection.begin(this.driver.convertIsolationLevel(isolationLevel), transactionCallback);
this.dataSource.logger.logQuery("SET TRANSACTION ISOLATION LEVEL " + isolationLevel);
}
else {
this.databaseConnection.begin(transactionCallback);
}
}
else {
await this.query(`SAVE TRANSACTION typeorm_${this.transactionDepth}`);
ok();
}
this.transactionDepth += 1;
});
await this.broadcaster.broadcast("AfterTransactionStart");
}
/**
* Commits transaction.
* Error will be thrown if transaction was not started.
*/
async commitTransaction() {
if (this.isReleased)
throw new QueryRunnerAlreadyReleasedError_1.QueryRunnerAlreadyReleasedError();
if (!this.isTransactionActive)
throw new TransactionNotStartedError_1.TransactionNotStartedError();
await this.broadcaster.broadcast("BeforeTransactionCommit");
if (this.transactionDepth === 1) {
return new Promise((ok, fail) => {
this.databaseConnection.commit(async (err) => {
if (err)
return fail(err);
this.isTransactionActive = false;
this.databaseConnection = null;
await this.broadcaster.broadcast("AfterTransactionCommit");
ok();
this.dataSource.logger.logQuery("COMMIT");
this.transactionDepth -= 1;
});
});
}
this.transactionDepth -= 1;
}
/**
* Rollbacks transaction.
* Error will be thrown if transaction was not started.
*/
async rollbackTransaction() {
if (this.isReleased)
throw new QueryRunnerAlreadyReleasedError_1.QueryRunnerAlreadyReleasedError();
if (!this.isTransactionActive)
throw new TransactionNotStartedError_1.TransactionNotStartedError();
await this.broadcaster.broadcast("BeforeTransactionRollback");
if (this.transactionDepth > 1) {
await this.query(`ROLLBACK TRANSACTION typeorm_${this.transactionDepth - 1}`);
this.transactionDepth -= 1;
}
else {
return new Promise((ok, fail) => {
this.databaseConnection.rollback(async (err) => {
if (err)
return fail(err);
this.isTransactionActive = false;
this.databaseConnection = null;
await this.broadcaster.broadcast("AfterTransactionRollback");
ok();
this.dataSource.logger.logQuery("ROLLBACK");
this.transactionDepth -= 1;
});
});
}
}
/**
* Executes a given SQL query.
*
* @param query
* @param parameters
* @param useStructuredResult
*/
async query(query, parameters, useStructuredResult = false) {
if (this.isReleased)
throw new QueryRunnerAlreadyReleasedError_1.QueryRunnerAlreadyReleasedError();
if (parameters && !Array.isArray(parameters))
throw new NamedPlaceholdersNotSupportedError_1.NamedPlaceholdersNotSupportedError();
const release = await this.lock.acquire();
this.driver.dataSource.logger.logQuery(query, parameters, this);
await this.broadcaster.broadcast("BeforeQuery", query, parameters);
const broadcasterResult = new BroadcasterResult_1.BroadcasterResult();
const maxQueryExecutionTime = this.driver.options.maxQueryExecutionTime;
let queryStartTime;
try {
const pool = await (this.mode === "slave"
? this.driver.obtainSlaveConnection()
: this.driver.obtainMasterConnection());
const request = new this.driver.mssql.Request(this.isTransactionActive ? this.databaseConnection : pool);
if (parameters?.length) {
parameters.forEach((parameter, index) => {
const parameterName = index.toString();
if (InstanceChecker_1.InstanceChecker.isMssqlParameter(parameter)) {
const mssqlParameter = this.mssqlParameterToNativeParameter(parameter);
if (mssqlParameter) {
request.input(parameterName, mssqlParameter, parameter.value);
}
else {
request.input(parameterName, parameter.value);
}
}
else {
request.input(parameterName, parameter);
}
});
}
queryStartTime = Date.now();
const raw = await request.query(query).catch((err) => {
throw new QueryFailedError_1.QueryFailedError(query, parameters, err);
});
// log slow queries if maxQueryExecution time is set
const queryExecutionTime = Date.now() - queryStartTime;
this.broadcaster.broadcastAfterQueryEvent(broadcasterResult, query, parameters, true, queryExecutionTime, raw, undefined);
if (maxQueryExecutionTime &&
queryExecutionTime > maxQueryExecutionTime) {
this.driver.dataSource.logger.logQuerySlow(queryExecutionTime, query, parameters, this);
}
const result = new QueryResult_1.QueryResult();
if (raw?.hasOwnProperty("recordset")) {
result.records = raw.recordset;
}
if (raw?.hasOwnProperty("rowsAffected")) {
result.affected = raw.rowsAffected[0];
}
const queryType = query.slice(0, query.indexOf(" "));
switch (queryType) {
case "DELETE":
// for DELETE query additionally return number of affected rows
result.raw = [raw.recordset, raw.rowsAffected[0]];
break;
default:
result.raw = raw.recordset;
}
return useStructuredResult ? result : result.raw;
}
catch (err) {
const queryExecutionTime = queryStartTime
? Date.now() - queryStartTime
: undefined;
if (maxQueryExecutionTime &&
queryExecutionTime !== undefined &&
queryExecutionTime > maxQueryExecutionTime) {
this.driver.dataSource.logger.logQuerySlow(queryExecutionTime, query, parameters, this);
}
this.driver.dataSource.logger.logQueryError(err, query, parameters, this);
this.broadcaster.broadcastAfterQueryEvent(broadcasterResult, query, parameters, false, undefined, undefined, err);
throw err;
}
finally {
await broadcasterResult.wait();
release();
}
}
/**
* Returns raw data stream.
*
* @param query
* @param parameters
* @param onEnd
* @param onError
*/
async stream(query, parameters, onEnd, onError) {
if (this.isReleased)
throw new QueryRunnerAlreadyReleasedError_1.QueryRunnerAlreadyReleasedError();
const release = await this.lock.acquire();
this.driver.dataSource.logger.logQuery(query, parameters, this);
const pool = await (this.mode === "slave"
? this.driver.obtainSlaveConnection()
: this.driver.obtainMasterConnection());
const request = new this.driver.mssql.Request(this.isTransactionActive ? this.databaseConnection : pool);
if (parameters?.length) {
parameters.forEach((parameter, index) => {
const parameterName = index.toString();
if (InstanceChecker_1.InstanceChecker.isMssqlParameter(parameter)) {
request.input(parameterName, this.mssqlParameterToNativeParameter(parameter), parameter.value);
}
else {
request.input(parameterName, parameter);
}
});
}
request.query(query);
const streamRequest = request.toReadableStream();
streamRequest.on("error", (err) => {
release();
this.driver.dataSource.logger.logQueryError(err, query, parameters, this);
});
streamRequest.on("end", () => {
release();
});
if (onEnd) {
streamRequest.on("end", onEnd);
}
if (onError) {
streamRequest.on("error", onError);
}
return streamRequest;
}
/**
* Returns all available database names including system databases.
*/
async getDatabases() {
const results = await this.query(`EXEC sp_databases`);
return results.map((result) => result["DATABASE_NAME"]);
}
/**
* Returns all available schema names including system schemas.
* If database parameter specified, returns schemas of that database.
*
* @param database
*/
async getSchemas(database) {
const query = database
? `SELECT * FROM "${database}"."sys"."schemas"`
: `SELECT * FROM "sys"."schemas"`;
const results = await this.query(query);
return results.map((result) => result["name"]);
}
/**
* Checks if database with the given name exist.
*
* @param database
*/
async hasDatabase(database) {
const result = await this.query(`SELECT DB_ID(@0) as "db_id"`, [
database,
]);
const dbId = result[0]["db_id"];
return !!dbId;
}
/**
* Loads currently using database
*/
async getCurrentDatabase() {
const currentDBQuery = await this.query(`SELECT DB_NAME() AS "db_name"`);
return currentDBQuery[0]["db_name"];
}
/**
* Checks if schema with the given name exist.
*
* @param schema
*/
async hasSchema(schema) {
const result = await this.query(`SELECT SCHEMA_ID(@0) as "schema_id"`, [
schema,
]);
const schemaId = result[0]["schema_id"];
return !!schemaId;
}
/**
* Loads currently using database schema
*/
async getCurrentSchema() {
const currentSchemaQuery = await this.query(`SELECT SCHEMA_NAME() AS "schema_name"`);
return currentSchemaQuery[0]["schema_name"];
}
/**
* Checks if table with the given name exist in the database.
*
* @param tableOrName
*/
async hasTable(tableOrName) {
const parsedTableName = this.driver.parseTableName(tableOrName);
parsedTableName.database ??= await this.getCurrentDatabase();
parsedTableName.schema ??= await this.getCurrentSchema();
const sql = `SELECT * FROM ${this.driver.escape(parsedTableName.database)}."INFORMATION_SCHEMA"."TABLES" WHERE "TABLE_NAME" = @0 AND "TABLE_SCHEMA" = @1`;
const result = await this.query(sql, [
parsedTableName.tableName,
parsedTableName.schema,
]);
return result.length ? true : false;
}
/**
* Checks if column exist in the table.
*
* @param tableOrName
* @param columnName
*/
async hasColumn(tableOrName, columnName) {
const parsedTableName = this.driver.parseTableName(tableOrName);
parsedTableName.database ??= await this.getCurrentDatabase();
parsedTableName.schema ??= await this.getCurrentSchema();
const sql = `SELECT * FROM ${this.driver.escape(parsedTableName.database)}."INFORMATION_SCHEMA"."COLUMNS" WHERE "TABLE_NAME" = @0 AND "TABLE_SCHEMA" = @1 AND "COLUMN_NAME" = @2`;
const result = await this.query(sql, [
parsedTableName.tableName,
parsedTableName.schema,
columnName,
]);
return result.length ? true : false;
}
/**
* Creates a new database.
*
* @param database
* @param ifNotExists
*/
async createDatabase(database, ifNotExists) {
const escapedQuote = database.replaceAll("'", "''");
const up = ifNotExists
? `IF DB_ID('${escapedQuote}') IS NULL CREATE DATABASE ${this.driver.escape(database)}`
: `CREATE DATABASE ${this.driver.escape(database)}`;
const down = `DROP DATABASE ${this.driver.escape(database)}`;
await this.executeQueries(new Query_1.Query(up), new Query_1.Query(down));
}
/**
* Drops database.
*
* @param database
* @param ifExists
*/
async dropDatabase(database, ifExists) {
const escapedQuote = database.replaceAll("'", "''");
const up = ifExists
? `IF DB_ID('${escapedQuote}') IS NOT NULL DROP DATABASE ${this.driver.escape(database)}`
: `DROP DATABASE ${this.driver.escape(database)}`;
const down = `CREATE DATABASE ${this.driver.escape(database)}`;
await this.executeQueries(new Query_1.Query(up), new Query_1.Query(down));
}
/**
* Creates table schema.
* If database name also specified (e.g. 'dbName.schemaName') schema will be created in specified database.
*
* @param schemaPath
* @param ifNotExists
*/
async createSchema(schemaPath, ifNotExists) {
const upQueries = [];
const downQueries = [];
if (schemaPath.indexOf(".") === -1) {
const escapedQuote = schemaPath.replaceAll("'", "''");
const escapedExec = this.driver
.escape(schemaPath)
.replaceAll("'", "''");
const upQuery = ifNotExists
? `IF SCHEMA_ID('${escapedQuote}') IS NULL BEGIN EXEC ('CREATE SCHEMA ${escapedExec}') END`
: `CREATE SCHEMA ${this.driver.escape(schemaPath)}`;
upQueries.push(new Query_1.Query(upQuery));
downQueries.push(new Query_1.Query(`DROP SCHEMA ${this.driver.escape(schemaPath)}`));
}
else {
const dbName = schemaPath.split(".")[0];
const schema = schemaPath.split(".")[1];
const escapedSchemaQuote = schema.replaceAll("'", "''");
const escapedSchemaExec = this.driver
.escape(schema)
.replaceAll("'", "''");
const currentDB = await this.getCurrentDatabase();
upQueries.push(new Query_1.Query(`USE ${this.driver.escape(dbName)}`));
downQueries.push(new Query_1.Query(`USE ${this.driver.escape(currentDB)}`));
const upQuery = ifNotExists
? `IF SCHEMA_ID('${escapedSchemaQuote}') IS NULL BEGIN EXEC ('CREATE SCHEMA ${escapedSchemaExec}') END`
: `CREATE SCHEMA ${this.driver.escape(schema)}`;
upQueries.push(new Query_1.Query(upQuery));
downQueries.push(new Query_1.Query(`DROP SCHEMA ${this.driver.escape(schema)}`));
upQueries.push(new Query_1.Query(`USE ${this.driver.escape(currentDB)}`));
downQueries.push(new Query_1.Query(`USE ${this.driver.escape(dbName)}`));
}
await this.executeQueries(upQueries, downQueries);
}
/**
* Drops table schema.
* If database name also specified (e.g. 'dbName.schemaName') schema will be dropped in specified database.
*
* @param schemaPath
* @param ifExists
*/
async dropSchema(schemaPath, ifExists) {
const upQueries = [];
const downQueries = [];
if (schemaPath.indexOf(".") === -1) {
const escapedQuote = schemaPath.replaceAll("'", "''");
const escapedExec = this.driver
.escape(schemaPath)
.replaceAll("'", "''");
const upQuery = ifExists
? `IF SCHEMA_ID('${escapedQuote}') IS NOT NULL BEGIN EXEC ('DROP SCHEMA ${escapedExec}') END`
: `DROP SCHEMA ${this.driver.escape(schemaPath)}`;
upQueries.push(new Query_1.Query(upQuery));
downQueries.push(new Query_1.Query(`CREATE SCHEMA ${this.driver.escape(schemaPath)}`));
}
else {
const dbName = schemaPath.split(".")[0];
const schema = schemaPath.split(".")[1];
const escapedSchemaQuote = schema.replaceAll("'", "''");
const escapedSchemaExec = this.driver
.escape(schema)
.replaceAll("'", "''");
const currentDB = await this.getCurrentDatabase();
upQueries.push(new Query_1.Query(`USE ${this.driver.escape(dbName)}`));
downQueries.push(new Query_1.Query(`USE ${this.driver.escape(currentDB)}`));
const upQuery = ifExists
? `IF SCHEMA_ID('${escapedSchemaQuote}') IS NOT NULL BEGIN EXEC ('DROP SCHEMA ${escapedSchemaExec}') END`
: `DROP SCHEMA ${this.driver.escape(schema)}`;
upQueries.push(new Query_1.Query(upQuery));
downQueries.push(new Query_1.Query(`CREATE SCHEMA ${this.driver.escape(schema)}`));
upQueries.push(new Query_1.Query(`USE ${this.driver.escape(currentDB)}`));
downQueries.push(new Query_1.Query(`USE ${this.driver.escape(dbName)}`));
}
await this.executeQueries(upQueries, downQueries);
}
/**
* Creates a new table.
*
* @param table
* @param ifNotExists
* @param createForeignKeys
* @param createIndices
*/
async createTable(table, ifNotExists = false, createForeignKeys = true, createIndices = true) {
if (ifNotExists) {
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));
// 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 (createIndices) {
table.indices.forEach((index) => {
// new index may be passed without name. In this case we generate index name manually.
index.name ??= this.dataSource.namingStrategy.indexName(table, index.columnNames, index.where);
upQueries.push(this.createIndexSql(table, index));
downQueries.push(this.dropIndexSql(table, index));
});
}
// if table have column with generated type, we must add the expression to the metadata table
const generatedColumns = table.columns.filter((column) => column.generatedType && column.asExpression);
if (generatedColumns.length > 0) {
const parsedTableName = this.driver.parseTableName(table);
parsedTableName.schema ??= await this.getCurrentSchema();
for (const column of generatedColumns) {
const insertQuery = this.insertTypeormMetadataSql({
database: parsedTableName.database,
schema: parsedTableName.schema,
table: parsedTableName.tableName,
type: MetadataTableType_1.MetadataTableType.GENERATED_COLUMN,
name: column.name,
value: column.asExpression,
});
const deleteQuery = this.deleteTypeormMetadataSql({
database: parsedTableName.database,
schema: parsedTableName.schema,
table: parsedTableName.tableName,
type: MetadataTableType_1.MetadataTableType.GENERATED_COLUMN,
name: column.name,
});
upQueries.push(insertQuery);
downQueries.push(deleteQuery);
}
}
await this.executeQueries(upQueries, downQueries);
}
/**
* Drops the table.
*
* @param tableOrName
* @param ifExists
* @param dropForeignKeys
* @param dropIndices
*/
async dropTable(tableOrName, ifExists, dropForeignKeys = true, dropIndices = true) {
if (ifExists) {
const isTableExist = await this.hasTable(tableOrName);
if (!isTableExist)
return Promise.resolve();
}
// if dropTable called with dropForeignKeys = true, we must create foreign keys in down query.
const createForeignKeys = dropForeignKeys;
const table = InstanceChecker_1.InstanceChecker.isTable(tableOrName)
? tableOrName
: await this.getCachedTable(tableOrName);
const upQueries = [];
const downQueries = [];
// 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 (dropIndices) {
table.indices.forEach((index) => {
upQueries.push(this.dropIndexSql(table, index));
downQueries.push(this.createIndexSql(table, index));
});
}
// if dropForeignKeys is true, we just drop the table, otherwise we also drop table foreign keys.
// createTable does not need separate method to create foreign keys, because it create fk's in the same query with table creation.
if (dropForeignKeys)
table.foreignKeys.forEach((foreignKey) => upQueries.push(this.dropForeignKeySql(table, foreignKey)));
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);
if (generatedColumns.length > 0) {
const parsedTableName = this.driver.parseTableName(table);
parsedTableName.schema ??= await this.getCurrentSchema();
for (const column of generatedColumns) {
const deleteQuery = this.deleteTypeormMetadataSql({
database: parsedTableName.database,
schema: parsedTableName.schema,
table: parsedTableName.tableName,
type: MetadataTableType_1.MetadataTableType.GENERATED_COLUMN,
name: column.name,
});
const insertQuery = this.insertTypeormMetadataSql({
database: parsedTableName.database,
schema: parsedTableName.schema,
table: parsedTableName.tableName,
type: MetadataTableType_1.MetadataTableType.GENERATED_COLUMN,
name: column.name,
value: column.asExpression,
});
upQueries.push(deleteQuery);
downQueries.push(insertQuery);
}
}
await this.executeQueries(upQueries, downQueries);
}
/**
* Creates a new view.
*
* @param view
* @param syncWithMetadata
*/
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.
*
* @param target
* @param ifExists
*/
async dropView(target, ifExists) {
const viewName = InstanceChecker_1.InstanceChecker.isView(target) ? target.name : target;
let view;
try {
view = await this.getCachedView(viewName);
}
catch {
if (ifExists)
return;
throw new error_1.TypeORMError(`View "${viewName}" does not exist.`);
}
await this.executeQueries([
await this.deleteViewDefinitionSql(view),
this.dropViewSql(view, ifExists),
], [
await this.insertViewDefinitionSql(view),
this.createViewSql(view),
]);
}
/**
* Renames a table.
*
* @param oldTableOrName
* @param newTableName
*/
async renameTable(oldTableOrName, newTableName) {
const upQueries = [];
const downQueries = [];
const oldTable = InstanceChecker_1.InstanceChecker.isTable(oldTableOrName)
? oldTableOrName
: await this.getCachedTable(oldTableOrName);
const newTable = oldTable.clone();
// we need database name and schema name to rename FK constraints
let dbName = undefined;
let schemaName = undefined;
let oldTableName = oldTable.name;
const splittedName = oldTable.name.split(".");
if (splittedName.length === 3) {
dbName = splittedName[0];
oldTableName = splittedName[2];
if (splittedName[1] !== "")
schemaName = splittedName[1];
}
else if (splittedName.length === 2) {
schemaName = splittedName[0];
oldTableName = splittedName[1];
}
newTable.name = this.driver.buildTableName(newTableName, schemaName, dbName);
// if we have tables with database which differs from database specified in config, we must change currently used database.
// This need because we can not rename objects from another database.
const currentDB = await this.getCurrentDatabase();
if (dbName && dbName !== currentDB) {
upQueries.push(new Query_1.Query(`USE "${dbName}"`));
downQueries.push(new Query_1.Query(`USE "${currentDB}"`));
}
// rename table
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(oldTable)}", "${newTableName}"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(newTable)}", "${oldTableName}"`));
// rename primary key constraint
if (newTable.primaryColumns.length > 0 &&
!newTable.primaryColumns[0].primaryKeyConstraintName) {
const columnNames = newTable.primaryColumns.map((column) => column.name);
const oldPkName = this.dataSource.namingStrategy.primaryKeyName(oldTable, columnNames);
const newPkName = this.dataSource.namingStrategy.primaryKeyName(newTable, columnNames);
// rename primary constraint
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(newTable)}.${oldPkName}", "${newPkName}"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(newTable)}.${newPkName}", "${oldPkName}"`));
}
// rename unique constraints
newTable.uniques.forEach((unique) => {
const oldUniqueName = this.dataSource.namingStrategy.uniqueConstraintName(oldTable, unique.columnNames);
// Skip renaming if Unique has user defined constraint name
if (unique.name !== oldUniqueName)
return;
// build new constraint name
const newUniqueName = this.dataSource.namingStrategy.uniqueConstraintName(newTable, unique.columnNames);
// build queries
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(newTable)}.${unique.name}", "${newUniqueName}"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(newTable)}.${newUniqueName}", "${unique.name}"`));
// replace constraint name
unique.name = newUniqueName;
});
// rename index constraints
newTable.indices.forEach((index) => {
const oldIndexName = this.dataSource.namingStrategy.indexName(oldTable, index.columnNames, index.where);
// Skip renaming if Index has user defined constraint name
if (index.name !== oldIndexName)
return;
// build new constraint name
const newIndexName = this.dataSource.namingStrategy.indexName(newTable, index.columnNames, index.where);
// build queries
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(newTable)}.${index.name}", "${newIndexName}", "INDEX"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(newTable)}.${newIndexName}", "${index.name}", "INDEX"`));
// replace constraint name
index.name = newIndexName;
});
// rename foreign key constraints
newTable.foreignKeys.forEach((foreignKey) => {
const oldForeignKeyName = this.dataSource.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 newForeignKeyName = this.dataSource.namingStrategy.foreignKeyName(newTable, foreignKey.columnNames, this.getTablePath(foreignKey), foreignKey.referencedColumnNames);
// build queries
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.buildForeignKeyName(foreignKey.name, schemaName, dbName)}", "${newForeignKeyName}"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.buildForeignKeyName(newForeignKeyName, schemaName, dbName)}", "${foreignKey.name}"`));
// replace constraint name
foreignKey.name = newForeignKeyName;
});
// change currently used database back to default db.
if (dbName && dbName !== currentDB) {
upQueries.push(new Query_1.Query(`USE "${currentDB}"`));
downQueries.push(new Query_1.Query(`USE "${dbName}"`));
}
await this.executeQueries(upQueries, downQueries);
// rename old table and replace it in cached tabled;
oldTable.name = newTable.name;
this.replaceCachedTable(oldTable, newTable);
}
/**
* Creates a new column from the column in the table.
*
* @param tableOrName
* @param column
*/
async addColumn(tableOrName, column) {
const table = InstanceChecker_1.InstanceChecker.isTable(tableOrName)
? tableOrName
: await this.getCachedTable(tableOrName);
const clonedTable = table.clone();
const upQueries = [];
const downQueries = [];
upQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} ADD ${this.buildCreateColumnSql(table, column, false, true)}`));
downQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} DROP COLUMN "${column.name}"`));
// create or update primary key constraint
if (column.isPrimary) {
const primaryColumns = clonedTable.primaryColumns;
// if table already have primary key, me must drop it and recreate again
if (primaryColumns.length > 0) {
const pkName = primaryColumns[0].primaryKeyConstraintName ??
this.dataSource.namingStrategy.primaryKeyName(clonedTable, primaryColumns.map((column) => column.name));
const columnNames = primaryColumns
.map((column) => `"${column.name}"`)
.join(", ");
upQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} DROP CONSTRAINT "${pkName}"`));
downQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} ADD CONSTRAINT "${pkName}" PRIMARY KEY (${columnNames})`));
}
primaryColumns.push(column);
const pkName = primaryColumns[0].primaryKeyConstraintName ??
this.dataSource.namingStrategy.primaryKeyName(clonedTable, primaryColumns.map((column) => column.name));
const columnNames = primaryColumns
.map((column) => `"${column.name}"`)
.join(", ");
upQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} ADD CONSTRAINT "${pkName}" PRIMARY KEY (${columnNames})`));
downQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} DROP CONSTRAINT "${pkName}"`));
}
// 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));
}
// create unique constraint
if (column.isUnique) {
const uniqueConstraint = new TableUnique_1.TableUnique({
name: this.dataSource.namingStrategy.uniqueConstraintName(table, [column.name]),
columnNames: [column.name],
});
clonedTable.uniques.push(uniqueConstraint);
upQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} ADD CONSTRAINT "${uniqueConstraint.name}" UNIQUE ("${column.name}")`));
downQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} DROP CONSTRAINT "${uniqueConstraint.name}"`));
}
// remove default constraint
if (column.default !== null && column.default !== undefined) {
const defaultName = this.dataSource.namingStrategy.defaultConstraintName(table, column.name);
downQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} DROP CONSTRAINT "${defaultName}"`));
}
if (column.generatedType && column.asExpression) {
const parsedTableName = this.driver.parseTableName(table);
parsedTableName.schema ??= await this.getCurrentSchema();
const insertQuery = this.insertTypeormMetadataSql({
database: parsedTableName.database,
schema: parsedTableName.schema,
table: parsedTableName.tableName,
type: MetadataTableType_1.MetadataTableType.GENERATED_COLUMN,
name: column.name,
value: column.asExpression,
});
const deleteQuery = this.deleteTypeormMetadataSql({
database: parsedTableName.database,
schema: parsedTableName.schema,
table: parsedTableName.tableName,
type: MetadataTableType_1.MetadataTableType.GENERATED_COLUMN,
name: column.name,
});
upQueries.push(insertQuery);
downQueries.push(deleteQuery);
}
await this.executeQueries(upQueries, downQueries);
clonedTable.addColumn(column);
this.replaceCachedTable(table, clonedTable);
}
/**
* Creates a new columns from the column in the table.
*
* @param tableOrName
* @param columns
*/
async addColumns(tableOrName, columns) {
for (const column of columns) {
await this.addColumn(tableOrName, column);
}
}
/**
* Renames column in the given table.
*
* @param tableOrName
* @param oldTableColumnOrName
* @param newTableColumnOrName
*/
async renameColumn(tableOrName, oldTableColumnOrName, newTableColumnOrName) {
const table = InstanceChecker_1.InstanceChecker.isTable(tableOrName)
? tableOrName
: await this.getCachedTable(tableOrName);
const oldColumn = InstanceChecker_1.InstanceChecker.isTableColumn(oldTableColumnOrName)
? oldTableColumnOrName
: table.columns.find((c) => c.name === oldTableColumnOrName);
if (!oldColumn)
throw new error_1.TypeORMError(`Column "${oldTableColumnOrName}" was not found in the "${table.name}" table.`);
let newColumn;
if (InstanceChecker_1.InstanceChecker.isTableColumn(newTableColumnOrName)) {
newColumn = newTableColumnOrName;
}
else {
newColumn = oldColumn.clone();
newColumn.name = newTableColumnOrName;
}
await this.changeColumn(table, oldColumn, newColumn);
}
/**
* Changes a column in the table.
*
* @param tableOrName
* @param oldTableColumnOrName
* @param newColumn
*/
async changeColumn(tableOrName, oldTableColumnOrName, newColumn) {
const table = InstanceChecker_1.InstanceChecker.isTable(tableOrName)
? tableOrName
: await this.getCachedTable(tableOrName);
let clonedTable = table.clone();
const upQueries = [];
const downQueries = [];
const oldColumn = InstanceChecker_1.InstanceChecker.isTableColumn(oldTableColumnOrName)
? oldTableColumnOrName
: table.columns.find((column) => column.name === oldTableColumnOrName);
if (!oldColumn)
throw new error_1.TypeORMError(`Column "${oldTableColumnOrName}" was not found in the "${table.name}" table.`);
if ((newColumn.isGenerated !== oldColumn.isGenerated &&
newColumn.generationStrategy !== "uuid") ||
newColumn.type !== oldColumn.type ||
newColumn.length !== oldColumn.length ||
newColumn.asExpression !== oldColumn.asExpression ||
newColumn.generatedType !== oldColumn.generatedType) {
// SQL Server does not support changing of IDENTITY column, so we must drop column and recreate it again.
// Also, we recreate column if column type changed
await this.dropColumn(table, oldColumn);
await this.addColumn(table, newColumn);
// update cloned table
clonedTable = table.clone();
}
else {
if (newColumn.name !== oldColumn.name) {
// we need database name and schema name to rename FK constraints
let dbName = undefined;
let schemaName = undefined;
const splittedName = table.name.split(".");
if (splittedName.length === 3) {
dbName = splittedName[0];
if (splittedName[1] !== "")
schemaName = splittedName[1];
}
else if (splittedName.length === 2) {
schemaName = splittedName[0];
}
// if we have tables with database which differs from database specified in config, we must change currently used database.
// This need because we can not rename objects from another database.
const currentDB = await this.getCurrentDatabase();
if (dbName && dbName !== currentDB) {
upQueries.push(new Query_1.Query(`USE "${dbName}"`));
downQueries.push(new Query_1.Query(`USE "${currentDB}"`));
}
// rename the column
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(table)}.${oldColumn.name}", "${newColumn.name}"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(table)}.${newColumn.name}", "${oldColumn.name}"`));
// rename column primary key constraint
if (oldColumn.isPrimary === true &&
!oldColumn.primaryKeyConstraintName) {
const primaryColumns = clonedTable.primaryColumns;
// build old primary constraint name
const columnNames = primaryColumns.map((column) => column.name);
const oldPkName = this.dataSource.namingStrategy.primaryKeyName(clonedTable, columnNames);
// replace old column name with new column name
columnNames.splice(columnNames.indexOf(oldColumn.name), 1);
columnNames.push(newColumn.name);
// build new primary constraint name
const newPkName = this.dataSource.namingStrategy.primaryKeyName(clonedTable, columnNames);
// rename primary constraint
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(clonedTable)}.${oldPkName}", "${newPkName}"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(clonedTable)}.${newPkName}", "${oldPkName}"`));
}
// rename index constraints
clonedTable.findColumnIndices(oldColumn).forEach((index) => {
const oldIndexName = this.dataSource.namingStrategy.indexName(clonedTable, index.columnNames, index.where);
// Skip renaming if Index has user defined constraint name
if (index.name !== oldIndexName)
return;
// build new constraint name
index.columnNames.splice(index.columnNames.indexOf(oldColumn.name), 1);
index.columnNames.push(newColumn.name);
const newIndexName = this.dataSource.namingStrategy.indexName(clonedTable, index.columnNames, index.where);
// build queries
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(clonedTable)}.${index.name}", "${newIndexName}", "INDEX"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(clonedTable)}.${newIndexName}", "${index.name}", "INDEX"`));
// replace constraint name
index.name = newIndexName;
});
// rename foreign key constraints
clonedTable
.findColumnForeignKeys(oldColumn)
.forEach((foreignKey) => {
const foreignKeyName = this.dataSource.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 newForeignKeyName = this.dataSource.namingStrategy.foreignKeyName(clonedTable, foreignKey.columnNames, this.getTablePath(foreignKey), foreignKey.referencedColumnNames);
// build queries
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.buildForeignKeyName(foreignKey.name, schemaName, dbName)}", "${newForeignKeyName}"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.buildForeignKeyName(newForeignKeyName, schemaName, dbName)}", "${foreignKey.name}"`));
// replace constraint name
foreignKey.name = newForeignKeyName;
});
// rename check constraints
clonedTable.findColumnChecks(oldColumn).forEach((check) => {
// build new constraint name
check.columnNames.splice(check.columnNames.indexOf(oldColumn.name), 1);
check.columnNames.push(newColumn.name);
const newCheckName = this.dataSource.namingStrategy.checkConstraintName(clonedTable, check.expression);
// build queries
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(clonedTable)}.${check.name}", "${newCheckName}"`));
downQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(clonedTable)}.${newCheckName}", "${check.name}"`));
// replace constraint name
check.name = newCheckName;
});
// rename unique constraints
clonedTable.findColumnUniques(oldColumn).forEach((unique) => {
const oldUniqueName = this.dataSource.namingStrategy.uniqueConstraintName(clonedTable, unique.columnNames);
// Skip renaming if Unique has user defined constraint name
if (unique.name !== oldUniqueName)
return;
// build new constraint name
unique.columnNames.splice(unique.columnNames.indexOf(oldColumn.name), 1);
unique.columnNames.push(newColumn.name);
const newUniqueName = this.dataSource.namingStrategy.uniqueConstraintName(clonedTable, unique.columnNames);
// build queries
upQueries.push(new Query_1.Query(`EXEC sp_rename "${this.getTablePath(clonedTable)}.${unique.name}", "${newUniqueName}"`));
downQuer