docs: Caching Module (#13701)

* standard docs for caching module + deprecated cache module

* added guides for creating + using, and overall changes from cache to caching

* fix details related to redis provider

* fix build errors

* fix build error

* fixes

* add guides to sidebar

* add sidebar util

* document query + index

* moved cache tag conventions

* fix build errors

* added migration guide

* added memcached guide

* fixes

* general fixes and updates

* updated reference

* document medusa cache

* small fix

* fixes

* remove cloud cache

* revert edit dates changes

* revert edit dates

* small update
This commit is contained in:
Shahed Nasser
2025-10-21 10:34:27 +03:00
committed by GitHub
parent eefda0edce
commit 76f9da5ef4
50 changed files with 10530 additions and 145 deletions
@@ -14,6 +14,14 @@ export const metadata = {
In this guide, youll learn how to create a Cache Module.
{/* TODO add link */}
<Note title="Deprecation Notice">
The Cache Module is deprecated starting from [Medusa v2.11.0](https://github.com/medusajs/medusa/releases/tag/v2.11.0). [Create a Caching Module Provider](#) instead.
</Note>
## 1. Create Module Directory
Start by creating a new directory for your module. For example, `src/modules/my-cache`.
@@ -12,6 +12,12 @@ This module is helpful for development or when youre testing out Medusa, but
For production, its recommended to use modules like [Redis Cache Module](../redis/page.mdx).
<Note title="Deprecation Notice">
The In-Memory Cache Module is deprecated starting from [Medusa v2.11.0](https://github.com/medusajs/medusa/releases/tag/v2.11.0). Use the [Caching Module](../../caching/page.mdx) instead.
</Note>
---
## Register the In-Memory Cache Module
@@ -8,6 +8,12 @@ export const metadata = {
In this document, you'll learn what a Cache Module is and how to use it in your Medusa application.
<Note title="Deprecation Notice">
The Cache Module is deprecated starting from [Medusa v2.11.0](https://github.com/medusajs/medusa/releases/tag/v2.11.0). Use the [Caching Module](../caching/page.mdx) instead.
</Note>
## What is a Cache Module?
A Cache Module is used to cache the results of computations such as price selection or various tax calculations.
@@ -8,9 +8,9 @@ export const metadata = {
The Redis Cache Module uses Redis to cache data in your store. In production, it's recommended to use this module.
<Note title="Using Cloud?">
<Note title="Deprecation Notice">
Our Cloud offering automatically provisions a Redis instance and configures the Redis Cache Module for you. Learn more in the [Redis](!cloud!/redis) Cloud documentation.
The Redis Cache Module is deprecated starting from [Medusa v2.11.0](https://github.com/medusajs/medusa/releases/tag/v2.11.0). Use the [Redis Caching Module Provider](../../caching/providers/redis/page.mdx) instead.
</Note>
@@ -32,10 +32,6 @@ export const highlights = [
]
```ts title="medusa-config.ts" highlights={highlights}
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [