typeorm 0.3.18-dev.ff6e875 → 0.3.19-dev.633c4e3

package/driver/mysql/MysqlConnectionOptions.d.ts

@@ -1,4 +1,5 @@
 import { BaseDataSourceOptions } from "../../data-source/BaseDataSourceOptions";
+import { ReplicationMode } from "../types/ReplicationMode";
 import { MysqlConnectionCredentialsOptions } from "./MysqlConnectionCredentialsOptions";
 /**
  * MySQL specific connection options.
@@ -122,5 +123,10 @@ export interface MysqlConnectionOptions extends BaseDataSourceOptions, MysqlConn
          * ORDER: Select the first node available unconditionally.
          */
         readonly selector?: "RR" | "RANDOM" | "ORDER";
+        /**
+         * Default connection pool to use for SELECT queries
+         * @default "slave"
+         */
+        readonly defaultMode?: ReplicationMode;
     };
 }

package/driver/mysql/MysqlConnectionOptions.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/driver/mysql/MysqlConnectionOptions.ts"],"names":[],"mappings":"","file":"MysqlConnectionOptions.js","sourcesContent":["import { BaseDataSourceOptions } from \"../../data-source/BaseDataSourceOptions\"\nimport { MysqlConnectionCredentialsOptions } from \"./MysqlConnectionCredentialsOptions\"\n\n/**\n * MySQL specific connection options.\n *\n * @see https://github.com/mysqljs/mysql#connection-options\n */\nexport interface MysqlConnectionOptions\n    extends BaseDataSourceOptions,\n        MysqlConnectionCredentialsOptions {\n    /**\n     * Database type.\n     */\n    readonly type: \"mysql\" | \"mariadb\"\n\n    /**\n     * The driver object\n     * This defaults to require(\"mysql\").\n     * Falls back to require(\"mysql2\")\n     */\n    readonly driver?: any\n\n    /**\n     * The charset for the connection. This is called \"collation\" in the SQL-level of MySQL (like utf8_general_ci).\n     * If a SQL-level charset is specified (like utf8mb4) then the default collation for that charset is used.\n     * Default: 'UTF8_GENERAL_CI'\n     */\n    readonly charset?: string\n\n    /**\n     * The timezone configured on the MySQL server.\n     * This is used to type cast server date/time values to JavaScript Date object and vice versa.\n     * This can be 'local', 'Z', or an offset in the form +HH:MM or -HH:MM. (Default: 'local')\n     */\n    readonly timezone?: string\n\n    /**\n     * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10000)\n     */\n    readonly connectTimeout?: number\n\n    /**\n     * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10000)\n     * This difference between connectTimeout and acquireTimeout is subtle and is described in the mysqljs/mysql docs\n     * https://github.com/mysqljs/mysql/tree/master#pool-options\n     */\n    readonly acquireTimeout?: number\n\n    /**\n     * Allow connecting to MySQL instances that ask for the old (insecure) authentication method. (Default: false)\n     */\n    readonly insecureAuth?: boolean\n\n    /**\n     * When dealing with big numbers (BIGINT and DECIMAL columns) in the database, you should enable this option (Default: false)\n     */\n    readonly supportBigNumbers?: boolean\n\n    /**\n     * Enabling both supportBigNumbers and bigNumberStrings forces big numbers (BIGINT and DECIMAL columns) to be always\n     * returned as JavaScript String objects (Default: false). Enabling supportBigNumbers but leaving bigNumberStrings\n     * disabled will return big numbers as String objects only when they cannot be accurately represented with\n     * [JavaScript Number objects](http://ecma262-5.com/ELS5_HTML.htm#Section_8.5) (which happens when they exceed the [-2^53, +2^53] range),\n     * otherwise they will be returned as Number objects. This option is ignored if supportBigNumbers is disabled.\n     */\n    readonly bigNumberStrings?: boolean\n\n    /**\n     * Force date types (TIMESTAMP, DATETIME, DATE) to be returned as strings rather then inflated into JavaScript Date objects.\n     * Can be true/false or an array of type names to keep as strings.\n     */\n    readonly dateStrings?: boolean | string[]\n\n    /**\n     * Prints protocol details to stdout. Can be true/false or an array of packet type names that should be printed.\n     * (Default: false)\n     */\n    readonly debug?: boolean | string[]\n\n    /**\n     * Generates stack traces on Error to include call site of library entrance (\"long stack traces\").\n     * Slight performance penalty for most calls. (Default: true)\n     */\n    readonly trace?: boolean\n\n    /**\n     * Allow multiple mysql statements per query. Be careful with this, it could increase the scope of SQL injection attacks.\n     * (Default: false)\n     */\n    readonly multipleStatements?: boolean\n\n    /**\n     * Use spatial functions like GeomFromText and AsText which are removed in MySQL 8.\n     * (Default: true)\n     */\n    readonly legacySpatialSupport?: boolean\n\n    /**\n     * List of connection flags to use other than the default ones. It is also possible to blacklist default ones.\n     * For more information, check https://github.com/mysqljs/mysql#connection-flags.\n     */\n    readonly flags?: string[]\n\n    /**\n     * TypeORM will automatically use package found in your node_modules, prioritizing mysql over mysql2,\n     * but you can specify it manually\n     */\n    readonly connectorPackage?: \"mysql\" | \"mysql2\"\n\n    /**\n     * Replication setup.\n     */\n    readonly replication?: {\n        /**\n         * Master server used by orm to perform writes.\n         */\n        readonly master: MysqlConnectionCredentialsOptions\n\n        /**\n         * List of read-from severs (slaves).\n         */\n        readonly slaves: MysqlConnectionCredentialsOptions[]\n\n        /**\n         * If true, PoolCluster will attempt to reconnect when connection fails. (Default: true)\n         */\n        readonly canRetry?: boolean\n\n        /**\n         * If connection fails, node's errorCount increases.\n         * When errorCount is greater than removeNodeErrorCount, remove a node in the PoolCluster. (Default: 5)\n         */\n        readonly removeNodeErrorCount?: number\n\n        /**\n         * If connection fails, specifies the number of milliseconds before another connection attempt will be made.\n         * If set to 0, then node will be removed instead and never re-used. (Default: 0)\n         */\n        readonly restoreNodeTimeout?: number\n\n        /**\n         * Determines how slaves are selected:\n         * RR: Select one alternately (Round-Robin).\n         * RANDOM: Select the node by random function.\n         * ORDER: Select the first node available unconditionally.\n         */\n        readonly selector?: \"RR\" | \"RANDOM\" | \"ORDER\"\n    }\n}\n"],"sourceRoot":"../.."}
+{"version":3,"sources":["../../src/driver/mysql/MysqlConnectionOptions.ts"],"names":[],"mappings":"","file":"MysqlConnectionOptions.js","sourcesContent":["import { BaseDataSourceOptions } from \"../../data-source/BaseDataSourceOptions\"\nimport { ReplicationMode } from \"../types/ReplicationMode\"\nimport { MysqlConnectionCredentialsOptions } from \"./MysqlConnectionCredentialsOptions\"\n\n/**\n * MySQL specific connection options.\n *\n * @see https://github.com/mysqljs/mysql#connection-options\n */\nexport interface MysqlConnectionOptions\n    extends BaseDataSourceOptions,\n        MysqlConnectionCredentialsOptions {\n    /**\n     * Database type.\n     */\n    readonly type: \"mysql\" | \"mariadb\"\n\n    /**\n     * The driver object\n     * This defaults to require(\"mysql\").\n     * Falls back to require(\"mysql2\")\n     */\n    readonly driver?: any\n\n    /**\n     * The charset for the connection. This is called \"collation\" in the SQL-level of MySQL (like utf8_general_ci).\n     * If a SQL-level charset is specified (like utf8mb4) then the default collation for that charset is used.\n     * Default: 'UTF8_GENERAL_CI'\n     */\n    readonly charset?: string\n\n    /**\n     * The timezone configured on the MySQL server.\n     * This is used to type cast server date/time values to JavaScript Date object and vice versa.\n     * This can be 'local', 'Z', or an offset in the form +HH:MM or -HH:MM. (Default: 'local')\n     */\n    readonly timezone?: string\n\n    /**\n     * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10000)\n     */\n    readonly connectTimeout?: number\n\n    /**\n     * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10000)\n     * This difference between connectTimeout and acquireTimeout is subtle and is described in the mysqljs/mysql docs\n     * https://github.com/mysqljs/mysql/tree/master#pool-options\n     */\n    readonly acquireTimeout?: number\n\n    /**\n     * Allow connecting to MySQL instances that ask for the old (insecure) authentication method. (Default: false)\n     */\n    readonly insecureAuth?: boolean\n\n    /**\n     * When dealing with big numbers (BIGINT and DECIMAL columns) in the database, you should enable this option (Default: false)\n     */\n    readonly supportBigNumbers?: boolean\n\n    /**\n     * Enabling both supportBigNumbers and bigNumberStrings forces big numbers (BIGINT and DECIMAL columns) to be always\n     * returned as JavaScript String objects (Default: false). Enabling supportBigNumbers but leaving bigNumberStrings\n     * disabled will return big numbers as String objects only when they cannot be accurately represented with\n     * [JavaScript Number objects](http://ecma262-5.com/ELS5_HTML.htm#Section_8.5) (which happens when they exceed the [-2^53, +2^53] range),\n     * otherwise they will be returned as Number objects. This option is ignored if supportBigNumbers is disabled.\n     */\n    readonly bigNumberStrings?: boolean\n\n    /**\n     * Force date types (TIMESTAMP, DATETIME, DATE) to be returned as strings rather then inflated into JavaScript Date objects.\n     * Can be true/false or an array of type names to keep as strings.\n     */\n    readonly dateStrings?: boolean | string[]\n\n    /**\n     * Prints protocol details to stdout. Can be true/false or an array of packet type names that should be printed.\n     * (Default: false)\n     */\n    readonly debug?: boolean | string[]\n\n    /**\n     * Generates stack traces on Error to include call site of library entrance (\"long stack traces\").\n     * Slight performance penalty for most calls. (Default: true)\n     */\n    readonly trace?: boolean\n\n    /**\n     * Allow multiple mysql statements per query. Be careful with this, it could increase the scope of SQL injection attacks.\n     * (Default: false)\n     */\n    readonly multipleStatements?: boolean\n\n    /**\n     * Use spatial functions like GeomFromText and AsText which are removed in MySQL 8.\n     * (Default: true)\n     */\n    readonly legacySpatialSupport?: boolean\n\n    /**\n     * List of connection flags to use other than the default ones. It is also possible to blacklist default ones.\n     * For more information, check https://github.com/mysqljs/mysql#connection-flags.\n     */\n    readonly flags?: string[]\n\n    /**\n     * TypeORM will automatically use package found in your node_modules, prioritizing mysql over mysql2,\n     * but you can specify it manually\n     */\n    readonly connectorPackage?: \"mysql\" | \"mysql2\"\n\n    /**\n     * Replication setup.\n     */\n    readonly replication?: {\n        /**\n         * Master server used by orm to perform writes.\n         */\n        readonly master: MysqlConnectionCredentialsOptions\n\n        /**\n         * List of read-from severs (slaves).\n         */\n        readonly slaves: MysqlConnectionCredentialsOptions[]\n\n        /**\n         * If true, PoolCluster will attempt to reconnect when connection fails. (Default: true)\n         */\n        readonly canRetry?: boolean\n\n        /**\n         * If connection fails, node's errorCount increases.\n         * When errorCount is greater than removeNodeErrorCount, remove a node in the PoolCluster. (Default: 5)\n         */\n        readonly removeNodeErrorCount?: number\n\n        /**\n         * If connection fails, specifies the number of milliseconds before another connection attempt will be made.\n         * If set to 0, then node will be removed instead and never re-used. (Default: 0)\n         */\n        readonly restoreNodeTimeout?: number\n\n        /**\n         * Determines how slaves are selected:\n         * RR: Select one alternately (Round-Robin).\n         * RANDOM: Select the node by random function.\n         * ORDER: Select the first node available unconditionally.\n         */\n        readonly selector?: \"RR\" | \"RANDOM\" | \"ORDER\"\n\n        /**\n         * Default connection pool to use for SELECT queries\n         * @default \"slave\"\n         */\n        readonly defaultMode?: ReplicationMode\n    }\n}\n"],"sourceRoot":"../.."}

