taon-typeorm 18.0.19 → 18.0.21

package/lib/typeorm/driver/mongodb/MongoDriver.js

@@ -1,161 +1,194 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MongoDriver = void 0;
-var tslib_1 = require("tslib");
-var ConnectionIsNotSetError_1 = require("../../error/ConnectionIsNotSetError");
-var DriverPackageNotInstalledError_1 = require("../../error/DriverPackageNotInstalledError");
-var MongoQueryRunner_1 = require("./MongoQueryRunner");
-var PlatformTools_1 = require("../../platform/PlatformTools");
-var MongoSchemaBuilder_1 = require("../../schema-builder/MongoSchemaBuilder");
-var ObjectUtils_1 = require("../../util/ObjectUtils");
-var ApplyValueTransformers_1 = require("../../util/ApplyValueTransformers");
-var DriverUtils_1 = require("../DriverUtils");
-var error_1 = require("../../error");
-var InstanceChecker_1 = require("../../util/InstanceChecker");
+const ConnectionIsNotSetError_1 = require("../../error/ConnectionIsNotSetError");
+const DriverPackageNotInstalledError_1 = require("../../error/DriverPackageNotInstalledError");
+const MongoQueryRunner_1 = require("./MongoQueryRunner");
+const PlatformTools_1 = require("../../platform/PlatformTools");
+const MongoSchemaBuilder_1 = require("../../schema-builder/MongoSchemaBuilder");
+const ObjectUtils_1 = require("../../util/ObjectUtils");
+const ApplyValueTransformers_1 = require("../../util/ApplyValueTransformers");
+const DriverUtils_1 = require("../DriverUtils");
+const error_1 = require("../../error");
+const InstanceChecker_1 = require("../../util/InstanceChecker");
 /**
  * Organizes communication with MongoDB.
  */
