ERROR: Please install mysql2 package manually

Question

When using the sequalize db:migrate command I am getting the following error. Looking at some of the previous comments on similar issues people said it is a dependency issue but whenever I run

npm install mysql2

or

npm install -g mysql2

I get the same error.

larry@DESKTOP-NSSNPRR:/mnt/c/Users/larry/Desktop/node/AAF-NodeJS$
sequelize db:migrate

Sequelize CLI [Node: 10.1.0, CLI: 4.0.0, ORM: 4.37.10]

(node:2241) ExperimentalWarning: The fs.promises API is experimental
Loaded configuration file "db/config/database.json".
Using environment "development".

ERROR: Please install mysql2 package manually

Here is my package.json like some of you have asked for.

{
  "name": "aaf-website-node",
  "version": "0.0.1",
  "description": "Nodejs implementation of the achieve anything website",
  "main": "app.js",
  "scripts": {
    "start": "node bin/www",
    "dev": "node node_modules/nodemon/bin/nodemon.js bin/www",
    "test": "jasmine",
    "console": "node console.js"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/AchieveGirl/AAF-NodeJS.git"
  },
  "keywords": [
    "nodejs",
    "express"
  ],
  "author": "Larry Cherry",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/AchieveGirl/AAF-NodeJS/issues"
  },
  "homepage": "https://github.com/AchieveGirl/AAF-NodeJS/blob/master/README.md",
  "dependencies": {
    "body-parser": "^1.18.2",
    "bootstrap": "^4.0.0",
    "compression": "^1.7.2",
    "cookie-parser": "^1.4.3",
    "dotenv": "^5.0.1",
    "ejs": "^2.5.7",
    "eslint": "^4.19.1",
    "express": "^4.16.3",
    "express-ejs-layouts": "^2.3.1",
    "express-minify": "^1.0.0",
    "express-minify-html": "^0.12.0",
    "jquery": "^3.3.1",
    "lodash": "^4.17.5",
    "morgan": "^1.9.0",
    "mysql2": "^1.5.3",
    "node-fetch": "^2.1.2",
    "node-minify": "^2.4.1",
    "popper.js": "^1.14.3",
    "sequelize": "^4.37.10",
    "sequelize-cli": "^4.0.0",
    "serve-favicon": "^2.4.5",
    "webpack": "^4.1.1",
    "webpack-cli": "^2.0.12"
  },
  "devDependencies": {
    "nodemon": "^1.17.2",
    "pryjs": "^1.0.3"
  }
}

Can you post your `package.json` file – AbhinavD May 31 '18 at 03:14 — AbhinavD, May 31 '18 at 03:14
I just added it. Hopefully, it helps some. – Larry Cherry Jun 05 '18 at 19:44 — Larry Cherry, Jun 05 '18 at 19:44

score 29 · Answer 1 · answered Sep 12 '18 at 15:49

29

This one worked for me

npm install mysql2 --save

answered Sep 12 '18 at 15:49

bereket gebredingle

12,064
3
36
47

score 19 · Accepted Answer · answered Jun 07 '18 at 04:40

So I finally figured out the bug. The issue appears to come from when you are calling the migration from global install of sequelize-cli instead of the locally installed version of sequelize in my project. All I had to do was call the script form the node modules folder and it worked perfectly. I was calling the command this way sequelize db:migrate when I needed to call the local installed package this way node_modules/.bin/sequelize db:migrate

score 13 · Answer 3 · answered Sep 05 '19 at 16:08

13

i installed mysql2 package globally out of my project folder using :

npm install mysql2 -g

answered Sep 05 '19 at 16:08

TECT 2000

139
1
2

3

How is this different from: `npm install -g mysql2` which the person asking the question has already tried? – Felipe Centeno Sep 06 '19 at 15:13

Abdulsalam Almahdi · Answer 4 · 2022-03-25T15:46:16.843

8

maybe I am late but for whoever looking for answer if and you have mysql2 installed just add this to your sequelize instance to direct sequelize to the right module:

dialectModule: require('mysql2'),

const sequelize = new Sequelize(config.db.database, config.db.user, config.db.password, {
  host: config.host,
  dialect:'mysql',
  dialectModule: require('mysql2'),
});

https://github.com/sequelize/sequelize/issues/9608

edited Mar 25 '22 at 15:46

answered Mar 25 '22 at 15:38

Abdulsalam Almahdi

