MySQL

1. Connections

Connection example:

{
"name": "MySQL",
"server": "localhost",
"dialect": "MySQL",
"port": 3306,
"database": "test_db",
"username": "root",
"askForPassword": false,
"password": "root",
"connectionTimeout": 15
}

Using a socket file example:

{
"name": "MySQL",
"dialect": "MySQL",
"database": "test_db",
"username": "root",
"askForPassword": false,
"password": "root",
"connectionTimeout": 15,
"socketPath": "/path/to/mysqld.sock",
}

1.1 Specific Options

MySQL driver specific options can be passed using mysqlOptions settings.

{
"name": "MySQL",
"server": "localhost",
"dialect": "MySQL",
"port": 5433,
"database": "test_db",
"username": "root",
"askForPassword": false,
"password": "root",
"connectionTimeout": 15,
"mysqlOptions": {
... // options See section 2. mysqlOptions
}
}

2. mysqlOptions

We have 2 options of connectors for MySQL. You can chose which one to use by change the setting mysqlOptions.authProtocol. The allowed values are default and xprotocol, we use default by default since is the most often used.

Extra options can be used as defined in the connectors documentation.

They will be passed to the pool constructor directly. See https://github.com/mtxr/vscode-sqltools/blob/master/packages/core/dialect/mysql/index.ts .

Know Errors and How to Fix

MySQL 8 and ER_NOT_SUPPORTED_AUTH_MODE

Potential solutions:

  • Ensure you've set authProtocol to xprotocol

  • Add a trailing 0 to the port. See the MySQL Guide to Ports

Example configuration:

{
"sqltools.connections": [
{
"askForPassword": true,
"connectionTimeout": 30,
"dialect": "MySQL",
"name": "LocalHost",
"port": 33060,
"server": "127.0.0.1",
"username": "root",
"mysqlOptions": {
"authProtocol": "xprotocol"
}
}
]
}