-var MongoDriver = /** @class */ (function () {
+class MongoDriver {
+    connection;
+    // -------------------------------------------------------------------------
+    // Public Properties
+    // -------------------------------------------------------------------------
+    /**
+     * Underlying mongodb library.
+     */
+    mongodb;
+    /**
+     * Mongodb does not require to dynamically create query runner each time,
+     * because it does not have a regular connection pool as RDBMS systems have.
+     */
+    queryRunner;
+    // -------------------------------------------------------------------------
+    // Public Implemented Properties
+    // -------------------------------------------------------------------------
+    /**
+     * Connection options.
+     */
+    options;
+    /**
+     * Master database used to perform all write queries.
+     */
+    database;
+    /**
+     * Indicates if replication is enabled.
+     */
+    isReplicated = false;
+    /**
+     * Indicates if tree tables are supported by this driver.
+     */
+    treeSupport = false;
+    /**
+     * Represent transaction support by this driver
+     */
+    transactionSupport = "none";
+    /**
+     * Mongodb does not need to have column types because they are not used in schema sync.
+     */
+    supportedDataTypes = [];
+    /**
+     * Gets list of spatial column data types.
+     */
+    spatialTypes = [];
+    /**
+     * Gets list of column data types that support length by a driver.
+     */
+    withLengthColumnTypes = [];
+    /**
+     * Gets list of column data types that support precision by a driver.
+     */
+    withPrecisionColumnTypes = [];
+    /**
+     * Gets list of column data types that support scale by a driver.
+     */
+    withScaleColumnTypes = [];
+    /**
+     * Mongodb does not need to have a strong defined mapped column types because they are not used in schema sync.
+     */
+    mappedDataTypes = {
+        createDate: "int",
+        createDateDefault: "",
+        updateDate: "int",
+        updateDateDefault: "",
+        deleteDate: "int",
+        deleteDateNullable: true,
+        version: "int",
+        treeLevel: "int",
+        migrationId: "int",
+        migrationName: "int",
+        migrationTimestamp: "int",
+        cacheId: "int",
+        cacheIdentifier: "int",
+        cacheTime: "int",
+        cacheDuration: "int",
+        cacheQuery: "int",
+        cacheResult: "int",
+        metadataType: "int",
+        metadataDatabase: "int",
+        metadataSchema: "int",
+        metadataTable: "int",
+        metadataName: "int",
+        metadataValue: "int",
+    };
+    /**
+     * 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;
+    /**
+     * No documentation specifying a maximum length for identifiers could be found
+     * for MongoDB.
+     */
+    maxAliasLength;
+    // -------------------------------------------------------------------------
+    // Protected Properties
+    // -------------------------------------------------------------------------
+    /**
+     * Valid mongo connection options
+     * NOTE: Keep sync with MongoConnectionOptions
+     * Sync with http://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html
+     */
+    validOptionNames = [
+        "poolSize",
+        "ssl",
+        "sslValidate",
+        "sslCA",
+        "sslCert",
+        "sslKey",
+        "sslPass",
+        "sslCRL",
+        "autoReconnect",
+        "noDelay",
+        "keepAlive",
+        "keepAliveInitialDelay",
+        "connectTimeoutMS",
+        "family",
+        "socketTimeoutMS",
+        "reconnectTries",
+        "reconnectInterval",
+        "ha",
+        "haInterval",
+        "replicaSet",
+        "secondaryAcceptableLatencyMS",
+        "acceptableLatencyMS",
+        "connectWithNoPrimary",
+        "authSource",
+        "w",
+        "wtimeout",
+        "j",
+        "writeConcern",
+        "forceServerObjectId",
+        "serializeFunctions",
+        "ignoreUndefined",
+        "raw",
+        "bufferMaxEntries",
+        "readPreference",
+        "pkFactory",
+        "promiseLibrary",
+        "readConcern",
+        "maxStalenessSeconds",
+        "loggerLevel",
+        // Do not overwrite BaseDataSourceOptions.logger
+        // "logger",
+        "promoteValues",
+        "promoteBuffers",
+        "promoteLongs",
+        "domainsEnabled",
+        "checkServerIdentity",
+        "validateOptions",
+        "appname",
+        // omit auth - we are building url from username and password
+        // "auth"
+        "authMechanism",
+        "compression",
+        "fsync",
+        "readPreferenceTags",
+        "numberOfRetries",
+        "auto_reconnect",
+        "minSize",
+        "monitorCommands",
+        "useNewUrlParser",
+        "useUnifiedTopology",
+        "autoEncryption",
+        "retryWrites",
+    ];
+    cteCapabilities = {
+        enabled: false,
+    };
     // -------------------------------------------------------------------------
     // Constructor
     // -------------------------------------------------------------------------
-    function MongoDriver(connection) {
+    constructor(connection) {
         this.connection = connection;
-        /**
-         * Indicates if replication is enabled.
-         */
-        this.isReplicated = false;
-        /**
-         * Indicates if tree tables are supported by this driver.
-         */
-        this.treeSupport = false;
-        /**
-         * Represent transaction support by this driver
-         */
-        this.transactionSupport = "none";
-        /**
-         * Mongodb does not need to have column types because they are not used in schema sync.
-         */
-        this.supportedDataTypes = [];
-        /**
-         * Gets list of spatial column data types.
-         */
-        this.spatialTypes = [];
-        /**
-         * Gets list of column data types that support length by a driver.
-         */
-        this.withLengthColumnTypes = [];
-        /**
-         * Gets list of column data types that support precision by a driver.
-         */
-        this.withPrecisionColumnTypes = [];
-        /**
-         * Gets list of column data types that support scale by a driver.
-         */
-        this.withScaleColumnTypes = [];
-        /**
-         * Mongodb does not need to have a strong defined mapped column types because they are not used in schema sync.
-         */
-        this.mappedDataTypes = {
-            createDate: "int",
-            createDateDefault: "",
-            updateDate: "int",
-            updateDateDefault: "",
-            deleteDate: "int",
-            deleteDateNullable: true,
-            version: "int",
-            treeLevel: "int",
-            migrationId: "int",
-            migrationName: "int",
-            migrationTimestamp: "int",
-            cacheId: "int",
-            cacheIdentifier: "int",
-            cacheTime: "int",
-            cacheDuration: "int",
-            cacheQuery: "int",
-            cacheResult: "int",
-            metadataType: "int",
-            metadataDatabase: "int",
-            metadataSchema: "int",
-            metadataTable: "int",
-            metadataName: "int",
-            metadataValue: "int",
-        };
-        // -------------------------------------------------------------------------
-        // Protected Properties
-        // -------------------------------------------------------------------------
-        /**
-         * Valid mongo connection options
-         * NOTE: Keep sync with MongoConnectionOptions
-         * Sync with http://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html
-         */
-        this.validOptionNames = [
-            "poolSize",
-            "ssl",
-            "sslValidate",
-            "sslCA",
-            "sslCert",
-            "sslKey",
-            "sslPass",
-            "sslCRL",
-            "autoReconnect",
-            "noDelay",
-            "keepAlive",
-            "keepAliveInitialDelay",
-            "connectTimeoutMS",
-            "family",
-            "socketTimeoutMS",
-            "reconnectTries",
-            "reconnectInterval",
-            "ha",
-            "haInterval",
-            "replicaSet",
-            "secondaryAcceptableLatencyMS",
-            "acceptableLatencyMS",
-            "connectWithNoPrimary",
-            "authSource",
-            "w",
-            "wtimeout",
-            "j",
-            "writeConcern",
-            "forceServerObjectId",
-            "serializeFunctions",
-            "ignoreUndefined",
-            "raw",
-            "bufferMaxEntries",
-            "readPreference",
-            "pkFactory",
-            "promiseLibrary",
-            "readConcern",
-            "maxStalenessSeconds",
-            "loggerLevel",
-            // Do not overwrite BaseDataSourceOptions.logger
-            // "logger",
-            "promoteValues",
-            "promoteBuffers",
-            "promoteLongs",
-            "domainsEnabled",
-            "checkServerIdentity",
-            "validateOptions",
-            "appname",
-            // omit auth - we are building url from username and password
-            // "auth"
-            "authMechanism",
-            "compression",
-            "fsync",
-            "readPreferenceTags",
-            "numberOfRetries",
-            "auto_reconnect",
-            "minSize",
-            "monitorCommands",
-            "useNewUrlParser",
-            "useUnifiedTopology",
-            "autoEncryption",
-            "retryWrites",
-        ];
-        this.cteCapabilities = {
-            enabled: false,
-        };
         this.options = connection.options;
         // validate options to make sure everything is correct and driver will be able to establish connection
         this.validateOptions(connection.options);
@@ -169,77 +202,71 @@ var MongoDriver = /** @class */ (function () {
     /**
      * Performs connection to the database.
      */
-    MongoDriver.prototype.connect = function () {
-        var _this = this;
-        return new Promise(function (ok, fail) {
-            var options = DriverUtils_1.DriverUtils.buildMongoDBDriverOptions(_this.options);
-            _this.mongodb.MongoClient.connect(_this.buildConnectionUrl(options), _this.buildConnectionOptions(options), function (err, client) {
+    connect() {
+        return new Promise((ok, fail) => {
+            const options = DriverUtils_1.DriverUtils.buildMongoDBDriverOptions(this.options);
+            this.mongodb.MongoClient.connect(this.buildConnectionUrl(options), this.buildConnectionOptions(options), (err, client) => {
                 if (err)
                     return fail(err);
-                _this.queryRunner = new MongoQueryRunner_1.MongoQueryRunner(_this.connection, client);
-                ObjectUtils_1.ObjectUtils.assign(_this.queryRunner, {
-                    manager: _this.connection.manager,
+                this.queryRunner = new MongoQueryRunner_1.MongoQueryRunner(this.connection, client);
+                ObjectUtils_1.ObjectUtils.assign(this.queryRunner, {
+                    manager: this.connection.manager,
                 });
                 ok();
             });
         });
-    };
-    MongoDriver.prototype.afterConnect = function () {
+    }
+    afterConnect() {
         return Promise.resolve();
-    };
+    }
     /**
      * Closes connection with the database.
      */
-    MongoDriver.prototype.disconnect = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _this = this;
-            return tslib_1.__generator(this, function (_a) {
-                return [2 /*return*/, new Promise(function (ok, fail) {
-                        if (!_this.queryRunner)
-                            return fail(new ConnectionIsNotSetError_1.ConnectionIsNotSetError("mongodb"));
-                        var handler = function (err) { return (err ? fail(err) : ok()); };
-                        _this.queryRunner.databaseConnection.close(handler);
-                        _this.queryRunner = undefined;
-                    })];
-            });
+    async disconnect() {
+        return new Promise((ok, fail) => {
+            if (!this.queryRunner)
+                return fail(new ConnectionIsNotSetError_1.ConnectionIsNotSetError("mongodb"));
+            const handler = (err) => (err ? fail(err) : ok());
+            this.queryRunner.databaseConnection.close(handler);
+            this.queryRunner = undefined;
         });
-    };
+    }
     /**
      * Creates a schema builder used to build and sync a schema.
      */
-    MongoDriver.prototype.createSchemaBuilder = function () {
+    createSchemaBuilder() {
         return new MongoSchemaBuilder_1.MongoSchemaBuilder(this.connection);
-    };
+    }
     /**
      * Creates a query runner used to execute database queries.
      */
-    MongoDriver.prototype.createQueryRunner = function (mode) {
+    createQueryRunner(mode) {
         return this.queryRunner;
-    };
+    }
     /**
      * Replaces parameters in the given sql with special escaping character
      * and an array of parameter names to be passed to a query.
      */
-    MongoDriver.prototype.escapeQueryWithParameters = function (sql, parameters, nativeParameters) {
-        throw new error_1.TypeORMError("This operation is not supported by Mongodb driver.");
-    };
+    escapeQueryWithParameters(sql, parameters, nativeParameters) {
+        throw new error_1.TypeORMError(`This operation is not supported by Mongodb driver.`);
+    }
     /**
      * Escapes a column name.
      */
-    MongoDriver.prototype.escape = function (columnName) {
+    escape(columnName) {
         return columnName;
-    };
+    }
     /**
      * Build full table name with database name, schema name and table name.
      * E.g. myDB.mySchema.myTable
      */
-    MongoDriver.prototype.buildTableName = function (tableName, schema, database) {
+    buildTableName(tableName, schema, database) {
         return tableName;
-    };
+    }
     /**
      * Parse a target table name or other types and return a normalized table definition.
      */
-    MongoDriver.prototype.parseTableName = function (target) {
+    parseTableName(target) {
         if (InstanceChecker_1.InstanceChecker.isEntityMetadata(target)) {
             return {
                 tableName: target.tableName,
@@ -258,158 +285,158 @@ var MongoDriver = /** @class */ (function () {
         return {
             tableName: target,
         };
-    };
+    }
     /**
      * Prepares given value to a value to be persisted, based on its column type and metadata.
      */
-    MongoDriver.prototype.preparePersistentValue = function (value, columnMetadata) {
+    preparePersistentValue(value, columnMetadata) {
         if (columnMetadata.transformer)
             value = ApplyValueTransformers_1.ApplyValueTransformers.transformTo(columnMetadata.transformer, value);
         return value;
-    };
+    }
     /**
      * Prepares given value to a value to be persisted, based on its column type or metadata.
      */
-    MongoDriver.prototype.prepareHydratedValue = function (value, columnMetadata) {
+    prepareHydratedValue(value, columnMetadata) {
         if (columnMetadata.transformer)
             value = ApplyValueTransformers_1.ApplyValueTransformers.transformFrom(columnMetadata.transformer, value);
         return value;
-    };
+    }
     /**
      * Creates a database type from a given column metadata.
      */
-    MongoDriver.prototype.normalizeType = function (column) {
-        throw new error_1.TypeORMError("MongoDB is schema-less, not supported by this driver.");
-    };
+    normalizeType(column) {
+        throw new error_1.TypeORMError(`MongoDB is schema-less, not supported by this driver.`);
+    }
     /**
      * Normalizes "default" value of the column.
      */
-    MongoDriver.prototype.normalizeDefault = function (columnMetadata) {
-        throw new error_1.TypeORMError("MongoDB is schema-less, not supported by this driver.");
-    };
+    normalizeDefault(columnMetadata) {
+        throw new error_1.TypeORMError(`MongoDB is schema-less, not supported by this driver.`);
+    }
     /**
      * Normalizes "isUnique" value of the column.
      */
-    MongoDriver.prototype.normalizeIsUnique = function (column) {
-        throw new error_1.TypeORMError("MongoDB is schema-less, not supported by this driver.");
-    };
+    normalizeIsUnique(column) {
+        throw new error_1.TypeORMError(`MongoDB is schema-less, not supported by this driver.`);
+    }
     /**
      * Calculates column length taking into account the default length values.
      */
-    MongoDriver.prototype.getColumnLength = function (column) {
-        throw new error_1.TypeORMError("MongoDB is schema-less, not supported by this driver.");
-    };
+    getColumnLength(column) {
+        throw new error_1.TypeORMError(`MongoDB is schema-less, not supported by this driver.`);
+    }
     /**
      * Normalizes "default" value of the column.
      */
-    MongoDriver.prototype.createFullType = function (column) {
-        throw new error_1.TypeORMError("MongoDB is schema-less, not supported by this driver.");
-    };
+    createFullType(column) {
+        throw new error_1.TypeORMError(`MongoDB is schema-less, not supported by this driver.`);
+    }
     /**
      * Obtains a new database connection to a master server.
      * Used for replication.
      * If replication is not setup then returns default connection's database connection.
      */
-    MongoDriver.prototype.obtainMasterConnection = function () {
+    obtainMasterConnection() {
         return Promise.resolve();
-    };
+    }
     /**
      * 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.
      */
-    MongoDriver.prototype.obtainSlaveConnection = function () {
+    obtainSlaveConnection() {
         return Promise.resolve();
-    };
+    }
     /**
      * Creates generated map of values generated or returned by database after INSERT query.
      */
-    MongoDriver.prototype.createGeneratedMap = function (metadata, insertedId) {
+    createGeneratedMap(metadata, insertedId) {
         return metadata.objectIdColumn.createValueMap(insertedId);
-    };
+    }
     /**
      * Differentiate columns of this table and columns from the given column metadatas columns
      * and returns only changed.
      */
-    MongoDriver.prototype.findChangedColumns = function (tableColumns, columnMetadatas) {
-        throw new error_1.TypeORMError("MongoDB is schema-less, not supported by this driver.");
-    };
+    findChangedColumns(tableColumns, columnMetadatas) {
+        throw new error_1.TypeORMError(`MongoDB is schema-less, not supported by this driver.`);
+    }
     /**
      * Returns true if driver supports RETURNING / OUTPUT statement.
      */
-    MongoDriver.prototype.isReturningSqlSupported = function () {
+    isReturningSqlSupported() {
         return false;
-    };
+    }
     /**
      * Returns true if driver supports uuid values generation on its own.
      */
-    MongoDriver.prototype.isUUIDGenerationSupported = function () {
+    isUUIDGenerationSupported() {
         return false;
-    };
+    }
     /**
      * Returns true if driver supports fulltext indices.
      */
-    MongoDriver.prototype.isFullTextColumnTypeSupported = function () {
+    isFullTextColumnTypeSupported() {
         return false;
-    };
+    }
     /**
      * Creates an escaped parameter.
      */
-    MongoDriver.prototype.createParameter = function (parameterName, index) {
+    createParameter(parameterName, index) {
         return "";
-    };
+    }
     // -------------------------------------------------------------------------
     // Protected Methods
     // -------------------------------------------------------------------------
     /**
      * Validate driver options to make sure everything is correct and driver will be able to establish connection.
      */
-    MongoDriver.prototype.validateOptions = function (options) {
+    validateOptions(options) {
         // todo: fix
         // if (!options.url) {
         //     if (!options.database)
         //         throw new DriverOptionNotSetError("database");
         // }
-    };
+    }
     /**
      * Loads all driver dependencies.
      */
-    MongoDriver.prototype.loadDependencies = function () {
+    loadDependencies() {
         try {
-            var mongodb = this.options.driver || PlatformTools_1.PlatformTools.load("mongodb");
+            const mongodb = this.options.driver || PlatformTools_1.PlatformTools.load("mongodb");
             this.mongodb = mongodb;
         }
         catch (e) {
             throw new DriverPackageNotInstalledError_1.DriverPackageNotInstalledError("MongoDB", "mongodb");
         }
-    };
+    }
     /**
      * Builds connection url that is passed to underlying driver to perform connection to the mongodb database.
      */
-    MongoDriver.prototype.buildConnectionUrl = function (options) {
-        var schemaUrlPart = options.type.toLowerCase();
-        var credentialsUrlPart = options.username && options.password
-            ? "".concat(options.username, ":").concat(options.password, "@")
+    buildConnectionUrl(options) {
+        const schemaUrlPart = options.type.toLowerCase();
+        const credentialsUrlPart = options.username && options.password
+            ? `${options.username}:${options.password}@`
             : "";
-        var portUrlPart = schemaUrlPart === "mongodb+srv" ? "" : ":".concat(options.port || "27017");
-        var connectionString;
+        const portUrlPart = schemaUrlPart === "mongodb+srv" ? "" : `:${options.port || "27017"}`;
+        let connectionString;
         if (options.replicaSet) {
-            connectionString = "".concat(schemaUrlPart, "://").concat(credentialsUrlPart).concat(options.hostReplicaSet ||
+            connectionString = `${schemaUrlPart}://${credentialsUrlPart}${options.hostReplicaSet ||
                 options.host + portUrlPart ||
-                "127.0.0.1" + portUrlPart, "/").concat(options.database || "", "?replicaSet=").concat(options.replicaSet).concat(options.tls ? "&tls=true" : "");
+                "127.0.0.1" + portUrlPart}/${options.database || ""}?replicaSet=${options.replicaSet}${options.tls ? "&tls=true" : ""}`;
         }
         else {
-            connectionString = "".concat(schemaUrlPart, "://").concat(credentialsUrlPart).concat(options.host || "127.0.0.1").concat(portUrlPart, "/").concat(options.database || "").concat(options.tls ? "?tls=true" : "");
+            connectionString = `${schemaUrlPart}://${credentialsUrlPart}${options.host || "127.0.0.1"}${portUrlPart}/${options.database || ""}${options.tls ? "?tls=true" : ""}`;
         }
         return connectionString;
-    };
+    }
     /**
      * Build connection options from MongoConnectionOptions
      */
-    MongoDriver.prototype.buildConnectionOptions = function (options) {
-        var mongoOptions = {};
-        for (var index = 0; index < this.validOptionNames.length; index++) {
-            var optionName = this.validOptionNames[index];
+    buildConnectionOptions(options) {
+        const mongoOptions = {};
+        for (let index = 0; index < this.validOptionNames.length; index++) {
+            const optionName = this.validOptionNames[index];
             if (options.extra && optionName in options.extra) {
                 mongoOptions[optionName] = options.extra[optionName];
             }
@@ -418,9 +445,8 @@ var MongoDriver = /** @class */ (function () {
             }
         }
         return mongoOptions;
-    };
-    return MongoDriver;
-}());
+    }
+}
 exports.MongoDriver = MongoDriver;
 //#endregion
 //# sourceMappingURL=MongoDriver.js.map