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

package/driver/mysql/MysqlDriver.js

@@ -17,10 +17,17 @@ const MysqlQueryRunner_1 = require("./MysqlQueryRunner");
  * Organizes communication with MySQL DBMS.
  */
 class MysqlDriver {
+    /**
+     * 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) {
         /**
          * Indicates if replication is enabled.
          */
@@ -35,7 +42,6 @@ class MysqlDriver {
         this.transactionSupport = "nested";
         /**
          * Gets list of supported column data types by a driver.
-         *
          * @see https://www.tutorialspoint.com/mysql/mysql-data-types.htm
          * @see https://dev.mysql.com/doc/refman/8.0/en/data-types.html
          */
@@ -129,17 +135,6 @@ class MysqlDriver {
             "varbinary",
             "vector",
         ];
-        /**
-         * Gets list of column data types that support the unsigned attribute by a driver.
-         */
-        this.unsignedColumnTypes = [
-            "tinyint",
-            "smallint",
-            "mediumint",
-            "int",
-            "integer",
-            "bigint",
-        ];
         /**
          * Gets list of column data types that support precision by a driver.
          */
@@ -222,13 +217,6 @@ class MysqlDriver {
             time: { precision: 0 },
             datetime: { precision: 0 },
             timestamp: { precision: 0 },
-            bit: { width: 1 },
-            int: { width: 11 },
-            integer: { width: 11 },
-            tinyint: { width: 4 },
-            smallint: { width: 6 },
-            mediumint: { width: 9 },
-            bigint: { width: 20 },
         };
         /**
          * Max length allowed by MySQL for aliases.
@@ -249,10 +237,10 @@ class MysqlDriver {
         };
         /** MariaDB supports uuid type for version 10.7.0 and up */
         this.uuidColumnTypeSuported = false;
-        this.connection = connection;
+        this.dataSource = dataSource;
         this.options = {
-            legacySpatialSupport: true,
-            ...connection.options,
+            legacySpatialSupport: false,
+            ...dataSource.options,
         };
         this.isReplicated = this.options.replication ? true : false;
         // load mysql package
@@ -350,10 +338,11 @@ class MysqlDriver {
      * Creates a schema builder used to build and sync a schema.
      */
     createSchemaBuilder() {
-        return new RdbmsSchemaBuilder_1.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 MysqlQueryRunner_1.MysqlQueryRunner(this, mode);
@@ -361,9 +350,11 @@ class MysqlDriver {
     /**
      * 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];
         sql = sql.replace(/:(\.\.\.)?([A-Za-z0-9_.]+)/g, (full, isArray, key) => {
@@ -389,13 +380,17 @@ class MysqlDriver {
     }
     /**
      * 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];
@@ -406,6 +401,7 @@ class MysqlDriver {
     }
     /**
      * Parse a target table name or other types and return a normalized table definition.
+     * @param target
      */
     parseTableName(target) {
         const driverDatabase = this.database;
@@ -443,15 +439,10 @@ class MysqlDriver {
             tableName: parts.length > 1 ? parts[1] : parts[0],
         };
     }
-    /**
-     * Checks if the driver is using mysql2 package.
-     */
-    isUsingMysql2() {
-        // Check which package was actually loaded during initialization
-        return this.loadedConnectorPackage === "mysql2";
-    }
     /**
      * 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)
@@ -498,6 +489,8 @@ class MysqlDriver {
     }
     /**
      * 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)
@@ -519,29 +512,20 @@ class MysqlDriver {
             });
         }
         else if (columnMetadata.type === "json") {
-            // mysql2 returns JSON values already parsed, but may still be a string
-            // if the JSON value itself is a string (e.g., "\"hello\"")
-            // mysql (classic) always returns JSON as strings that need parsing
-            if (this.isUsingMysql2()) {
-                // With mysql2, only parse if it's a valid JSON string representation
-                // but not if it's already an object or a JSON primitive
-                if (typeof value === "string") {
-                    try {
-                        // Try to parse it - if it fails, it's already a parsed string value
-                        const parsed = JSON.parse(value);
-                        value = parsed;
-                    }
-                    catch {
-                        // It's a string that's not valid JSON, which means mysql2
-                        // already parsed it and it's just a string value
-                        // Keep value as is
-                    }
+            // Only parse if it's a valid JSON string representation,
+            // but not if it's already an object or a JSON primitive.
+            // If it's not a string, mysql2 has already parsed it correctly.
+            if (typeof value === "string") {
+                try {
+                    // Try to parse it - if it fails, it's already a parsed string value
+                    const parsed = JSON.parse(value);
+                    value = parsed;
+                }
+                catch {
+                    // It's a string that's not valid JSON, which means mysql2
+                    // already parsed it and it's just a string value
+                    // Keep value as is
                 }
-                // If it's not a string, mysql2 has already parsed it correctly
-            }
-            else {
-                // Classic mysql always returns JSON as strings
-                value = typeof value === "string" ? JSON.parse(value) : value;
             }
         }
         else if (columnMetadata.type === "time") {
@@ -574,6 +558,11 @@ class MysqlDriver {
     }
     /**
      * 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") {
@@ -585,7 +574,8 @@ class MysqlDriver {
         else if (column.type === Date) {
             return "datetime";
         }
-        else if (column.type === Buffer) {
+        else if (typeof column.type === "function" &&
+            column.type.prototype instanceof Uint8Array) {
             return "blob";
         }
         else if (column.type === Boolean) {
@@ -638,6 +628,7 @@ class MysqlDriver {
     }
     /**
      * Normalizes "default" value of the column.
+     * @param columnMetadata
      */
     normalizeDefault(columnMetadata) {
         const defaultValue = columnMetadata.default;
@@ -670,6 +661,7 @@ class MysqlDriver {
     }
     /**
      * Normalizes "isUnique" value of the column.
+     * @param column
      */
     normalizeIsUnique(column) {
         return column.entityMetadata.indices.some((idx) => idx.isUnique &&
@@ -678,6 +670,7 @@ class MysqlDriver {
     }
     /**
      * Returns default column lengths, which is required on column creation.
+     * @param column
      */
     getColumnLength(column) {
         if (column.length)
@@ -703,6 +696,7 @@ class MysqlDriver {
     }
     /**
      * Creates column type definition including length, precision and scale
+     * @param column
      */
     createFullType(column) {
         let type = column.type;
@@ -710,9 +704,6 @@ class MysqlDriver {
         if (this.getColumnLength(column)) {
             type += `(${this.getColumnLength(column)})`;
         }
-        else if (column.width) {
-            type += `(${column.width})`;
-        }
         else if (column.precision !== null &&
             column.precision !== undefined &&
             column.scale !== null &&
@@ -736,14 +727,22 @@ class MysqlDriver {
         return new Promise((ok, fail) => {
             if (this.poolCluster) {
                 this.poolCluster.getConnection("MASTER", (err, dbConnection) => {
-                    err
-                        ? fail(err)
-                        : ok(this.prepareDbConnection(dbConnection));
+                    if (err) {
+                        fail(err);
+                    }
+                    else {
+                        ok(this.prepareDbConnection(dbConnection));
+                    }
                 });
             }
             else if (this.pool) {
                 this.pool.getConnection((err, dbConnection) => {
-                    err ? fail(err) : ok(this.prepareDbConnection(dbConnection));
+                    if (err) {
+                        fail(err);
+                    }
+                    else {
+                        ok(this.prepareDbConnection(dbConnection));
+                    }
                 });
             }
             else {
@@ -761,12 +760,20 @@ class MysqlDriver {
             return this.obtainMasterConnection();
         return new Promise((ok, fail) => {
             this.poolCluster.getConnection("SLAVE*", (err, dbConnection) => {
-                err ? fail(err) : ok(this.prepareDbConnection(dbConnection));
+                if (err) {
+                    fail(err);
+                }
+                else {
+                    ok(this.prepareDbConnection(dbConnection));
+                }
             });
         });
     }
     /**
      * Creates generated map of values generated or returned by database after INSERT query.
+     * @param metadata
+     * @param insertResult
+     * @param entityIndex
      */
     createGeneratedMap(metadata, insertResult, entityIndex) {
         if (!insertResult) {
@@ -800,6 +807,8 @@ class MysqlDriver {
     /**
      * 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) => {
@@ -809,12 +818,10 @@ class MysqlDriver {
             const isColumnChanged = tableColumn.name !== columnMetadata.databaseName ||
                 this.isColumnDataTypeChanged(tableColumn, columnMetadata) ||
                 tableColumn.length !== this.getColumnLength(columnMetadata) ||
-                tableColumn.width !== columnMetadata.width ||
                 (columnMetadata.precision !== undefined &&
                     tableColumn.precision !== columnMetadata.precision) ||
                 (columnMetadata.scale !== undefined &&
                     tableColumn.scale !== columnMetadata.scale) ||
-                tableColumn.zerofill !== columnMetadata.zerofill ||
                 tableColumn.unsigned !== columnMetadata.unsigned ||
                 tableColumn.asExpression !== columnMetadata.asExpression ||
                 tableColumn.generatedType !== columnMetadata.generatedType ||
@@ -832,99 +839,12 @@ class MysqlDriver {
                     this.normalizeIsUnique(columnMetadata) ||
                 (columnMetadata.generationStrategy !== "uuid" &&
                     tableColumn.isGenerated !== columnMetadata.isGenerated);
-            // 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),
-            //     )
-            //     console.log(
-            //         "length:",
-            //         tableColumn.length,
-            //         columnMetadata.length,
-            //     )
-            //     console.log("width:", tableColumn.width, columnMetadata.width)
-            //     console.log(
-            //         "precision:",
-            //         tableColumn.precision,
-            //         columnMetadata.precision,
-            //     )
-            //     console.log("scale:", tableColumn.scale, columnMetadata.scale)
-            //     console.log(
-            //         "zerofill:",
-            //         tableColumn.zerofill,
-            //         columnMetadata.zerofill,
-            //     )
-            //     console.log(
-            //         "unsigned:",
-            //         tableColumn.unsigned,
-            //         columnMetadata.unsigned,
-            //     )
-            //     console.log(
-            //         "asExpression:",
-            //         tableColumn.asExpression,
-            //         columnMetadata.asExpression,
-            //     )
-            //     console.log(
-            //         "generatedType:",
-            //         tableColumn.generatedType,
-            //         columnMetadata.generatedType,
-            //     )
-            //     console.log(
-            //         "comment:",
-            //         tableColumn.comment,
-            //         this.escapeComment(columnMetadata.comment),
-            //     )
-            //     console.log(
-            //         "default:",
-            //         tableColumn.default,
-            //         this.normalizeDefault(columnMetadata),
-            //     )
-            //     console.log("enum:", tableColumn.enum, columnMetadata.enum)
-            //     console.log(
-            //         "default changed:",
-            //         !this.compareDefaultValues(
-            //             this.normalizeDefault(columnMetadata),
-            //             tableColumn.default,
-            //         ),
-            //     )
-            //     console.log(
-            //         "isPrimary:",
-            //         tableColumn.isPrimary,
-            //         columnMetadata.isPrimary,
-            //     )
-            //     console.log(
-            //         "isNullable changed:",
-            //         !this.compareNullableValues(columnMetadata, tableColumn),
-            //     )
-            //     console.log(
-            //         "isUnique:",
-            //         tableColumn.isUnique,
-            //         this.normalizeIsUnique(columnMetadata),
-            //     )
-            //     console.log(
-            //         "isGenerated:",
-            //         tableColumn.isGenerated,
-            //         columnMetadata.isGenerated,
-            //     )
-            //     console.log(
-            //         columnMetadata.generationStrategy !== "uuid" &&
-            //             tableColumn.isGenerated !== columnMetadata.isGenerated,
-            //     )
-            //     console.log("==========================================")
-            // }
             return isColumnChanged;
         });
     }
     /**
      * Returns true if driver supports RETURNING / OUTPUT statement.
+     * @param returningType
      */
     isReturningSqlSupported(returningType) {
         return this._isReturningSqlSupported[returningType];
@@ -943,6 +863,8 @@ class MysqlDriver {
     }
     /**
      * Creates an escaped parameter.
+     * @param parameterName
+     * @param index
      */
     createParameter(parameterName, index) {
         return "?";
@@ -954,60 +876,17 @@ class MysqlDriver {
      * Loads all driver dependencies.
      */
     loadDependencies() {
-        // Warn if driver is provided directly but connectorPackage is not specified
-        if (this.options.driver && !this.options.connectorPackage) {
-            console.warn("Warning: MySQL driver instance provided directly without specifying connectorPackage. " +
-                "This may lead to unexpected JSON parsing behavior differences between mysql and mysql2. " +
-                "Consider explicitly setting connectorPackage: 'mysql' or 'mysql2' in your configuration.");
-        }
-        const connectorPackage = this.options.connectorPackage ?? "mysql";
-        const fallbackConnectorPackage = connectorPackage === "mysql"
-            ? "mysql2"
-            : "mysql";
         try {
-            // try to load first supported package
-            const mysql = this.options.driver || PlatformTools_1.PlatformTools.load(connectorPackage);
-            this.mysql = mysql;
-            /*
-             * Some frameworks (such as Jest) may mess up Node's require cache and provide garbage for the 'mysql' module
-             * if it was not installed. We check that the object we got actually contains something otherwise we treat
-             * it as if the `require` call failed.
-             *
-             * @see https://github.com/typeorm/typeorm/issues/1373
-             */
-            if (Object.keys(this.mysql).length === 0) {
-                throw new error_1.TypeORMError(`'${connectorPackage}' was found but it is empty. Falling back to '${fallbackConnectorPackage}'.`);
-            }
-            // Successfully loaded the requested package
-            // If driver was provided directly, try to detect which package it is
-            if (this.options.driver && !this.options.connectorPackage) {
-                // Try to detect if it's mysql2 based on unique properties
-                if (this.mysql.version ||
-                    (this.mysql.Connection &&
-                        this.mysql.Connection.prototype.execute)) {
-                    this.loadedConnectorPackage = "mysql2";
-                }
-                else {
-                    this.loadedConnectorPackage = "mysql";
-                }
-            }
-            else {
-                this.loadedConnectorPackage = connectorPackage;
-            }
+            this.mysql = this.options.driver || PlatformTools_1.PlatformTools.load("mysql2");
         }
         catch (e) {
-            try {
-                this.mysql = PlatformTools_1.PlatformTools.load(fallbackConnectorPackage); // try to load second supported package
-                // Successfully loaded the fallback package
-                this.loadedConnectorPackage = fallbackConnectorPackage;
-            }
-            catch (e) {
-                throw new DriverPackageNotInstalledError_1.DriverPackageNotInstalledError("Mysql", connectorPackage);
-            }
+            throw new DriverPackageNotInstalledError_1.DriverPackageNotInstalledError("Mysql", "mysql2");
         }
     }
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param options
+     * @param credentials
      */
     createConnectionOptions(options, credentials) {
         credentials = Object.assign({}, credentials, DriverUtils_1.DriverUtils.buildDriverOptions(credentials)); // todo: do it better way
@@ -1044,6 +923,7 @@ class MysqlDriver {
     }
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param connectionOptions
      */
     createPool(connectionOptions) {
         // create a connection pool
@@ -1062,9 +942,10 @@ class MysqlDriver {
     }
     /**
      * Attaches all required base handlers to a database connection, such as the unhandled error handler.
+     * @param connection
      */
     prepareDbConnection(connection) {
-        const { logger } = this.connection;
+        const { logger } = this.dataSource;
         /*
          * Attaching an error handler to connection errors is essential, as, otherwise, errors raised will go unhandled and
          * cause the hosting app to crash.
@@ -1076,6 +957,8 @@ class MysqlDriver {
     }
     /**
      * Checks if "DEFAULT" values in the column metadata and in the database are equal.
+     * @param columnMetadataValue
+     * @param databaseValue
      */
     compareDefaultValues(columnMetadataValue, databaseValue) {
         if (typeof columnMetadataValue === "string" &&
@@ -1098,6 +981,7 @@ class MysqlDriver {
     /**
      * If parameter is a datetime function, e.g. "CURRENT_TIMESTAMP", normalizes it.
      * Otherwise returns original input.
+     * @param value
      */
     normalizeDatetimeFunction(value) {
         if (!value)
@@ -1125,6 +1009,7 @@ class MysqlDriver {
     }
     /**
      * Escapes a given comment.
+     * @param comment
      */
     escapeComment(comment) {
         if (!comment)
@@ -1136,6 +1021,8 @@ class MysqlDriver {
      * A helper to check if column data types have changed
      * This can be used to manage checking any types the
      * database may alias
+     * @param tableColumn
+     * @param columnMetadata
      */
     isColumnDataTypeChanged(tableColumn, columnMetadata) {
         // this is an exception for mariadb versions where json is an alias for longtext
@@ -1146,5 +1033,4 @@ class MysqlDriver {
     }
 }
 exports.MysqlDriver = MysqlDriver;
-
-//# sourceMappingURL=MysqlDriver.js.map
+//# sourceMappingURL=MysqlDriver.js.map