You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Kiko Beats f4b0cb6198
Merge pull request #37 from microlinkhq/dependabot/npm_and_yarn/mysql2-2.3.0
3 years ago
..
src docs: tweaks 3 years ago
test docs: tweaks 3 years ago
CHANGELOG.md chore(release): v1.1.1 3 years ago
README.md Update README.md 3 years ago
package.json Build(deps): Bump mysql2 from 2.2.5 to 2.3.0 3 years ago

README.md

@keyvhq/mysql keyv

MySQL/MariaDB storage adapter for Keyv.

Install

npm install --save keyv @keyvhq/mysql

Usage

const Keyv = require('keyv')

const keyv = new Keyv('mysql://user:pass@localhost:3306/dbname')
keyv.on('error', handleConnectionError)

You can specify a custom table with the table option and the primary key size with keySize.

e.g:

const keyv = new Keyv('mysql://user:pass@localhost:3306/dbname', {
  table: 'cache',
  keySize: 255
})

Note: Some MySQL/MariaDB installations won't allow a key size longer than 767 bytes. If you get an error on table creation try reducing keySize to 191 or lower.

License

@keyvhq/mysql © Microlink, Released under the MIT License.
Authored and maintained by Microlink with help from contributors.

microlink.io · GitHub @MicrolinkHQ · Twitter @microlinkhq