types / mysql2 Goto Github PK

The most recent commit fails to compile (using TS 3.8.3):

node_modules/@types/mysql2/index.d.ts:19:18 - error TS2430: Interface 'Pool' incorrectly extends interface 'Connection'.
  Types of property 'end' are incompatible.
    Type '(callback?: ((err: Error) => any) | undefined) => void' is not assignable to type '{ (callback?: ((err: QueryError | null) => void) | undefined): void; (options: any, callback?: ((err: QueryError | null) => void) | undefined): void; }'.
      Types of parameters 'callback' and 'callback' are incompatible.
        Types of parameters 'err' and 'err' are incompatible.
          Type 'Error' is missing the following properties from type 'QueryError': code, fatal

19 export interface Pool extends mysql.Connection {
                    ~~~~

I haven't looked much into this, but promise.d.ts defines a Connection interface with a changeUser method, but https://github.com/sidorares/node-mysql2/blob/master/promise.js defines PromiseConnection with a different structure. I noticed this when I got a run-time error stating my Connection object had no changeUser method.

This PromiseConnection is what is returned from createConnection.

https://github.com/sidorares/node-mysql2/blob/master/promise.js does not define a createUser method, but you do have access to the underlying Connection.

I am using exec to execute stored procedures, but the return type is not accurate.

Stored procedure:

DELIMITER //
CREATE PROCEDURE `user_get_by_username`(
  IN in_username VARCHAR(25)
)
BEGIN
  SELECT `id`, `username` FROM `user` WHERE `username` = in_username;
END //
DELIMITER ;

Code

import { RowDataPacket } from 'mysql2';

import configuration from '../configuration';

export interface User extends RowDataPacket {
  id: number;
  username: string;
}

databaseConnection = mysql.createConnection({
  database: configuration.mySQL.database(),
  host: configuration.mySQL.host(),
  password: configuration.mySQL.password(),
  user: configuration.mySQL.username(),
});

const userGetByUsername = ({ username }: { username: string }) =>
  new Promise<User | null>((resolve, reject) => {
    databaseConnection.execute<User[][]>(
      { sql: 'CALL user_get_by_username(?)', values: [username] },
      (error, response) => {
        console.log('response', response);
        if (error) {
          reject(
            new Error(`Failed to get user '${username}': ${error.message}`)
          );
        } else {
          resolve(response[0].length > 0 ? response[0][0] : null);
        }
      }
    );
  });

The issue is that execute does not return User[][], but instead it returns [User[], ResultSetHeader],
and I cannot use the following as it does not work:

databaseConnection.execute<[User[], ResultSetHeader]>(

This code (from README, using non-promises version) hangs after displaying The solution is: 2

import {createConnection, QueryError, RowDataPacket} from 'mysql2';

const connection = createConnection(process.env['DB']);

connection.query('SELECT 1 + 1 AS solution', (err: QueryError, rows: RowDataPacket[]) => {
    console.log('The solution is: ', rows[0]['solution']);
});

I had to add a

connection.end();

to the end of file to fix this. Then the program finishes normally.

Is this the expected behavior?

Using mysql2 version 1.2.0. Node.js version v6.10.3.

Version 2.4.1 of typescript just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As typescript is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

There seem to be some missing options on the ConnectionOptions/PoolOptions interfaces. From a quick look over the code, specifically decimalNumbers, namedPlaceholders, and nestTables. I ran into this issue in trying to use the namedPlaceholders option over the bulky queryFormat example in the documentation.

https://github.com/sidorares/node-mysql2/blob/master/lib/connection_config.js#L29,L43

Version 4.5.1 of tslint just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As tslint is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

Upon console logging an INSERT, I can see the following:

ResultSetHeader {
    fieldCount: 0,
    affectedRows: 1,
    insertId: 0,
    info: '',
    serverStatus: 2,
    warningStatus: 1 }

This would imply that there's a warning. What return packet type would contain this information?

The signature for .query is RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[], and since this is an INSERT I'd expect the result to be an OkPacket if anything, however the OkPacket type definition is:

OkPacket {
    constructor: {
        name: 'OkPacket'
    };
    fieldCount: number;
    affectedRows: number;
    changedRows: number;
    insertId: number;
    serverStatus: number;
    warningCount: number;
    message: string;
    procotol41: boolean;
}

Observations:

• warningStatus vs warningCount
• procotol41 (odd spelling, can't find any reference to this elsewhere)

So unless I typecast as any I don't believe I can determine if a query has had a warning, but I'd just like to confirm if this is the case and raise this just in case there is indeed an issue in the definition.

Are there any plans of putting these typings on DefinitelyTyped? AFAIK the typings tool is outdated, and the proper way to publish types now is with DefinitelyTyped. That would allow npm install --save-dev @types/mysql2 .

Is there any possibility this project could be mirrored on npm?

It is possible to release it to npm? #19 is on hold for a long time for some reason, also I didn't notice any progress on sidorares/node-mysql2#1028 😢

This code (from promises sample)

import * as mysql from 'mysql2/promise';

let connection = mysql.createConnection(process.env['DB']);

connection.connect()
    .then(() => connection.query<mysql.RowDataPacket[]>('SELECT 1 + 1 AS solution'))
    .then(([rows, fields]) => {
        console.log('The solution is: ', rows[0]['solution']);
    });

Is causing he following error in runtime:

TypeError: connection.connect is not a function

Please, do notice the error occurs just in runtime. The TypeScript compiler doesn't shows any errors.

Using TypeScript version 2.3.2, Node.js version v6.10.3 and mysql2 version 1.2.0 (tried to downgrade to 1.1.1 but the problem remains).

Hi there,

The function promise() is not available on the Pool class :( !?
Thanks for your help !

****

When i run npm install --save-dev types/mysql2#semver:1.0.0 it gives me the types that are pre PR-18. For instance, the createConnection method in promise.d.ts still returns a Connection, not Promise.

export function createConnection(connectionUri: string): Connection;
export function createConnection(config: ConnectionOptions): Connection;

Am I doing something wrong? Thanks

Version 2.2.1 of typescript just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As typescript is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

Hello,
It seems the library can't be used with ts 3.7 due to newly fixed recursive import/export. Actually the recursive import/export is in @types/mysql files but that is affecting this package too.

npm package name shoud be @types/mysql2, instead of types/mysql2.

e.g. @types/node, @types/mysql

As described over here: https://github.com/sidorares/node-mysql2

// For pool initialization, see above
pool.getConnection(function(conn) {
   // Do something with the connection
   conn.query(/* ... */);
   // Don't forget to release the connection when finished!
   pool.releaseConnection(conn);
})

It should be possible to also call pool.releaseConnection. Currently it says: 'Property 'releaseConnection' does not exist on type 'Pool'.

I don't know if conn.release() is also fine, or should this example be updated on their page (sidorares)?

Correct me if I'm wrong.

Regards,
Melroy

These typings are unfortunately out of date, missing at least the promise() shortcut function on Pool and Connection.

I would love to contribute a PR to fix this but I don't know this library well enough to know what the return type would be.

I think it would be a good idea to move this repo to DefinitelyTyped.

Hi! I'm fairly new with Node and Typescript in general and, while following a tutorial, I've encountered an issue trying to install types/mysql2 via the command npm i types/mysql2 -D

When running the command, I get the following error:

npm ERR! path git
npm ERR! code ENOENT
npm ERR! errno ENOENT
npm ERR! syscall spawn git
npm ERR! enoent Error while executing:
npm ERR! enoent undefined ls-remote -h -t ssh://[email protected]/types/mysql2.git
npm ERR! enoent
npm ERR! enoent
npm ERR! enoent spawn git ENOENT
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\[redacted path]\AppData\Roaming\npm-cache\_logs\2019-07-24T21_06_57_398Z-debug.log

The log file reads as follows:

0 info it worked if it ends with ok
1 verbose cli [ 'C:\\Program Files\\nodejs\\node.exe',
1 verbose cli   'C:\\Program Files\\nodejs\\node_modules\\npm\\bin\\npm-cli.js',
1 verbose cli   'install',
1 verbose cli   'types/mysql2',
1 verbose cli   '-D' ]
2 info using [email protected]
3 info using [email protected]
4 verbose npm-session ffaebe21627f68a6
5 silly install loadCurrentTree
6 silly install readLocalPackageData
7 silly fetchPackageMetaData error for github:types/mysql2 Error while executing:
7 silly fetchPackageMetaData undefined ls-remote -h -t ssh://[email protected]/types/mysql2.git
7 silly fetchPackageMetaData
7 silly fetchPackageMetaData
7 silly fetchPackageMetaData spawn git ENOENT
8 timing stage:rollbackFailedOptional Completed in 0ms
9 timing stage:runTopLevelLifecycles Completed in 1172ms
10 verbose stack Error: spawn git ENOENT
10 verbose stack     at Process.ChildProcess._handle.onexit (internal/child_process.js:240:19)
10 verbose stack     at onErrorNT (internal/child_process.js:415:16)
10 verbose stack     at process._tickCallback (internal/process/next_tick.js:63:19)
11 verbose cwd C:\[redacted path, recipient folder for my DB]
12 verbose Windows_NT 10.0.17763
13 verbose argv "C:\\Program Files\\nodejs\\node.exe" "C:\\Program Files\\nodejs\\node_modules\\npm\\bin\\npm-cli.js" "install" "types/mysql2" "-D"
14 verbose node v10.16.0
15 verbose npm  v6.9.0
16 error path git
17 error code ENOENT
18 error errno ENOENT
19 error syscall spawn git
20 error enoent Error while executing:
20 error enoent undefined ls-remote -h -t ssh://[email protected]/types/mysql2.git
20 error enoent
20 error enoent
20 error enoent spawn git ENOENT
21 error enoent This is related to npm not being able to find a file.
22 verbose exit [ 1, true ]

Apparently it's an issue with the retrival of files from GitHub, but would like to be sure about it, since I've found nothing looking up for this issue. I appreciate the attention and help beforehand and hope you all are having a nice day! :)

Hi

I don't know what I'm doing wrong. I cannot properly type results when the option rowsAsArray is enabled.
My SQL returns an array of arrays that contains only one string eg:

// connection.promise().query("SHOW TABLES LIKE 'table_%';");
[
  [ 'table_1'],   [ 'table_2'],
  [ 'table_3'],   [ 'table_4'], 
]

I want to flat this result in my helper function but TS complaints about types mismatch.
See example below

const listTablesSql = "SHOW TABLES LIKE 'table_%';"

async strictTypeInQuery(): Promise<string[]> {
        // error: `Type 'string' is not assignable to type 'RowDataPacket'`
        const [rows] = await connection.promise().query<string[]>({sql: listTablesSql, rowsAsArray: true}); 

        return rows.flat(1);
}

async inferType(): Promise<string[]> {
        // error: `Type 'string' is not assignable to type 'RowDataPacket'`
        const [rows] = await connection.promise().query({sql: listTablesSql, rowsAsArray: true}); 

        return rows.flat(1); // TS:error `Type 'RowDataPacket' is not assignable to type 'string'.`
}

Can you help me and point what I'm doing wrong?

When fetching FieldPackets from a query, I'm observing that packet.type is undefined, in violation of its type: https://github.com/sidorares/node-mysql2/blob/master/typings/mysql/lib/protocol/packets/FieldPacket.d.ts#L18

Example code:

$ const [res, fields] = await conn.execute<RowDataPacket[]>(sql);
$ fields[0].type
undefined

Hello.
Sorry, if I don't understand how it works.
In d.ts file we have such declaration

declare interface RowDataPacket {
    constructor: {
        name: 'RowDataPacket'
    };
    [column: string]: any;
    [column: number]: any;
}

But actually RowDataPacket is a binaryRow and thus it has same name in constructor.
thanks

when I try to install the typing using the instructions in the readme it says:
typings install --save mysql2

bash: typings: command not found

export const validateCredentials = async (user: User): Promise<boolean> => {
    let result;
    connection.query('SELECT password from users WHERE email = ? AND password = ?', [user.email, user.password], (err: QueryError, rows: RowDataPacket[]) => {
        console.log(rows[0][user.password]); //this is the users password
        result = rows[0][user.password];
    });
    console.log(result) // result is always undefined 
    return result != undefined;
   
};

the provided email and password are correct and rows[0][user.password] is holding a value. now i want to return this value outside the callback function, how do i do that?

mysql2 supports getting query results back as an array of arrays but currently the typedefs don't include this query option (as it's not in the relied-upon @types/mysql lib) and its return value (an array of arrays) is also missing as an option for functions like query and execute.

Version 5.5.0 of tslint just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As tslint is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