161
2
12

I'm using Sequelize and mysql2 with AWS lambda. Adding the dialectModeul: requre('mysql2') fixed the issue for me. – tjgragg Aug 07 '23 at 20:35
I migrated my project into a nx monorepo and this fixed the issue – messerbill Sep 01 '23 at 11:55

score 3 · Answer 5 · answered Jul 23 '19 at 17:23

3

List your global npm packages

npm list -g --depth 0
Uninstall sequelize

npm uninstall -g sequelize
Install sequelize in project scope

npm install --save sequelize

answered Jul 23 '19 at 17:23

BartusZak

1,041
14
21

score 2 · Answer 6 · answered Oct 15 '21 at 06:09

2

This worked for me:
npx sequelize-cli db:migrate

answered Oct 15 '21 at 06:09

kazmi066

573
5
15

score 1 · Answer 7 · answered Jul 06 '21 at 07:42

1

You may have run npm install -g sequelize. You need to undo this using npm uninstall -g sequelize then use this npm install -g sequelize-cli instead. This worked for me.

answered Jul 06 '21 at 07:42

Murimi Njue

13
4

score 1 · Answer 8 · edited Nov 28 '22 at 18:56

1

I got this error while deploying my express app in vercel, below things helped me solve the error.

I have installed sequelize, sequelize-cli, and mysql2 locally, specific to the project.

npm install sequelize sequelize-cli mysql2

Require the mysql2 package in the config file and add it to your configurations, attaching the image below for reference.

config.js

Hope it resolves!

edited Nov 28 '22 at 18:56

Tyler2P

2,324
26
22
31

answered Nov 25 '22 at 10:58

sanith_g

11
2

score 0 · Answer 9 · answered Oct 11 '19 at 13:47

I was unable to call a specific instance of sequelize (local vs global), so I uninstalled the global sequelize that I had added through yarn yarn global remove sequelize and then added it locally to my project yarn add sequelize.

npm equivalents would be npm -g uninstall sequelize and npm install sequelize.

Note in case anyone is going through the same, I did have mysql2 installed.

xiscodev · Answer 10 · 2020-02-14T07:34:22.937

0

Since version 5.2.0 nodejs comes alongside with an utility called npx, which is destined to be used as the "package runner", as it first look packages inside your node_modules you should not have any more troubles running commands with it.

NPM now should be used as a dependency manager instead of a command runner.

You can check differences of both here

edited Feb 14 '20 at 07:34

answered Feb 14 '20 at 07:27

xiscodev

96
1
1
5

score 0 · Answer 11 · answered Jan 06 '21 at 22:49

0

I solved it by running :-

yarn add mysql2

answered Jan 06 '21 at 22:49

Amera Abdallah

638
7
5

Works nodejs 14LTS, just ensure you remove any mysql2 global npm installs, then install it with the above command or its equivalent `npm i mysql2` – briancollins081 Feb 24 '21 at 07:33

score 0 · Answer 12 · answered Jul 26 '21 at 23:27

0

yarn add mysql2 or npm install mysql2

reboot your terminal

done!

answered Jul 26 '21 at 23:27

Wellerson

167
1
6

score -1 · Answer 13 · answered May 30 '18 at 23:51

-1

The reason that you getting an error message to prompt you to install the mysql2 module is because of the db:migrate command is relied on the mysql2 but as an optionalDependencies, so you have to install the mysql2 module manually

answered May 30 '18 at 23:51

Felix Fong

969
1
8
21

I have tried installing using npm install mysql2 and npm install -g mysql2. Is there another way to install module manually? – Larry Cherry Jun 05 '18 at 19:35
Use Git to clone the repo – Felix Fong Jun 06 '18 at 09:32

score -1 · Answer 14 · answered Apr 06 '22 at 12:24

If you are using Sequelize with Postgres then the issue will be in your config.json most likely because i ran into the same issue, in config.json my dialect was mysql and it was throwing an error so the correct one is

"development": {
    "username": "",
    "password": "",
    "database": "",
    "host": "127.0.0.1",
    "dialect": "postgres"
  },

score -2 · Answer 15 · answered Sep 04 '19 at 23:32

-2

Did you try saving the config.json file before to run sequelize db:migrate? In my case that was the i

answered Sep 04 '19 at 23:32

Doug

1

ERROR: Please install mysql2 package manually

15 Answers15

Linked