@keyvhq/mysql

MySQL/MariaDB storage adapter for Keyv

Usage no npm install needed!

<script type="module">
  import keyvhqMysql from 'https://cdn.skypack.dev/@keyvhq/mysql';
</script>

README

@keyvhq/mysql keyv

MySQL/MariaDB storage adapter for Keyv.

Install

npm install --save @keyvhq/core @keyvhq/mysql

Usage

const KeyvMysql = require('@keyvhq/redis')
const Keyv = require('@keyvhq/core')

const keyv = new Keyv({ 
  store: new KeyvMysql('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:

const KeyvMysql = require('@keyvhq/redis')
const Keyv = require('@keyvhq/core')

const keyv = new Keyv({ 
  store: new KeyvMysql('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 © Luke Childs, Released under the MIT License.
Maintained by Microlink with help from contributors.

microlink.io · GitHub @MicrolinkHQ · Twitter @microlinkhq