@keyv/sqlite

Table of Contents

SQLite storage adapter for Keyv

build codecov npm npm

SQLite storage adapter for Keyv.

Install

npm install --save keyv @keyv/sqlite
    

Usage

import Keyv from 'keyv';
    import KeyvSqlite from '@keyv/sqlite';
    
    const keyv = new Keyv(new KeyvSqlite('sqlite://path/to/database.sqlite'));
    keyv.on('error', handleConnectionError);
    

You can specify the table and busyTimeout option.

e.g:

import Keyv from 'keyv';
    import KeyvSqlite from '@keyv/sqlite';
    
    const keyvSqlite = new KeyvSqlite('sqlite://path/to/database.sqlite', {
      table: 'cache',
      busyTimeout: 10000
    });
    
    const keyv = new Keyv({ store: keyvSqlite }); 
    

You can also use a helper function to create Keyv with KeyvSqlite store.

import {createKeyv} from '@keyv/sqlite';
    
    const keyv = createKeyv('sqlite://path/to/database.sqlite');
    

License

MIT © Jared Wray

Table of Contents