C

Caching redis

Name: Caching redis
Author: Medusa

Redis Caching for Medusa

Included in @medusajs/medusa, no separate install needed

@medusajs/caching-redis

Documentation | Website

Building blocks for digital commerce

Redis Caching Module Provider for Medusa: stores the Caching Module's cached data in Redis, with tag-based invalidation and compression of large values. Use it in production so cached data is shared across Medusa instances. It ships with and is registered through the path.

At a glance


Package
Type	Module Provider (Caching Module)
Provider ID
Registered by default	No (on Medusa Cloud, registered when is set)
Import from

Installation

No installation needed. The provider is a dependency of . You need a running Redis server.

Usage

The Caching Module is behind the feature flag. Enable it with , then register the provider in the Caching Module's array in :

1import { defineConfig } from "@medusajs/framework/utils"
2
3module.exports = defineConfig({
// ...
modules: [
  {
    resolve: "@medusajs/medusa/caching",
    options: {
      providers: [
        {
          resolve: "@medusajs/medusa/caching-redis",
          id: "caching-redis",
          // makes this the default caching provider
          is_default: true,
          options: {
            redisUrl: process.env.CACHE_REDIS_URL,
          },
        },
      ],
    },
  },
],
23})

Configuration

Option	Type	Description	Default
		Required. The Redis connection URL.	-
		Options passed to the client. Passing them at the top level of is deprecated.	-
		Default time-to-live of cached entries, in seconds.
		Prefix added to all cache keys.
		Minimum size in bytes of a value before it's compressed.