typeorm 1.0.0-beta.1 → 1.0.0-beta.2

package/browser/driver/sqlserver/SqlServerDriver.js

@@ -13,14 +13,31 @@ const DateUtils_1 = require("../../util/DateUtils");
 const InstanceChecker_1 = require("../../util/InstanceChecker");
 const OrmUtils_1 = require("../../util/OrmUtils");
 const DriverUtils_1 = require("../DriverUtils");
+const validate_isolation_level_1 = require("../validate-isolation-level");
 const MssqlParameter_1 = require("./MssqlParameter");
 const SqlServerQueryRunner_1 = require("./SqlServerQueryRunner");
 /**
  * Organizes communication with SQL Server DBMS.
  */
 class SqlServerDriver {
+    // -------------------------------------------------------------------------
+    // Static Properties
+    // -------------------------------------------------------------------------
+    /**
+     * Transaction isolation levels supported by this driver.
+     *
+     * @see https://learn.microsoft.com/en-us/sql/t-sql/statements/set-transaction-isolation-level-transact-sql
+     */
+    static { this.supportedIsolationLevels = [
+        "READ UNCOMMITTED",
+        "READ COMMITTED",
+        "REPEATABLE READ",
+        "SERIALIZABLE",
+        "SNAPSHOT",
+    ]; }
     /**
      * DataSource used by the driver.
+     *
      * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
      */
     get connection() {
@@ -30,6 +47,10 @@ class SqlServerDriver {
     // Constructor
     // -------------------------------------------------------------------------
     constructor(dataSource) {
+        /**
+         * Isolation levels supported by this driver.
+         */
+        this.supportedIsolationLevels = SqlServerDriver.supportedIsolationLevels;
         /**
          * Pool for slave databases.
          * Used in replication.
@@ -49,6 +70,7 @@ 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 = [
@@ -180,6 +202,7 @@ class SqlServerDriver {
         };
         /**
          * 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
          */
         this.maxAliasLength = 128;
@@ -221,17 +244,11 @@ class SqlServerDriver {
         }
         if (!this.database || !this.searchSchema) {
             const queryRunner = this.createQueryRunner("master");
-            if (!this.database) {
-                this.database = await queryRunner.getCurrentDatabase();
-            }
-            if (!this.searchSchema) {
-                this.searchSchema = await queryRunner.getCurrentSchema();
-            }
+            this.database ??= await queryRunner.getCurrentDatabase();
+            this.searchSchema ??= await queryRunner.getCurrentSchema();
             await queryRunner.release();
         }
-        if (!this.schema) {
-            this.schema = this.searchSchema;
-        }
+        this.schema ??= this.searchSchema;
     }
     /**
      * Makes any action after connection (e.g. create extensions in Postgres driver).
@@ -253,6 +270,7 @@ class SqlServerDriver {
     }
     /**
      * Closes connection pool.
+     *
      * @param pool
      */
     async closePool(pool) {
@@ -268,6 +286,7 @@ class SqlServerDriver {
     }
     /**
      * Creates a query runner used to execute database queries.
+     *
      * @param mode
      */
     createQueryRunner(mode) {
@@ -276,6 +295,7 @@ class SqlServerDriver {
     /**
      * 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
      */
@@ -311,6 +331,7 @@ class SqlServerDriver {
     }
     /**
      * Escapes a column name.
+     *
      * @param columnName
      */
     escape(columnName) {
@@ -319,6 +340,7 @@ class SqlServerDriver {
     /**
      * Build full table name with database name, schema name and table name.
      * E.g. myDB.mySchema.myTable
+     *
      * @param tableName
      * @param schema
      * @param database
@@ -338,6 +360,7 @@ class SqlServerDriver {
     }
     /**
      * Parse a target table name or other types and return a normalized table definition.
+     *
      * @param target
      */
     parseTableName(target) {
@@ -346,26 +369,26 @@ class SqlServerDriver {
         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,
+                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 ||
+                database: target.referencedDatabase ??
+                    parsed.database ??
                     driverDatabase,
-                schema: target.referencedSchema || parsed.schema || driverSchema,
+                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,
+                database: target.database ?? driverDatabase,
+                schema: target.schema ?? driverSchema,
                 tableName: target.tableName,
             };
         }
@@ -394,6 +417,7 @@ class SqlServerDriver {
     }
     /**
      * Prepares given value to a value to be persisted, based on its column type and metadata.
+     *
      * @param value
      * @param columnMetadata
      */
@@ -441,6 +465,7 @@ class SqlServerDriver {
     }
     /**
      * Prepares given value to a value to be persisted, based on its column type or metadata.
+     *
      * @param value
      * @param columnMetadata
      */
@@ -496,6 +521,7 @@ class SqlServerDriver {
     }
     /**
      * Creates a database type from a given column metadata.
+     *
      * @param column
      * @param column.type
      * @param column.length
@@ -544,6 +570,7 @@ class SqlServerDriver {
     }
     /**
      * Normalizes "default" value of the column.
+     *
      * @param columnMetadata
      */
     normalizeDefault(columnMetadata) {
@@ -571,6 +598,7 @@ class SqlServerDriver {
     }
     /**
      * Normalizes "isUnique" value of the column.
+     *
      * @param column
      */
     normalizeIsUnique(column) {
@@ -578,6 +606,7 @@ class SqlServerDriver {
     }
     /**
      * Returns default column lengths, which is required on column creation.
+     *
      * @param column
      */
     getColumnLength(column) {
@@ -591,6 +620,7 @@ class SqlServerDriver {
     }
     /**
      * Creates column type definition including length, precision and scale
+     *
      * @param column
      */
     createFullType(column) {
@@ -645,6 +675,7 @@ class SqlServerDriver {
     }
     /**
      * Creates generated map of values generated or returned by database after INSERT query.
+     *
      * @param metadata
      * @param insertResult
      */
@@ -662,6 +693,7 @@ class SqlServerDriver {
     /**
      * Differentiate columns of this table and columns from the given column metadatas columns
      * and returns only changed.
+     *
      * @param tableColumns
      * @param columnMetadatas
      */
@@ -762,11 +794,11 @@ class SqlServerDriver {
     }
     /**
      * Returns true if driver supports RETURNING / OUTPUT statement.
+     *
      * @param returningType
      */
     isReturningSqlSupported(returningType) {
-        if (this.options.options &&
-            this.options.options.disableOutputReturning) {
+        if (this.options.options?.disableOutputReturning) {
             return false;
         }
         return true;
@@ -785,6 +817,7 @@ class SqlServerDriver {
     }
     /**
      * Creates an escaped parameter.
+     *
      * @param parameterName
      * @param index
      */
@@ -797,6 +830,7 @@ 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
      */
@@ -833,6 +867,7 @@ class SqlServerDriver {
      *
      * This ensures SQL Server receives properly typed parameters for queries involving operators like
      * In, MoreThan, Between, etc.
+     *
      * @param column
      * @param value
      */
@@ -851,6 +886,7 @@ 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
      */
@@ -891,7 +927,7 @@ class SqlServerDriver {
      */
     loadDependencies() {
         try {
-            const mssql = this.options.driver || PlatformTools_1.PlatformTools.load("mssql");
+            const mssql = this.options.driver ?? PlatformTools_1.PlatformTools.load("mssql");
             this.mssql = mssql;
         }
         catch (e) {
@@ -928,18 +964,33 @@ class SqlServerDriver {
     }
     /**
      * Creates a new connection pool for a given database credentials.
+     *
      * @param options
      * @param credentials
      */
     createPool(options, credentials) {
         credentials = Object.assign({}, credentials, DriverUtils_1.DriverUtils.buildDriverOptions(credentials)); // todo: do it better way
+        let isolationLevel;
+        if (options.options?.isolationLevel) {
+            (0, validate_isolation_level_1.validateIsolationLevel)(SqlServerDriver.supportedIsolationLevels, options.options.isolationLevel);
+            isolationLevel = this.convertIsolationLevel(options.options.isolationLevel);
+        }
+        let connectionIsolationLevel;
+        if (options.options?.connectionIsolationLevel) {
+            (0, validate_isolation_level_1.validateIsolationLevel)(SqlServerDriver.supportedIsolationLevels, options.options.connectionIsolationLevel);
+            connectionIsolationLevel = this.convertIsolationLevel(options.options.connectionIsolationLevel);
+        }
         // 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,
+            connectionTimeout: options.connectionTimeout,
+            requestTimeout: options.requestTimeout,
+            stream: options.stream,
+            pool: options.pool,
+            options: {
+                ...options.options,
+                isolationLevel,
+                connectionIsolationLevel,
+            },
         }, {
             server: credentials.host,
             database: credentials.database,
@@ -947,7 +998,7 @@ class SqlServerDriver {
             user: credentials.username,
             password: credentials.password,
             authentication: credentials.authentication,
-        }, options.extra || {});
+        }, options.extra ?? {});
         // set default useUTC option if it hasn't been set
         if (!connectionOptions.options) {
             connectionOptions.options = { useUTC: false };
@@ -963,7 +1014,7 @@ class SqlServerDriver {
         return new Promise((ok, fail) => {
             const pool = new this.mssql.ConnectionPool(connectionOptions);
             const { logger } = this.dataSource;
-            const poolErrorHandler = (options.pool && options.pool.errorHandler) ||
+            const poolErrorHandler = 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
@@ -977,6 +1028,29 @@ class SqlServerDriver {
             });
         });
     }
+    /**
+     * Converts string literal of isolation level to enum.
+     * The underlying mssql driver requires an enum for the isolation level.
+     *
+     * @param isolation
+     */
+    convertIsolationLevel(isolation) {
+        const ISOLATION_LEVEL = this.mssql.ISOLATION_LEVEL;
+        switch (isolation) {
+            case "READ UNCOMMITTED":
+                return ISOLATION_LEVEL.READ_UNCOMMITTED;
+            case "REPEATABLE READ":
+                return ISOLATION_LEVEL.REPEATABLE_READ;
+            case "SERIALIZABLE":
+                return ISOLATION_LEVEL.SERIALIZABLE;
+            case "SNAPSHOT":
+                return ISOLATION_LEVEL.SNAPSHOT;
+            case "READ COMMITTED":
+                return ISOLATION_LEVEL.READ_COMMITTED;
+            default:
+                throw new error_1.TypeORMError(`Unknown isolation level "${isolation}"`);
+        }
+    }
 }
 exports.SqlServerDriver = SqlServerDriver;
 //# sourceMappingURL=SqlServerDriver.js.map