typeorm 0.3.29-dev.cc07c90 → 1.0.0-beta.1

package/browser/driver/sqlserver/SqlServerDriver.js

@@ -1,25 +1,35 @@
-import { ConnectionIsNotSetError } from "../../error/ConnectionIsNotSetError";
-import { DriverPackageNotInstalledError } from "../../error/DriverPackageNotInstalledError";
-import { DriverUtils } from "../DriverUtils";
-import { SqlServerQueryRunner } from "./SqlServerQueryRunner";
-import { DateUtils } from "../../util/DateUtils";
-import { PlatformTools } from "../../platform/PlatformTools";
-import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
-import { MssqlParameter } from "./MssqlParameter";
-import { TableColumn } from "../../schema-builder/table/TableColumn";
-import { OrmUtils } from "../../util/OrmUtils";
-import { ApplyValueTransformers } from "../../util/ApplyValueTransformers";
-import { TypeORMError } from "../../error";
-import { InstanceChecker } from "../../util/InstanceChecker";
-import { FindOperator } from "../../find-options/FindOperator";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SqlServerDriver = void 0;
+const error_1 = require("../../error");
+const ConnectionIsNotSetError_1 = require("../../error/ConnectionIsNotSetError");
+const DriverPackageNotInstalledError_1 = require("../../error/DriverPackageNotInstalledError");
+const FindOperator_1 = require("../../find-options/FindOperator");
+const PlatformTools_1 = require("../../platform/PlatformTools");
+const RdbmsSchemaBuilder_1 = require("../../schema-builder/RdbmsSchemaBuilder");
+const TableColumn_1 = require("../../schema-builder/table/TableColumn");
+const ApplyValueTransformers_1 = require("../../util/ApplyValueTransformers");
+const DateUtils_1 = require("../../util/DateUtils");
+const InstanceChecker_1 = require("../../util/InstanceChecker");
+const OrmUtils_1 = require("../../util/OrmUtils");
+const DriverUtils_1 = require("../DriverUtils");
+const MssqlParameter_1 = require("./MssqlParameter");
+const SqlServerQueryRunner_1 = require("./SqlServerQueryRunner");
 /**
  * Organizes communication with SQL Server DBMS.
  */
