Skip to content

Commit 2668a2e

Browse files
committed
Deprecate MySqlQueryRunner & MySqlPoolQueryRunner due mysql (npm) project is dead.
1 parent c363b2a commit 2668a2e

File tree

4 files changed

+14
-1
lines changed

4 files changed

+14
-1
lines changed

docs/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
**Changes**:
66

7-
- Deprecate `SqliteQueryRunner` due [Sqlite](https://www.npmjs.com/package/sqlite) project is dead.
7+
- Deprecate `SqliteQueryRunner` due [sqlite](https://www.npmjs.com/package/sqlite) project is dead.
8+
- Deprecate `MySqlQueryRunner` & `MySqlPoolQueryRunner` due [mysql](https://www.npmjs.com/package/mysql) project is dead.
89

910
**Documentation changes**:
1011

docs/query-runners/additional-query-runners.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,12 @@ async function doYourLogic(connection: DBConnection) {
174174

175175
## mysql
176176

177+
**DEPRECATED**: [mysql](https://www.npmjs.com/package/mysql) is not maintained any more.
178+
177179
### mysql (with a connection pool)
178180

181+
**DEPRECATED**: [mysql](https://www.npmjs.com/package/mysql) is not maintained any more.
182+
179183
It allows to execute the queries using a [mysql](https://www.npmjs.com/package/mysql) connection pool.
180184

181185
**Supported databases**: mariaDB, mySql
@@ -200,6 +204,8 @@ async function main() {
200204

201205
### mysql (with a connection)
202206

207+
**DEPRECATED**: [mysql](https://www.npmjs.com/package/mysql) is not maintained any more.
208+
203209
It allows to execute the queries using a [mysql](https://www.npmjs.com/package/mysql) connection.
204210

205211
**Supported databases**: mariaDB, mySql

src/queryRunners/MySqlPoolQueryRunner.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ import type { Pool, PoolConnection } from "mysql"
33
import { PromiseBasedPoolQueryRunner } from "./PromiseBasedPoolQueryRunner"
44
import { MySqlQueryRunner } from "./MySqlQueryRunner"
55

6+
/**
7+
* @deprecated https://www.npmjs.com/package/mysql is not maintained anymore. Use another QueryRunner for MySql instead.
8+
*/
69
export class MySqlPoolQueryRunner extends PromiseBasedPoolQueryRunner {
710
readonly database: DatabaseType
811
readonly pool: Pool

src/queryRunners/MySqlQueryRunner.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ import type { DatabaseType } from "./QueryRunner"
22
import type { Connection } from "mysql"
33
import { PromiseBasedQueryRunner } from "./PromiseBasedQueryRunner"
44

5+
/**
6+
* @deprecated https://www.npmjs.com/package/mysql is not maintained anymore. Use another QueryRunner for MySql instead.
7+
*/
58
export class MySqlQueryRunner extends PromiseBasedQueryRunner {
69
readonly database: DatabaseType
710
readonly connection: Connection

0 commit comments

Comments
 (0)