package/driver/mysql/MysqlQueryRunner.d.ts

@@ -128,6 +128,10 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
      * Renames a table.
      */
     renameTable(oldTableOrName: Table | string, newTableName: string): Promise<void>;
+    /**
+     * Change table comment.
+     */
+    changeTableComment(tableOrName: Table | string, newComment?: string): Promise<void>;
     /**
      * Creates a new column from the column in the table.
      */

package/driver/mysql/MysqlQueryRunner.js

@@ -19,6 +19,7 @@ const VersionUtils_1 = require("../../util/VersionUtils");
 const error_1 = require("../../error");
 const MetadataTableType_1 = require("../types/MetadataTableType");
 const InstanceChecker_1 = require("../../util/InstanceChecker");
+const BroadcasterResult_1 = require("../../subscriber/BroadcasterResult");
 /**
  * Runs queries on a single mysql database connection.
  */
@@ -87,15 +88,16 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
             throw err;
         }
         if (this.transactionDepth === 0) {
+            this.transactionDepth += 1;
             if (isolationLevel) {
                 await this.query("SET TRANSACTION ISOLATION LEVEL " + isolationLevel);
             }
             await this.query("START TRANSACTION");
         }
         else {
-            await this.query(`SAVEPOINT typeorm_${this.transactionDepth}`);
+            this.transactionDepth += 1;
+            await this.query(`SAVEPOINT typeorm_${this.transactionDepth - 1}`);
         }