-export class SqlServerDriver {
+class SqlServerDriver {
+    /**
+     * DataSource used by the driver.
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
+     */
+    get connection() {
+        return this.dataSource;
+    }
     // -------------------------------------------------------------------------
     // Constructor
     // -------------------------------------------------------------------------
-    constructor(connection) {
+    constructor(dataSource) {
         /**
          * Pool for slave databases.
          * Used in replication.
@@ -39,7 +49,6 @@ export class SqlServerDriver {
         this.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
          */
         this.supportedDataTypes = [
@@ -174,15 +183,15 @@ export class SqlServerDriver {
          * @see https://docs.microsoft.com/en-us/sql/sql-server/maximum-capacity-specifications-for-sql-server
          */
         this.maxAliasLength = 128;
-        this.connection = connection;
-        this.options = connection.options;
+        this.dataSource = dataSource;
+        this.options = dataSource.options;
         this.isReplicated = this.options.replication ? true : false;
         // load mssql package
         this.loadDependencies();
-        this.database = DriverUtils.buildDriverOptions(this.options.replication
+        this.database = DriverUtils_1.DriverUtils.buildDriverOptions(this.options.replication
             ? this.options.replication.master
             : this.options).database;
-        this.schema = DriverUtils.buildDriverOptions(this.options).schema;
+        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)
@@ -235,7 +244,7 @@ export class SqlServerDriver {
      */
     async disconnect() {
         if (!this.master) {
-            throw new ConnectionIsNotSetError("mssql");
+            throw new ConnectionIsNotSetError_1.ConnectionIsNotSetError("mssql");
         }
         await this.closePool(this.master);
         await Promise.all(this.slaves.map((slave) => this.closePool(slave)));
@@ -244,6 +253,7 @@ export class SqlServerDriver {
     }
     /**
      * Closes connection pool.
+     * @param pool
      */
     async closePool(pool) {
         return new Promise((ok, fail) => {
@@ -254,20 +264,23 @@ export class SqlServerDriver {
      * Creates a schema builder used to build and sync a schema.
      */
     createSchemaBuilder() {
-        return new RdbmsSchemaBuilder(this.connection);
+        return new RdbmsSchemaBuilder_1.RdbmsSchemaBuilder(this.dataSource);
     }
     /**
      * Creates a query runner used to execute database queries.
+     * @param mode
      */
     createQueryRunner(mode) {
-        return new SqlServerQueryRunner(this, 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.
+     * @param sql
+     * @param parameters
      */
-    escapeQueryWithParameters(sql, parameters, nativeParameters) {
-        const escapedParameters = Object.keys(nativeParameters).map((key) => nativeParameters[key]);
+    escapeQueryWithParameters(sql, parameters) {
+        const escapedParameters = [];
         if (!parameters || !Object.keys(parameters).length)
             return [sql, escapedParameters];
         const parameterIndexMap = new Map();
@@ -298,13 +311,17 @@ export class SqlServerDriver {
     }
     /**
      * Escapes a column name.
+     * @param columnName
      */
     escape(columnName) {
-        return `"${columnName}"`;
+        return `"${columnName.replaceAll('"', '""')}"`;
     }
     /**
      * Build full table name with database name, schema name and table name.
      * E.g. myDB.mySchema.myTable
+     * @param tableName
+     * @param schema
+     * @param database
      */
     buildTableName(tableName, schema, database) {
         const tablePath = [tableName];
@@ -321,11 +338,12 @@ export class SqlServerDriver {
     }
     /**
      * Parse a target table name or other types and return a normalized table definition.
+     * @param target
      */
     parseTableName(target) {
         const driverDatabase = this.database;
         const driverSchema = this.schema;
-        if (InstanceChecker.isTable(target) || InstanceChecker.isView(target)) {
+        if (InstanceChecker_1.InstanceChecker.isTable(target) || InstanceChecker_1.InstanceChecker.isView(target)) {
             const parsed = this.parseTableName(target.name);
             return {
                 database: target.database || parsed.database || driverDatabase,
@@ -333,7 +351,7 @@ export class SqlServerDriver {
                 tableName: parsed.tableName,
             };
         }
-        if (InstanceChecker.isTableForeignKey(target)) {
+        if (InstanceChecker_1.InstanceChecker.isTableForeignKey(target)) {
             const parsed = this.parseTableName(target.referencedTableName);
             return {
                 database: target.referencedDatabase ||
@@ -343,7 +361,7 @@ export class SqlServerDriver {
                 tableName: parsed.tableName,
             };
         }
-        if (InstanceChecker.isEntityMetadata(target)) {
+        if (InstanceChecker_1.InstanceChecker.isEntityMetadata(target)) {
             // EntityMetadata tableName is never a path
             return {
                 database: target.database || driverDatabase,
@@ -376,38 +394,40 @@ export class SqlServerDriver {
     }
     /**
      * Prepares given value to a value to be persisted, based on its column type and metadata.
+     * @param value
+     * @param columnMetadata
      */
     preparePersistentValue(value, columnMetadata) {
         if (columnMetadata.transformer)
-            value = ApplyValueTransformers.transformTo(columnMetadata.transformer, value);
+            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.mixedDateToDate(value, columnMetadata.utc);
+            return DateUtils_1.DateUtils.mixedDateToDate(value, columnMetadata.utc);
         }
         else if (columnMetadata.type === "time") {
-            return DateUtils.mixedTimeToDate(value);
+            return DateUtils_1.DateUtils.mixedTimeToDate(value);
         }
         else if (columnMetadata.type === "datetime" ||
             columnMetadata.type === "smalldatetime" ||
             columnMetadata.type === Date) {
-            return DateUtils.mixedDateToDate(value, false, false);
+            return DateUtils_1.DateUtils.mixedDateToDate(value, false, false);
         }
         else if (columnMetadata.type === "datetime2" ||
             columnMetadata.type === "datetimeoffset") {
-            return DateUtils.mixedDateToDate(value, false, true);
+            return DateUtils_1.DateUtils.mixedDateToDate(value, false, true);
         }
         else if (columnMetadata.type === "simple-array") {
-            return DateUtils.simpleArrayToString(value);
+            return DateUtils_1.DateUtils.simpleArrayToString(value);
         }
         else if (columnMetadata.type === "simple-json") {
-            return DateUtils.simpleJsonToString(value);
+            return DateUtils_1.DateUtils.simpleJsonToString(value);
         }
         else if (columnMetadata.type === "simple-enum") {
-            return DateUtils.simpleEnumToString(value);
+            return DateUtils_1.DateUtils.simpleEnumToString(value);
         }
         else if (columnMetadata.type === "vector") {
             if (Array.isArray(value)) {
@@ -421,11 +441,13 @@ export class SqlServerDriver {
     }
     /**
      * Prepares given value to a value to be persisted, based on its column type or metadata.
+     * @param value
+     * @param columnMetadata
      */
     prepareHydratedValue(value, columnMetadata) {
         if (value === null || value === undefined)
             return columnMetadata.transformer
-                ? ApplyValueTransformers.transformFrom(columnMetadata.transformer, value)
+                ? ApplyValueTransformers_1.ApplyValueTransformers.transformFrom(columnMetadata.transformer, value)
                 : value;
         if (columnMetadata.type === Boolean) {
             value = value ? true : false;
@@ -435,24 +457,24 @@ export class SqlServerDriver {
             columnMetadata.type === "datetime2" ||
             columnMetadata.type === "smalldatetime" ||
             columnMetadata.type === "datetimeoffset") {
-            value = DateUtils.normalizeHydratedDate(value);
+            value = DateUtils_1.DateUtils.normalizeHydratedDate(value);
         }
         else if (columnMetadata.type === "date") {
-            value = DateUtils.mixedDateToDateString(value, {
+            value = DateUtils_1.DateUtils.mixedDateToDateString(value, {
                 utc: columnMetadata.utc,
             });
         }
         else if (columnMetadata.type === "time") {
-            value = DateUtils.mixedTimeToString(value);
+            value = DateUtils_1.DateUtils.mixedTimeToString(value);
         }
         else if (columnMetadata.type === "simple-array") {
-            value = DateUtils.stringToSimpleArray(value);
+            value = DateUtils_1.DateUtils.stringToSimpleArray(value);
         }
         else if (columnMetadata.type === "simple-json") {
-            value = DateUtils.stringToSimpleJson(value);
+            value = DateUtils_1.DateUtils.stringToSimpleJson(value);
         }
         else if (columnMetadata.type === "simple-enum") {
-            value = DateUtils.stringToSimpleEnum(value, columnMetadata);
+            value = DateUtils_1.DateUtils.stringToSimpleEnum(value, columnMetadata);
         }
         else if (columnMetadata.type === "vector") {
             if (typeof value === "string") {
@@ -469,11 +491,16 @@ export class SqlServerDriver {
             value = !isNaN(+value) ? parseInt(value) : value;
         }
         if (columnMetadata.transformer)
-            value = ApplyValueTransformers.transformFrom(columnMetadata.transformer, value);
+            value = ApplyValueTransformers_1.ApplyValueTransformers.transformFrom(columnMetadata.transformer, value);
         return value;
     }
     /**
      * Creates a database type from a given column metadata.
+     * @param column
+     * @param column.type
+     * @param column.length
+     * @param column.precision
+     * @param column.scale
      */
     normalizeType(column) {
         if (column.type === Number || column.type === "integer") {
@@ -488,7 +515,8 @@ export class SqlServerDriver {
         else if (column.type === Boolean) {
             return "bit";
         }
-        else if (column.type === Buffer) {
+        else if (typeof column.type === "function" &&
+            column.type.prototype instanceof Uint8Array) {
             return "binary";
         }
         else if (column.type === "uuid") {
@@ -516,6 +544,7 @@ export class SqlServerDriver {
     }
     /**
      * Normalizes "default" value of the column.
+     * @param columnMetadata
      */
     normalizeDefault(columnMetadata) {
         const defaultValue = columnMetadata.default;
@@ -542,12 +571,14 @@ export class SqlServerDriver {
     }
     /**
      * Normalizes "isUnique" value of the column.
+     * @param 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.
+     * @param column
      */
     getColumnLength(column) {
         if (column.length)
@@ -560,6 +591,7 @@ export class SqlServerDriver {
     }
     /**
      * Creates column type definition including length, precision and scale
+     * @param column
      */
     createFullType(column) {
         // The Database Engine determines the data type of the computed column by applying the rules
@@ -596,7 +628,7 @@ export class SqlServerDriver {
      */
     obtainMasterConnection() {
         if (!this.master) {
-            return Promise.reject(new TypeORMError("Driver not Connected"));
+            return Promise.reject(new error_1.TypeORMError("Driver not Connected"));
         }
         return Promise.resolve(this.master);
     }
@@ -613,6 +645,8 @@ export class SqlServerDriver {
     }
     /**
      * Creates generated map of values generated or returned by database after INSERT query.
+     * @param metadata
+     * @param insertResult
      */
     createGeneratedMap(metadata, insertResult) {
         if (!insertResult)
@@ -620,7 +654,7 @@ export class SqlServerDriver {
         return Object.keys(insertResult).reduce((map, key) => {
             const column = metadata.findColumnWithDatabaseName(key);
             if (column) {
-                OrmUtils.mergeDeep(map, column.createValueMap(this.prepareHydratedValue(insertResult[key], column)));
+                OrmUtils_1.OrmUtils.mergeDeep(map, column.createValueMap(this.prepareHydratedValue(insertResult[key], column)));
             }
             return map;
         }, {});
@@ -628,6 +662,8 @@ export class SqlServerDriver {
     /**
      * Differentiate columns of this table and columns from the given column metadatas columns
      * and returns only changed.
+     * @param tableColumns
+     * @param columnMetadatas
      */
     findChangedColumns(tableColumns, columnMetadatas) {
         return columnMetadatas.filter((columnMetadata) => {
@@ -652,7 +688,7 @@ export class SqlServerDriver {
                     this.normalizeIsUnique(columnMetadata) ||
                 (tableColumn.enum &&
                     columnMetadata.enum &&
-                    !OrmUtils.isArraysEqual(tableColumn.enum, columnMetadata.enum.map((val) => val + "")));
+                    !OrmUtils_1.OrmUtils.isArraysEqual(tableColumn.enum, columnMetadata.enum.map((val) => val + "")));
             // DEBUG SECTION
             // if (isColumnChanged) {
             //     console.log("table:", columnMetadata.entityMetadata.tableName)
@@ -726,8 +762,9 @@ export class SqlServerDriver {
     }
     /**
      * Returns true if driver supports RETURNING / OUTPUT statement.
+     * @param returningType
      */
-    isReturningSqlSupported() {
+    isReturningSqlSupported(returningType) {
         if (this.options.options &&
             this.options.options.disableOutputReturning) {
             return false;
@@ -748,6 +785,8 @@ export class SqlServerDriver {
     }
     /**
      * Creates an escaped parameter.
+     * @param parameterName
+     * @param index
      */
     createParameter(parameterName, index) {
         return this.parametersPrefix + index;
@@ -758,29 +797,31 @@ export class SqlServerDriver {
     /**
      * 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.
+     * @param column
+     * @param value
      */
     parametrizeValue(column, value) {
         // if its already MssqlParameter then simply return it
-        if (InstanceChecker.isMssqlParameter(value))
+        if (InstanceChecker_1.InstanceChecker.isMssqlParameter(value))
             return value;
         const normalizedType = this.normalizeType({ type: column.type });
         if (column.length) {
-            return new MssqlParameter(value, normalizedType, 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(value, normalizedType, column.precision, column.scale);
+            return new MssqlParameter_1.MssqlParameter(value, normalizedType, column.precision, column.scale);
         }
         else if (column.precision !== null &&
             column.precision !== undefined) {
-            return new MssqlParameter(value, normalizedType, column.precision);
+            return new MssqlParameter_1.MssqlParameter(value, normalizedType, column.precision);
         }
         else if (column.scale !== null && column.scale !== undefined) {
-            return new MssqlParameter(value, normalizedType, column.scale);
+            return new MssqlParameter_1.MssqlParameter(value, normalizedType, column.scale);
         }
-        return new MssqlParameter(value, normalizedType);
+        return new MssqlParameter_1.MssqlParameter(value, normalizedType);
     }
     /**
      * Recursively wraps values (including those inside FindOperators) into MssqlParameter instances,
@@ -792,9 +833,11 @@ export class SqlServerDriver {
      *
      * This ensures SQL Server receives properly typed parameters for queries involving operators like
      * In, MoreThan, Between, etc.
+     * @param column
+     * @param value
      */
     parametrizeValues(column, value) {
-        if (value instanceof FindOperator) {
+        if (value instanceof FindOperator_1.FindOperator) {
             if (value.type !== "raw") {
                 value.transformValue({
                     to: (v) => this.parametrizeValues(column, v),
@@ -808,13 +851,15 @@ export class SqlServerDriver {
     /**
      * 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.
+     * @param tablePath
+     * @param map
      */
     parametrizeMap(tablePath, map) {
         // find metadata for the given table
-        if (!this.connection.hasMetadata(tablePath))
+        if (!this.dataSource.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);
+        const metadata = this.dataSource.getMetadata(tablePath);
         return Object.keys(map).reduce((newMap, key) => {
             const value = map[key];
             // find column metadata
@@ -828,7 +873,7 @@ export class SqlServerDriver {
     }
     buildTableVariableDeclaration(identifier, columns) {
         const outputColumns = columns.map((column) => {
-            return `${this.escape(column.databaseName)} ${this.createFullType(new TableColumn({
+            return `${this.escape(column.databaseName)} ${this.createFullType(new TableColumn_1.TableColumn({
                 name: column.databaseName,
                 type: this.normalizeType(column),
                 length: column.length,
@@ -846,12 +891,12 @@ export class SqlServerDriver {
      */
     loadDependencies() {
         try {
-            const mssql = this.options.driver || PlatformTools.load("mssql");
+            const mssql = this.options.driver || PlatformTools_1.PlatformTools.load("mssql");
             this.mssql = mssql;
         }
         catch (e) {
             // todo: better error for browser env
-            throw new DriverPackageNotInstalledError("SQL Server", "mssql");
+            throw new DriverPackageNotInstalledError_1.DriverPackageNotInstalledError("SQL Server", "mssql");
         }
     }
     compareColumnType(tableColumn, columnMetadata) {
@@ -883,20 +928,11 @@ export class SqlServerDriver {
     }
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param options
+     * @param credentials
      */
     createPool(options, credentials) {
-        credentials = Object.assign({}, credentials, 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,
-                },
-            };
+        credentials = Object.assign({}, credentials, DriverUtils_1.DriverUtils.buildDriverOptions(credentials)); // todo: do it better way
         // build connection options for the driver
         const connectionOptions = Object.assign({}, {
             connectionTimeout: this.options.connectionTimeout,
@@ -910,7 +946,7 @@ export class SqlServerDriver {
             port: credentials.port,
             user: credentials.username,
             password: credentials.password,
-            authentication: authentication,
+            authentication: credentials.authentication,
         }, options.extra || {});
         // set default useUTC option if it hasn't been set
         if (!connectionOptions.options) {
@@ -926,7 +962,7 @@ export class SqlServerDriver {
         // 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 { logger } = this.dataSource;
             const poolErrorHandler = (options.pool && options.pool.errorHandler) ||
                 ((error) => logger.log("warn", `MSSQL pool raised an error. ${error}`));
             /**
@@ -942,5 +978,5 @@ export class SqlServerDriver {
         });
     }
 }
-
-//# sourceMappingURL=SqlServerDriver.js.map
+exports.SqlServerDriver = SqlServerDriver;
+//# sourceMappingURL=SqlServerDriver.js.map