taon-typeorm 21.0.12 → 21.0.18

package/lib-prod/typeorm/driver/sqlserver/SqlServerDriver.js

@@ -0,0 +1,921 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SqlServerDriver = void 0;
+const ConnectionIsNotSetError_1 = require("../../error/ConnectionIsNotSetError");
+const DriverPackageNotInstalledError_1 = require("../../error/DriverPackageNotInstalledError");
+const DriverUtils_1 = require("../DriverUtils");
+const SqlServerQueryRunner_1 = require("./SqlServerQueryRunner");
+const DateUtils_1 = require("../../util/DateUtils");
+const PlatformTools_1 = require("../../platform/PlatformTools");
+const RdbmsSchemaBuilder_1 = require("../../schema-builder/RdbmsSchemaBuilder");
+const MssqlParameter_1 = require("./MssqlParameter");
+const TableColumn_1 = require("../../schema-builder/table/TableColumn");
+const OrmUtils_1 = require("../../util/OrmUtils");
+const ApplyValueTransformers_1 = require("../../util/ApplyValueTransformers");
+const error_1 = require("../../error");
+const InstanceChecker_1 = require("../../util/InstanceChecker");
+/**
+ * Organizes communication with SQL Server DBMS.
+ */
+class SqlServerDriver {
+    // -------------------------------------------------------------------------
+    // Public Properties
+    // -------------------------------------------------------------------------
+    /**
+     * Connection used by driver.
+     */
+    connection;
+    /**
+     * SQL Server library.
+     */
+    mssql;
+    /**
+     * Pool for master database.
+     */
+    master;
+    /**
+     * Pool for slave databases.
+     * Used in replication.
+     */
+    slaves = [];
+    // -------------------------------------------------------------------------
+    // Public Implemented Properties
+    // -------------------------------------------------------------------------
+    /**
+     * Connection options.
+     */
+    options;
+    /**
+     * Database name used to perform all write queries.
+     */
+    database;
+    /**
+     * Schema name used to perform all write queries.
+     */
+    schema;
+    /**
+     * Schema that's used internally by SQL Server for object resolution.
+     *
+     * Because we never set this we have to track it in separately from the `schema` so
+     * we know when we have to specify the full schema or not.
+     *
+     * In most cases this will be `dbo`.
+     */
+    searchSchema;
+    /**
+     * Indicates if replication is enabled.
+     */
+    isReplicated = false;
+    /**
+     * Indicates if tree tables are supported by this driver.
+     */
+    treeSupport = true;
+    /**
+     * Represent transaction support by this driver
+     */
+    transactionSupport = "simple";
+    /**
+     * Gets list of supported column data types by a driver.
+     *
+     * @see https://docs.microsoft.com/en-us/sql/t-sql/data-types/data-types-transact-sql
+     */
+    supportedDataTypes = [
+        "int",
+        "bigint",
+        "bit",
+        "decimal",
+        "money",
+        "numeric",
+        "smallint",
+        "smallmoney",
+        "tinyint",
+        "float",
+        "real",
+        "date",
+        "datetime2",
+        "datetime",
+        "datetimeoffset",
+        "smalldatetime",
+        "time",
+        "char",
+        "varchar",
+        "text",
+        "nchar",
+        "nvarchar",
+        "ntext",
+        "binary",
+        "image",
+        "varbinary",
+        "hierarchyid",
+        "sql_variant",
+        "timestamp",
+        "uniqueidentifier",
+        "xml",
+        "geometry",
+        "geography",
+        "rowversion",
+    ];
+    /**
+     * Gets list of spatial column data types.
+     */
+    spatialTypes = ["geometry", "geography"];
+    /**
+     * Gets list of column data types that support length by a driver.
+     */
+    withLengthColumnTypes = [
+        "char",
+        "varchar",
+        "nchar",
+        "nvarchar",
+        "binary",
+        "varbinary",
+    ];
+    /**
+     * Gets list of column data types that support precision by a driver.
+     */
+    withPrecisionColumnTypes = [
+        "decimal",
+        "numeric",
+        "time",
+        "datetime2",
+        "datetimeoffset",
+    ];
+    /**
+     * Gets list of column data types that support scale by a driver.
+     */
+    withScaleColumnTypes = ["decimal", "numeric"];
+    /**
+     * Orm has special columns and we need to know what database column types should be for those types.
+     * Column types are driver dependant.
+     */
+    mappedDataTypes = {
+        createDate: "datetime2",
+        createDateDefault: "getdate()",
+        updateDate: "datetime2",
+        updateDateDefault: "getdate()",
+        deleteDate: "datetime2",
+        deleteDateNullable: true,
+        version: "int",
+        treeLevel: "int",
+        migrationId: "int",
+        migrationName: "varchar",
+        migrationTimestamp: "bigint",
+        cacheId: "int",
+        cacheIdentifier: "nvarchar",
+        cacheTime: "bigint",
+        cacheDuration: "int",
+        cacheQuery: "nvarchar(MAX)",
+        cacheResult: "nvarchar(MAX)",
+        metadataType: "varchar",
+        metadataDatabase: "varchar",
+        metadataSchema: "varchar",
+        metadataTable: "varchar",
+        metadataName: "varchar",
+        metadataValue: "nvarchar(MAX)",
+    };
+    /**
+     * Default values of length, precision and scale depends on column data type.
+     * Used in the cases when length/precision/scale is not specified by user.
+     */
+    dataTypeDefaults = {
+        char: { length: 1 },
+        nchar: { length: 1 },
+        varchar: { length: 255 },
+        nvarchar: { length: 255 },
+        binary: { length: 1 },
+        varbinary: { length: 1 },
+        decimal: { precision: 18, scale: 0 },
+        numeric: { precision: 18, scale: 0 },
+        time: { precision: 7 },
+        datetime2: { precision: 7 },
+        datetimeoffset: { precision: 7 },
+    };
+    cteCapabilities = {
+        enabled: true,
+        // todo: enable it for SQL Server - it's partially supported, but there are issues with generation of non-standard OUTPUT clause
+        writable: false,
+    };
+    /**
+     * Max length allowed by MSSQL Server for aliases (identifiers).
+     * @see https://docs.microsoft.com/en-us/sql/sql-server/maximum-capacity-specifications-for-sql-server
+     */
+    maxAliasLength = 128;
+    // -------------------------------------------------------------------------
+    // Constructor
+    // -------------------------------------------------------------------------
+    constructor(connection) {
+        this.connection = connection;
+        this.options = connection.options;
+        this.isReplicated = this.options.replication ? true : false;
+        // load mssql package
+        this.loadDependencies();
+        this.database = DriverUtils_1.DriverUtils.buildDriverOptions(this.options.replication
+            ? this.options.replication.master
+            : this.options).database;
+        this.schema = DriverUtils_1.DriverUtils.buildDriverOptions(this.options).schema;
+        // Object.assign(connection.options, DriverUtils.buildDriverOptions(connection.options)); // todo: do it better way
+        // validate options to make sure everything is set
+        // if (!this.options.host)
+        // throw new DriverOptionNotSetError("host");
+        // if (!this.options.username)
+        //     throw new DriverOptionNotSetError("username");
+        // if (!this.options.database)
+        //     throw new DriverOptionNotSetError("database");
+    }
+    // -------------------------------------------------------------------------
+    // Public Implemented Methods
+    // -------------------------------------------------------------------------
+    /**
+     * Performs connection to the database.
+     * Based on pooling options, it can either create connection immediately,
+     * either create a pool and create connection when needed.
+     */
+    async connect() {
+        if (this.options.replication) {
+            this.slaves = await Promise.all(this.options.replication.slaves.map((slave) => {
+                return this.createPool(this.options, slave);
+            }));
+            this.master = await this.createPool(this.options, this.options.replication.master);
+        }
+        else {
+            this.master = await this.createPool(this.options, this.options);
+        }
+        if (!this.database || !this.searchSchema) {
+            const queryRunner = await this.createQueryRunner("master");
+            if (!this.database) {
+                this.database = await queryRunner.getCurrentDatabase();
+            }
+            if (!this.searchSchema) {
+                this.searchSchema = await queryRunner.getCurrentSchema();
+            }
+            await queryRunner.release();
+        }
+        if (!this.schema) {
+            this.schema = this.searchSchema;
+        }
+    }
+    /**
+     * Makes any action after connection (e.g. create extensions in Postgres driver).
+     */
+    afterConnect() {
+        return Promise.resolve();
+    }
+    /**
+     * Closes connection with the database.
+     */
+    async disconnect() {
+        if (!this.master)
+            return Promise.reject(new ConnectionIsNotSetError_1.ConnectionIsNotSetError("mssql"));
+        await this.closePool(this.master);
+        await Promise.all(this.slaves.map((slave) => this.closePool(slave)));
+        this.master = undefined;
+        this.slaves = [];
+    }
+    /**
+     * Closes connection pool.
+     */
+    async closePool(pool) {
+        return new Promise((ok, fail) => {
+            pool.close((err) => (err ? fail(err) : ok()));
+        });
+    }
+    /**
+     * Creates a schema builder used to build and sync a schema.
+     */
+    createSchemaBuilder() {
+        return new RdbmsSchemaBuilder_1.RdbmsSchemaBuilder(this.connection);
+    }
+    /**
+     * Creates a query runner used to execute database queries.
+     */
+    createQueryRunner(mode) {
+        return new SqlServerQueryRunner_1.SqlServerQueryRunner(this, mode);
+    }
+    /**
+     * Replaces parameters in the given sql with special escaping character
+     * and an array of parameter names to be passed to a query.
+     */
+    escapeQueryWithParameters(sql, parameters, nativeParameters) {
+        const escapedParameters = Object.keys(nativeParameters).map((key) => nativeParameters[key]);
+        if (!parameters || !Object.keys(parameters).length)
+            return [sql, escapedParameters];
+        sql = sql.replace(/:(\.\.\.)?([A-Za-z0-9_.]+)/g, (full, isArray, key) => {
+            if (!parameters.hasOwnProperty(key)) {
+                return full;
+            }
+            let value = parameters[key];
+            if (isArray) {
+                return value
+                    .map((v) => {
+                    escapedParameters.push(v);
+                    return this.createParameter(key, escapedParameters.length - 1);
+                })
+                    .join(", ");
+            }
+            if (typeof value === "function") {
+                return value();
+            }
+            escapedParameters.push(value);
+            return this.createParameter(key, escapedParameters.length - 1);
+        }); // todo: make replace only in value statements, otherwise problems
+        return [sql, escapedParameters];
+    }
+    /**
+     * Escapes a column name.
+     */
+    escape(columnName) {
+        return `"${columnName}"`;
+    }
+    /**
+     * Build full table name with database name, schema name and table name.
+     * E.g. myDB.mySchema.myTable
+     */
+    buildTableName(tableName, schema, database) {
+        let tablePath = [tableName];
+        if (schema) {
+            tablePath.unshift(schema);
+        }
+        if (database) {
+            if (!schema) {
+                tablePath.unshift("");
+            }
+            tablePath.unshift(database);
+        }
+        return tablePath.join(".");
+    }
+    /**
+     * Parse a target table name or other types and return a normalized table definition.
+     */
+    parseTableName(target) {
+        const driverDatabase = this.database;
+        const driverSchema = this.schema;
+        if (InstanceChecker_1.InstanceChecker.isTable(target) || InstanceChecker_1.InstanceChecker.isView(target)) {
+            const parsed = this.parseTableName(target.name);
+            return {
+                database: target.database || parsed.database || driverDatabase,
+                schema: target.schema || parsed.schema || driverSchema,
+                tableName: parsed.tableName,
+            };
+        }
+        if (InstanceChecker_1.InstanceChecker.isTableForeignKey(target)) {
+            const parsed = this.parseTableName(target.referencedTableName);
+            return {
+                database: target.referencedDatabase ||
+                    parsed.database ||
+                    driverDatabase,
+                schema: target.referencedSchema || parsed.schema || driverSchema,
+                tableName: parsed.tableName,
+            };
+        }
+        if (InstanceChecker_1.InstanceChecker.isEntityMetadata(target)) {
+            // EntityMetadata tableName is never a path
+            return {
+                database: target.database || driverDatabase,
+                schema: target.schema || driverSchema,
+                tableName: target.tableName,
+            };
+        }
+        const parts = target.split(".");
+        if (parts.length === 3) {
+            return {
+                database: parts[0] || driverDatabase,
+                schema: parts[1] || driverSchema,
+                tableName: parts[2],
+            };
+        }
+        else if (parts.length === 2) {
+            return {
+                database: driverDatabase,
+                schema: parts[0],
+                tableName: parts[1],
+            };
+        }
+        else {
+            return {
+                database: driverDatabase,
+                schema: driverSchema,
+                tableName: target,
+            };
+        }
+    }
+    /**
+     * Prepares given value to a value to be persisted, based on its column type and metadata.
+     */
+    preparePersistentValue(value, columnMetadata) {
+        if (columnMetadata.transformer)
+            value = ApplyValueTransformers_1.ApplyValueTransformers.transformTo(columnMetadata.transformer, value);
+        if (value === null || value === undefined)
+            return value;
+        if (columnMetadata.type === Boolean) {
+            return value === true ? 1 : 0;
+        }
+        else if (columnMetadata.type === "date") {
+            return DateUtils_1.DateUtils.mixedDateToDate(value);
+        }
+        else if (columnMetadata.type === "time") {
+            return DateUtils_1.DateUtils.mixedTimeToDate(value);
+        }
+        else if (columnMetadata.type === "datetime" ||
+            columnMetadata.type === "smalldatetime" ||
+            columnMetadata.type === Date) {
+            return DateUtils_1.DateUtils.mixedDateToDate(value, false, false);
+        }
+        else if (columnMetadata.type === "datetime2" ||
+            columnMetadata.type === "datetimeoffset") {
+            return DateUtils_1.DateUtils.mixedDateToDate(value, false, true);
+        }
+        else if (columnMetadata.type === "simple-array") {
+            return DateUtils_1.DateUtils.simpleArrayToString(value);
+        }
+        else if (columnMetadata.type === "simple-json") {
+            return DateUtils_1.DateUtils.simpleJsonToString(value);
+        }
+        else if (columnMetadata.type === "simple-enum") {
+            return DateUtils_1.DateUtils.simpleEnumToString(value);
+        }
+        return value;
+    }
+    /**
+     * Prepares given value to a value to be persisted, based on its column type or metadata.
+     */
+    prepareHydratedValue(value, columnMetadata) {
+        if (value === null || value === undefined)
+            return columnMetadata.transformer
+                ? ApplyValueTransformers_1.ApplyValueTransformers.transformFrom(columnMetadata.transformer, value)
+                : value;
+        if (columnMetadata.type === Boolean) {
+            value = value ? true : false;
+        }
+        else if (columnMetadata.type === "datetime" ||
+            columnMetadata.type === Date ||
+            columnMetadata.type === "datetime2" ||
+            columnMetadata.type === "smalldatetime" ||
+            columnMetadata.type === "datetimeoffset") {
+            value = DateUtils_1.DateUtils.normalizeHydratedDate(value);
+        }
+        else if (columnMetadata.type === "date") {
+            value = DateUtils_1.DateUtils.mixedDateToDateString(value);
+        }
+        else if (columnMetadata.type === "time") {
+            value = DateUtils_1.DateUtils.mixedTimeToString(value);
+        }
+        else if (columnMetadata.type === "simple-array") {
+            value = DateUtils_1.DateUtils.stringToSimpleArray(value);
+        }
+        else if (columnMetadata.type === "simple-json") {
+            value = DateUtils_1.DateUtils.stringToSimpleJson(value);
+        }
+        else if (columnMetadata.type === "simple-enum") {
+            value = DateUtils_1.DateUtils.stringToSimpleEnum(value, columnMetadata);
+        }
+        else if (columnMetadata.type === Number) {
+            // convert to number if number
+            value = !isNaN(+value) ? parseInt(value) : value;
+        }
+        if (columnMetadata.transformer)
+            value = ApplyValueTransformers_1.ApplyValueTransformers.transformFrom(columnMetadata.transformer, value);
+        return value;
+    }
+    /**
+     * Creates a database type from a given column metadata.
+     */
+    normalizeType(column) {
+        if (column.type === Number || column.type === "integer") {
+            return "int";
+        }
+        else if (column.type === String) {
+            return "nvarchar";
+        }
+        else if (column.type === Date) {
+            return "datetime";
+        }
+        else if (column.type === Boolean) {
+            return "bit";
+            //#region @backend
+        }
+        else if (column.type === Buffer) {
+            return "binary";
+            //#endregion
+        }
+        else if (column.type === "uuid") {
+            return "uniqueidentifier";
+        }
+        else if (column.type === "simple-array" ||
+            column.type === "simple-json") {
+            return "ntext";
+        }
+        else if (column.type === "simple-enum") {
+            return "nvarchar";
+        }
+        else if (column.type === "dec") {
+            return "decimal";
+        }
+        else if (column.type === "double precision") {
+            return "float";
+        }
+        else if (column.type === "rowversion") {
+            return "timestamp"; // the rowversion type's name in SQL server metadata is timestamp
+        }
+        else {
+            return column.type || "";
+        }
+    }
+    /**
+     * Normalizes "default" value of the column.
+     */
+    normalizeDefault(columnMetadata) {
+        const defaultValue = columnMetadata.default;
+        if (typeof defaultValue === "number") {
+            return `${defaultValue}`;
+        }
+        if (typeof defaultValue === "boolean") {
+            return defaultValue ? "1" : "0";
+        }
+        if (typeof defaultValue === "function") {
+            const value = defaultValue();
+            if (value.toUpperCase() === "CURRENT_TIMESTAMP") {
+                return "getdate()";
+            }
+            return value;
+        }
+        if (typeof defaultValue === "string") {
+            return `'${defaultValue}'`;
+        }
+        if (defaultValue === undefined || defaultValue === null) {
+            return undefined;
+        }
+        return `${defaultValue}`;
+    }
+    /**
+     * Normalizes "isUnique" value of the column.
+     */
+    normalizeIsUnique(column) {
+        return column.entityMetadata.uniques.some((uq) => uq.columns.length === 1 && uq.columns[0] === column);
+    }
+    /**
+     * Returns default column lengths, which is required on column creation.
+     */
+    getColumnLength(column) {
+        if (column.length)
+            return column.length.toString();
+        if (column.type === "varchar" ||
+            column.type === "nvarchar" ||
+            column.type === String)
+            return "255";
+        return "";
+    }
+    /**
+     * Creates column type definition including length, precision and scale
+     */
+    createFullType(column) {
+        // The Database Engine determines the data type of the computed column by applying the rules
+        // of data type precedence to the expressions specified in the formula.
+        if (column.asExpression)
+            return "";
+        let type = column.type;
+        // used 'getColumnLength()' method, because SqlServer sets `varchar` and `nvarchar` length to 1 by default.
+        if (this.getColumnLength(column)) {
+            type += `(${this.getColumnLength(column)})`;
+        }
+        else if (column.precision !== null &&
+            column.precision !== undefined &&
+            column.scale !== null &&
+            column.scale !== undefined) {
+            type += `(${column.precision},${column.scale})`;
+        }
+        else if (column.precision !== null &&
+            column.precision !== undefined) {
+            type += `(${column.precision})`;
+        }
+        if (column.isArray)
+            type += " array";
+        return type;
+    }
+    /**
+     * Obtains a new database connection to a master server.
+     * Used for replication.
+     * If replication is not setup then returns default connection's database connection.
+     */
+    obtainMasterConnection() {
+        if (!this.master) {
+            return Promise.reject(new error_1.TypeORMError("Driver not Connected"));
+        }
+        return Promise.resolve(this.master);
+    }
+    /**
+     * Obtains a new database connection to a slave server.
+     * Used for replication.
+     * If replication is not setup then returns master (default) connection's database connection.
+     */
+    obtainSlaveConnection() {
+        if (!this.slaves.length)
+            return this.obtainMasterConnection();
+        const random = Math.floor(Math.random() * this.slaves.length);
+        return Promise.resolve(this.slaves[random]);
+    }
+    /**
+     * Creates generated map of values generated or returned by database after INSERT query.
+     */
+    createGeneratedMap(metadata, insertResult) {
+        if (!insertResult)
+            return undefined;
+        return Object.keys(insertResult).reduce((map, key) => {
+            const column = metadata.findColumnWithDatabaseName(key);
+            if (column) {
+                OrmUtils_1.OrmUtils.mergeDeep(map, column.createValueMap(this.prepareHydratedValue(insertResult[key], column)));
+            }
+            return map;
+        }, {});
+    }
+    /**
+     * Differentiate columns of this table and columns from the given column metadatas columns
+     * and returns only changed.
+     */
+    findChangedColumns(tableColumns, columnMetadatas) {
+        return columnMetadatas.filter((columnMetadata) => {
+            const tableColumn = tableColumns.find((c) => c.name === columnMetadata.databaseName);
+            if (!tableColumn)
+                return false; // we don't need new columns, we only need exist and changed
+            const isColumnChanged = tableColumn.name !== columnMetadata.databaseName ||
+                this.compareColumnType(tableColumn, columnMetadata) ||
+                this.compareColumnLength(tableColumn, columnMetadata) ||
+                tableColumn.precision !== columnMetadata.precision ||
+                tableColumn.scale !== columnMetadata.scale ||
+                // || tableColumn.comment !== columnMetadata.comment || // todo
+                tableColumn.isGenerated !== columnMetadata.isGenerated ||
+                (!tableColumn.isGenerated &&
+                    this.lowerDefaultValueIfNecessary(this.normalizeDefault(columnMetadata)) !==
+                        this.lowerDefaultValueIfNecessary(tableColumn.default)) || // we included check for generated here, because generated columns already can have default values
+                tableColumn.isPrimary !== columnMetadata.isPrimary ||
+                tableColumn.isNullable !== columnMetadata.isNullable ||
+                tableColumn.asExpression !== columnMetadata.asExpression ||
+                tableColumn.generatedType !== columnMetadata.generatedType ||
+                tableColumn.isUnique !== this.normalizeIsUnique(columnMetadata);
+            // DEBUG SECTION
+            // if (isColumnChanged) {
+            //     console.log("table:", columnMetadata.entityMetadata.tableName)
+            //     console.log(
+            //         "name:",
+            //         tableColumn.name,
+            //         columnMetadata.databaseName,
+            //     )
+            //     console.log(
+            //         "type:",
+            //         tableColumn.type,
+            //         this.normalizeType(columnMetadata),
+            //         this.compareColumnType(tableColumn, columnMetadata),
+            //     )
+            //     console.log(
+            //         "length:",
+            //         tableColumn.length,
+            //         columnMetadata.length,
+            //         this.compareColumnLength(tableColumn, columnMetadata),
+            //     )
+            //     console.log(
+            //         "precision:",
+            //         tableColumn.precision,
+            //         columnMetadata.precision,
+            //     )
+            //     console.log("scale:", tableColumn.scale, columnMetadata.scale)
+            //     console.log(
+            //         "isGenerated:",
+            //         tableColumn.isGenerated,
+            //         columnMetadata.isGenerated,
+            //     )
+            //     console.log(
+            //         "isGenerated 2:",
+            //         !tableColumn.isGenerated &&
+            //             this.lowerDefaultValueIfNecessary(
+            //                 this.normalizeDefault(columnMetadata),
+            //             ) !==
+            //                 this.lowerDefaultValueIfNecessary(
+            //                     tableColumn.default,
+            //                 ),
+            //     )
+            //     console.log(
+            //         "isPrimary:",
+            //         tableColumn.isPrimary,
+            //         columnMetadata.isPrimary,
+            //     )
+            //     console.log(
+            //         "isNullable:",
+            //         tableColumn.isNullable,
+            //         columnMetadata.isNullable,
+            //     )
+            //     console.log(
+            //         "asExpression:",
+            //         tableColumn.asExpression,
+            //         columnMetadata.asExpression,
+            //     )
+            //     console.log(
+            //         "generatedType:",
+            //         tableColumn.generatedType,
+            //         columnMetadata.generatedType,
+            //     )
+            //     console.log(
+            //         "isUnique:",
+            //         tableColumn.isUnique,
+            //         this.normalizeIsUnique(columnMetadata),
+            //     )
+            //     console.log("==========================================")
+            // }
+            return isColumnChanged;
+        });
+    }
+    /**
+     * Returns true if driver supports RETURNING / OUTPUT statement.
+     */
+    isReturningSqlSupported() {
+        if (this.options.options &&
+            this.options.options.disableOutputReturning) {
+            return false;
+        }
+        return true;
+    }
+    /**
+     * Returns true if driver supports uuid values generation on its own.
+     */
+    isUUIDGenerationSupported() {
+        return true;
+    }
+    /**
+     * Returns true if driver supports fulltext indices.
+     */
+    isFullTextColumnTypeSupported() {
+        return false;
+    }
+    /**
+     * Creates an escaped parameter.
+     */
+    createParameter(parameterName, index) {
+        return "@" + index;
+    }
+    // -------------------------------------------------------------------------
+    // Public Methods
+    // -------------------------------------------------------------------------
+    /**
+     * Sql server's parameters needs to be wrapped into special object with type information about this value.
+     * This method wraps given value into MssqlParameter based on its column definition.
+     */
+    parametrizeValue(column, value) {
+        // if its already MssqlParameter then simply return it
+        if (InstanceChecker_1.InstanceChecker.isMssqlParameter(value))
+            return value;
+        const normalizedType = this.normalizeType({ type: column.type });
+        if (column.length) {
+            return new MssqlParameter_1.MssqlParameter(value, normalizedType, column.length);
+        }
+        else if (column.precision !== null &&
+            column.precision !== undefined &&
+            column.scale !== null &&
+            column.scale !== undefined) {
+            return new MssqlParameter_1.MssqlParameter(value, normalizedType, column.precision, column.scale);
+        }
+        else if (column.precision !== null &&
+            column.precision !== undefined) {
+            return new MssqlParameter_1.MssqlParameter(value, normalizedType, column.precision);
+        }
+        else if (column.scale !== null && column.scale !== undefined) {
+            return new MssqlParameter_1.MssqlParameter(value, normalizedType, column.scale);
+        }
+        return new MssqlParameter_1.MssqlParameter(value, normalizedType);
+    }
+    /**
+     * Sql server's parameters needs to be wrapped into special object with type information about this value.
+     * This method wraps all values of the given object into MssqlParameter based on their column definitions in the given table.
+     */
+    parametrizeMap(tablePath, map) {
+        // find metadata for the given table
+        if (!this.connection.hasMetadata(tablePath))
+            // if no metadata found then we can't proceed because we don't have columns and their types
+            return map;
+        const metadata = this.connection.getMetadata(tablePath);
+        return Object.keys(map).reduce((newMap, key) => {
+            const value = map[key];
+            // find column metadata
+            const column = metadata.findColumnWithDatabaseName(key);
+            if (!column)
+                // if we didn't find a column then we can't proceed because we don't have a column type
+                return value;
+            newMap[key] = this.parametrizeValue(column, value);
+            return newMap;
+        }, {});
+    }
+    buildTableVariableDeclaration(identifier, columns) {
+        const outputColumns = columns.map((column) => {
+            return `${this.escape(column.databaseName)} ${this.createFullType(new TableColumn_1.TableColumn({
+                name: column.databaseName,
+                type: this.normalizeType(column),
+                length: column.length,
+                isNullable: column.isNullable,
+                isArray: column.isArray,
+            }))}`;
+        });
+        return `DECLARE ${identifier} TABLE (${outputColumns.join(", ")})`;
+    }
+    // -------------------------------------------------------------------------
+    // Protected Methods
+    // -------------------------------------------------------------------------
+    /**
+     * If driver dependency is not given explicitly, then try to load it via "require".
+     */
+    loadDependencies() {
+        try {
+            const mssql = this.options.driver || PlatformTools_1.PlatformTools.load("mssql");
+            this.mssql = mssql;
+        }
+        catch (e) {
+            // todo: better error for browser env
+            throw new DriverPackageNotInstalledError_1.DriverPackageNotInstalledError("SQL Server", "mssql");
+        }
+    }
+    compareColumnType(tableColumn, columnMetadata) {
+        // The Database Engine determines the data type of the computed column by applying the rules
+        // of data type precedence to the expressions specified in the formula.
+        if (columnMetadata.asExpression)
+            return false;
+        return tableColumn.type !== this.normalizeType(columnMetadata);
+    }
+    compareColumnLength(tableColumn, columnMetadata) {
+        // The Database Engine determines the data type of the computed column by applying the rules
+        // of data type precedence to the expressions specified in the formula.
+        if (columnMetadata.asExpression)
+            return false;
+        return tableColumn.length !== this.getColumnLength(columnMetadata);
+    }
+    lowerDefaultValueIfNecessary(value) {
+        // SqlServer saves function calls in default value as lowercase https://github.com/typeorm/typeorm/issues/2733
+        if (!value) {
+            return value;
+        }
+        return value
+            .split(`'`)
+            .map((v, i) => {
+            return i % 2 === 1 ? v : v.toLowerCase();
+        })
+            .join(`'`);
+    }
+    /**
+     * Creates a new connection pool for a given database credentials.
+     */
+    createPool(options, credentials) {
+        credentials = Object.assign({}, credentials, DriverUtils_1.DriverUtils.buildDriverOptions(credentials)); // todo: do it better way
+        // todo: credentials.domain is deprecation. remove it in future
+        const authentication = !credentials.domain
+            ? credentials.authentication
+            : {
+                type: "ntlm",
+                options: {
+                    domain: credentials.domain,
+                    userName: credentials.username,
+                    password: credentials.password,
+                },
+            };
+        // build connection options for the driver
+        const connectionOptions = Object.assign({}, {
+            connectionTimeout: this.options.connectionTimeout,
+            requestTimeout: this.options.requestTimeout,
+            stream: this.options.stream,
+            pool: this.options.pool,
+            options: this.options.options,
+        }, {
+            server: credentials.host,
+            database: credentials.database,
+            port: credentials.port,
+            user: credentials.username,
+            password: credentials.password,
+            authentication: authentication,
+        }, options.extra || {});
+        // set default useUTC option if it hasn't been set
+        if (!connectionOptions.options) {
+            connectionOptions.options = { useUTC: false };
+        }
+        else if (!connectionOptions.options.useUTC) {
+            Object.assign(connectionOptions.options, { useUTC: false });
+        }
+        // Match the next release of tedious for configuration options
+        // Also prevents warning messages.
+        Object.assign(connectionOptions.options, { enableArithAbort: true });
+        // pooling is enabled either when its set explicitly to true,
+        // either when its not defined at all (e.g. enabled by default)
+        return new Promise((ok, fail) => {
+            const pool = new this.mssql.ConnectionPool(connectionOptions);
+            const { logger } = this.connection;
+            const poolErrorHandler = (options.pool && options.pool.errorHandler) ||
+                ((error) => logger.log("warn", `MSSQL pool raised an error. ${error}`));
+            /**
+             * Attaching an error handler to pool errors is essential, as, otherwise, errors raised will go unhandled and
+             * cause the hosting app to crash.
+             */
+            pool.on("error", poolErrorHandler);
+            const connection = pool.connect((err) => {
+                if (err)
+                    return fail(err);
+                ok(connection);
+            });
+        });
+    }
+}
+exports.SqlServerDriver = SqlServerDriver;
+//#endregion
+//# sourceMappingURL=SqlServerDriver.js.map