Cache drivers

Some options are common to all drivers. For more information about them, see the options page. Here we will rather list the specifics of each driver.

Redis

You will need to install ioredis to use this driver.

The Redis driver can be used with many different providers:

Upstash
Vercel KV
DragonFly
Redis Cluster

The driver uses the ioredis library under the hood. So all possible ioredis configurations are assignable when creating the bentocache driver. Feel free to look at their documentation for more details.

import { BentoCache, bentostore } from 'bentocache'
import { redisDriver } from 'bentocache/drivers/redis'

const bento = new BentoCache({
  default: 'redis',
  stores: {
    redis: bentostore().useL2Layer(redisDriver({
      connection: { host: '127.0.0.1', port: 6379 }
    }))
  }
})

It is also possible to directly pass an Ioredis instance to reuse the connection.

import { Redis } from 'ioredis'

const ioredis = new Redis()

const bento = new BentoCache({
  default: 'redis',
  stores: {
    redis: bentostore().useL2Layer(redisDriver({
      connection: ioredis
    }))
  }
})

Option	Description	Default
`connection`	The connection options to use to connect to Redis or an instance of `ioredis`	N/A

Filesystem

The filesystem driver will store your cache in a distributed way in several files/folders on your filesystem.

import { BentoCache, bentostore } from 'bentocache'
import { fileDriver } from "bentocache/drivers/file";

const bento = new BentoCache({
  default: 'file',
  stores: {
    redis: bentostore().useL2Layer(
      fileDriver({
        directory: './cache',
        pruneInterval: '1h'
    }))
  }
})

Option	Description	Default
`directory`	The directory where the cache files will be stored.	N/A
`pruneInterval`	The interval in milliseconds to prune expired entries. false to disable.	false

Prune Interval

Since the filesystem driver does not have a way to automatically prune expired entries, you can set a pruneInterval to automatically prune expired entries. By setting this option, the driver will launch a worker thread that will clean up the cache at the specified interval.

Memory

The memory driver will store your cache directly in memory.

Use node-lru-cache under the hood.

import { BentoCache, bentostore } from 'bentocache'
import { memoryDriver } from 'bentocache/drivers/memory'

const bento = new BentoCache({
  default: 'memory',
  stores: {
    memory: bentostore().useL1Layer(memoryDriver({
      maxSize: 10 * 1024 * 1024,
      maxItems: 1000
    }))
  }
})

Option	Description	Default
`maxSize`	The maximum size of the cache in bytes.	N/A
`maxItems`	The maximum number of entries that the cache can contain. Note that fewer items may be stored if you are also using `maxSize` and the cache is full.	N/A
`maxEntrySize`	The maximum size of a single entry in bytes.	N/A

DynamoDB

DynamoDB is also supported by bentocache. You will need to install @aws-sdk/client-dynamodb to use this driver.

import { BentoCache, bentostore } from 'bentocache'
import { dynamoDbDriver } from 'bentocache/drivers/dynamodb'

const bento = new BentoCache({
  default: 'dynamo',
  stores: {
    dynamo: bentostore().useL2Layer(dynamoDbDriver({
      endpoint: '...',
      region: 'eu-west-3',
      table: {
        name: 'cache' // Name of the table
      },

      // Credentials to use to connect to DynamoDB
      credentials: {
        accessKeyId: '...',
        secretAccessKey: '...'
      }
    }))
  }
})

You will also need to create a DynamoDB table with a string partition key named key. You must create this table before starting to use the driver.

Make sure to also enable Time To Live (TTL) on the table, on the ttl attribute. This will allow DynamoDB to automatically delete expired items.

Option	Description	Default
`table.name`	The name of the table that will be used to store the cache.	`cache`
`credentials`	The credentials to use to connect to DynamoDB.	N/A
`endpoint`	The endpoint to use to connect to DynamoDB.	N/A
`region`	The region to use to connect to DynamoDB.	N/A

Be careful with the .clear() function of the DynamoDB driver. We do not recommend using it. Dynamo does not offer a "native" clear, so we are forced to make several API calls to: retrieve the keys and delete them, 25 by 25 (max per BatchWriteItemCommand).

So using this function can be costly, both in terms of execution time and API request cost. And also pose rate-limiting problems. Use at your own risk.

Databases

We offer several drivers to use a database as a cache. The database store should use an adapter for your database. Out of the box, we support Knex and Kysely to interact with the database. Knex and Kysely support many databases: SQLite, MySQL, PostgreSQL, MSSQL, Oracle, and more.

Note that you can easily create your own adapter by implementing the DatabaseAdapter interface if you are using another library not supported by Bentocache. See the documentation for more details.

All SQL drivers accept the following options:

Option	Description	Default
`tableName`	The name of the table that will be used to store the cache.	`bentocache`
`autoCreateTable`	If the cache table should be automatically created if it does not exist.	`true`
`connection`	An instance of `knex` or `Kysely` based on the driver.	N/A
`pruneInterval`	The Duration in milliseconds to prune expired entries.	false

Knex

You must provide a Knex instance to use the Knex driver. Feel free to check the Knex documentation for more details about the configuration. Knex support many databases : SQLite, MySQL, PostgreSQL, MSSQL, Oracle, and more.

import knex from 'knex'
import { BentoCache, bentostore } from 'bentocache'
import { knexDriver } from 'bentocache/drivers/knex'

const db = knex({
  client: 'pg',
  connection: { 
    port: 5432,
    user: 'root', 
    password: 'root', 
    database: 'postgres', 
  }
})

const bento = new BentoCache({
  default: 'pg',
  stores: {
    pg: bentostore().useL2Layer(knexDriver({ connection: db }))
  }
})

Kysely

You must provide a Kysely instance to use the Kysely driver. Feel free to check the Kysely documentation for more details about the configuration. Kysely support the following databases : SQLite, MySQL, PostgreSQL and MSSQL.

You will need to install mysql2 to use this driver.

import { Kysely } from 'kysely'
import { BentoCache, bentostore } from 'bentocache'
import { mysqlDriver } from 'bentocache/drivers/kysely'

const db = new Kysely<Database>({ dialect })

const bento = new BentoCache({
  default: 'pg',
  stores: {
    pg: bentostore().useL2Layer(kyselyStore({ connection: db }))
  }
})

Orchid ORM

You must provide a Orchid ORM instance to use the Orchid driver. Feel free to check the Orchid ORM documentation for more details about the configuration. Orchid support the following databases : PostgreSQL.

You will need to install orchid-orm to use this driver.

import { createDb } from 'orchid-orm'
import { BentoCache, bentostore } from 'bentocache'
import { orchidDriver } from 'bentocache/drivers/orchid'

export const db = createDb({ databaseURL: `postgresql://${DB_USER}:${DB_PASS}@${DB_HOST}:${DB_PORT}/${DB_NAME}` })

export const bento = new BentoCache({
  default: 'cache',
  stores: {
    cache: bentostore().useL2Layer(orchidDriver({ connection: db }))
  }
})