-        this.transactionDepth += 1;
         await this.broadcaster.broadcast("AfterTransactionStart");
     }
     /**
@@ -107,13 +109,14 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
             throw new TransactionNotStartedError_1.TransactionNotStartedError();
         await this.broadcaster.broadcast("BeforeTransactionCommit");
         if (this.transactionDepth > 1) {
-            await this.query(`RELEASE SAVEPOINT typeorm_${this.transactionDepth - 1}`);
+            this.transactionDepth -= 1;
+            await this.query(`RELEASE SAVEPOINT typeorm_${this.transactionDepth}`);
         }
         else {
+            this.transactionDepth -= 1;
             await this.query("COMMIT");
             this.isTransactionActive = false;
         }
-        this.transactionDepth -= 1;
         await this.broadcaster.broadcast("AfterTransactionCommit");
     }
     /**
@@ -125,13 +128,14 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
             throw new TransactionNotStartedError_1.TransactionNotStartedError();
         await this.broadcaster.broadcast("BeforeTransactionRollback");
         if (this.transactionDepth > 1) {
-            await this.query(`ROLLBACK TO SAVEPOINT typeorm_${this.transactionDepth - 1}`);
+            this.transactionDepth -= 1;
+            await this.query(`ROLLBACK TO SAVEPOINT typeorm_${this.transactionDepth}`);
         }
         else {
+            this.transactionDepth -= 1;
             await this.query("ROLLBACK");
             this.isTransactionActive = false;
         }
-        this.transactionDepth -= 1;
         await this.broadcaster.broadcast("AfterTransactionRollback");
     }
     /**
@@ -141,11 +145,13 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
         if (this.isReleased)
             throw new QueryRunnerAlreadyReleasedError_1.QueryRunnerAlreadyReleasedError();
         return new Promise(async (ok, fail) => {
+            const broadcasterResult = new BroadcasterResult_1.BroadcasterResult();
             try {
                 const databaseConnection = await this.connect();
                 this.driver.connection.logger.logQuery(query, parameters, this);
+                this.broadcaster.broadcastBeforeQueryEvent(broadcasterResult, query, parameters);
                 const queryStartTime = +new Date();
-                databaseConnection.query(query, parameters, (err, raw) => {
+                databaseConnection.query(query, parameters, async (err, raw) => {
                     // log slow queries if maxQueryExecution time is set
                     const maxQueryExecutionTime = this.driver.options.maxQueryExecutionTime;
                     const queryEndTime = +new Date();
@@ -155,8 +161,10 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
                         this.driver.connection.logger.logQuerySlow(queryExecutionTime, query, parameters, this);
                     if (err) {
                         this.driver.connection.logger.logQueryError(err, query, parameters, this);
+                        this.broadcaster.broadcastAfterQueryEvent(broadcasterResult, query, parameters, false, undefined, undefined, err);
                         return fail(new QueryFailedError_1.QueryFailedError(query, parameters, err));
                     }
+                    this.broadcaster.broadcastAfterQueryEvent(broadcasterResult, query, parameters, true, queryExecutionTime, raw, undefined);
                     const result = new QueryResult_1.QueryResult();
                     result.raw = raw;
                     try {
@@ -179,6 +187,9 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
             catch (err) {
                 fail(err);
             }
+            finally {
+                await broadcasterResult.wait();
+            }
         });
     }
     /**
@@ -491,6 +502,28 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
         oldTable.name = newTable.name;
         this.replaceCachedTable(oldTable, newTable);
     }
+    /**
+     * Change table comment.
+     */
+    async changeTableComment(tableOrName, newComment) {
+        const upQueries = [];
+        const downQueries = [];
+        const table = InstanceChecker_1.InstanceChecker.isTable(tableOrName)
+            ? tableOrName
+            : await this.getCachedTable(tableOrName);
+        newComment = this.escapeComment(newComment);
+        const comment = this.escapeComment(table.comment);
+        if (newComment === comment) {
+            return;
+        }
+        const newTable = table.clone();
+        upQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(newTable)} COMMENT ${newComment}`));
+        downQueries.push(new Query_1.Query(`ALTER TABLE ${this.escapePath(table)} COMMENT ${comment}`));
+        await this.executeQueries(upQueries, downQueries);
+        // change table comment and replace it in cached tabled;
+        table.comment = newTable.comment;
+        this.replaceCachedTable(table, newTable);
+    }
     /**
      * Creates a new column from the column in the table.
      */
@@ -1370,7 +1403,7 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
         const dbTables = [];
         if (!tableNames) {
             // Since we don't have any of this data we have to do a scan
-            const tablesSql = `SELECT \`TABLE_SCHEMA\`, \`TABLE_NAME\` FROM \`INFORMATION_SCHEMA\`.\`TABLES\``;
+            const tablesSql = `SELECT \`TABLE_SCHEMA\`, \`TABLE_NAME\`, \`TABLE_COMMENT\` FROM \`INFORMATION_SCHEMA\`.\`TABLES\``;
             dbTables.push(...(await this.query(tablesSql)));
         }
         else {
@@ -1384,7 +1417,7 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
                 if (!database) {
                     database = currentDatabase;
                 }
-                return `SELECT \`TABLE_SCHEMA\`, \`TABLE_NAME\` FROM \`INFORMATION_SCHEMA\`.\`TABLES\` WHERE \`TABLE_SCHEMA\` = '${database}' AND \`TABLE_NAME\` = '${name}'`;
+                return `SELECT \`TABLE_SCHEMA\`, \`TABLE_NAME\`, \`TABLE_COMMENT\` FROM \`INFORMATION_SCHEMA\`.\`TABLES\` WHERE \`TABLE_SCHEMA\` = '${database}' AND \`TABLE_NAME\` = '${name}'`;
             })
                 .join(" UNION ");
             dbTables.push(...(await this.query(tablesSql)));
@@ -1616,7 +1649,7 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
                             ? "VIRTUAL"
                             : "STORED";
                     // We cannot relay on information_schema.columns.generation_expression, because it is formatted different.
-                    const asExpressionQuery = await this.selectTypeormMetadataSql({
+                    const asExpressionQuery = this.selectTypeormMetadataSql({
                         schema: dbTable["TABLE_SCHEMA"],
                         table: dbTable["TABLE_NAME"],
                         type: MetadataTableType_1.MetadataTableType.GENERATED_COLUMN,
@@ -1759,6 +1792,7 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
                     isFulltext: constraint["INDEX_TYPE"] === "FULLTEXT",
                 });
             });
+            table.comment = dbTable["TABLE_COMMENT"];
             return table;
         }));
     }
@@ -1855,6 +1889,9 @@ class MysqlQueryRunner extends BaseQueryRunner_1.BaseQueryRunner {
             sql += `, PRIMARY KEY (${columnNames})`;
         }
         sql += `) ENGINE=${table.engine || "InnoDB"}`;
+        if (table.comment) {
+            sql += ` COMMENT="${table.comment}"`;
+        }
         return new Query_1.Query(sql);
     }
     /**