https://github.com/ilovepixelart/ts-cache-mongoose
Cache plugin for mongoose Queries and Aggregate (in-memory, redis)
https://github.com/ilovepixelart/ts-cache-mongoose
aggregate backend cache db memory mongdodb mongo mongoose nodejs nosql plugin query redis schema store ts ts-cache-mongoose ttl typescript
Last synced: about 2 months ago
JSON representation
Cache plugin for mongoose Queries and Aggregate (in-memory, redis)
- Host: GitHub
- URL: https://github.com/ilovepixelart/ts-cache-mongoose
- Owner: ilovepixelart
- License: mit
- Created: 2023-04-26T21:35:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-05T09:46:16.000Z (about 2 months ago)
- Last Synced: 2025-04-06T15:48:50.542Z (about 2 months ago)
- Topics: aggregate, backend, cache, db, memory, mongdodb, mongo, mongoose, nodejs, nosql, plugin, query, redis, schema, store, ts, ts-cache-mongoose, ttl, typescript
- Language: TypeScript
- Homepage:
- Size: 1020 KB
- Stars: 27
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ts-cache-mongoose
Cache query and aggregate in mongoose using in-memory or redis
[](https://www.npmjs.com/package/ts-cache-mongoose)
[](https://www.npmjs.com/package/ts-cache-mongoose)
[](https://github.com/ilovepixelart/ts-cache-mongoose/blob/main/LICENSE)
\
[](https://sonarcloud.io/summary/new_code?id=ilovepixelart_ts-cache-mongoose)
[](https://sonarcloud.io/summary/new_code?id=ilovepixelart_ts-cache-mongoose)
\
[](https://sonarcloud.io/summary/new_code?id=ilovepixelart_ts-cache-mongoose)
[](https://sonarcloud.io/summary/new_code?id=ilovepixelart_ts-cache-mongoose)
[](https://sonarcloud.io/summary/new_code?id=ilovepixelart_ts-cache-mongoose)
## Motivation
ts-cache-mongoose is a plugin for mongoose
\
Caching queries is a good way to improve performance of your application
## Supports and tested with
```json
{
"node": "18.x || 20.x || 22.x",
"mongoose": ">=6.6.x || 7.x || 8.x",
}
```
## Features
- In-memory caching
- Redis caching
- Cache expiration
- Cache invalidation
- Cache key generation
- Cache key prefix
- Query caching
- Aggregate caching
- Supports ESM and CommonJS
## Installation
- Locally inside your project
```bash
npm install ts-cache-mongoose
pnpm add ts-cache-mongoose
yarn add ts-cache-mongoose
bun add ts-cache-mongoose
```
- This plugin requires mongoose `>=6.6.x || 7.x || 8.x` to be installed as a peer dependency
```bash
# For latest mongoose 6
npm install mongoose@6
pnpm add mongoose@6
yarn add mongoose@6
bun add mongoose@6
# For latest mongoose 7
npm install mongoose@7
pnpm add mongoose@7
yarn add mongoose@7
bun add mongoose@7
# For latest mongoose 8
npm install mongoose@8
pnpm add mongoose@8
yarn add mongoose@8
bun add mongoose@8
```
## Example
```typescript
// On your application startup
import mongoose from 'mongoose'
import cache from 'ts-cache-mongoose'
// In-memory example
const instance = cache.init(mongoose, {
defaultTTL: '60 seconds',
engine: 'memory',
debug: true, // Debug mode enables hit/miss logs in console, not for production use
})
// OR
// Redis example
const instance = cache.init(mongoose, {
defaultTTL: '60 seconds',
engine: 'redis',
engineOptions: {
host: 'localhost',
port: 6379,
},
debug: true, // Debug mode enables hit/miss logs in console, not for production use
})
// Connect to your database
mongoose.connect('mongodb://localhost:27017/my-database')
// Somewhere in your code
const users = await User.find({ role: 'user' }).cache('10 seconds').exec()
// Cache hit
const users = await User.find({ role: 'user' }).cache('10 seconds').exec()
const book = await Book.findById(id).cache('1 hour').exec()
const bookCount = await Book.countDocuments().cache('1 minute').exec()
const authors = await Book.distinct('author').cache('30 seconds').exec()
const books = await Book.aggregate([
{
$match: {
genre: 'fantasy',
},
},
{
$group: {
_id: '$author',
count: { $sum: 1 },
},
},
{
$project: {
_id: 0,
author: '$_id',
count: 1,
},
}
]).cache('1 minute').exec()
// Cache invalidation
// To clear all cache, don't use in production unless you know what you are doing
await instance.clear()
// Instead use custom cache key
const user = await User.findById('61bb4d6a1786e5123d7f4cf1').cache('1 minute', 'some-custom-key').exec()
await instance.clear('some-custom-key')
```
## Check my other projects
- [ts-migrate-mongoose](https://github.com/ilovepixelart/ts-migrate-mongoose) - Migration framework for mongoose
- [ts-patch-mongoose](https://github.com/ilovepixelart/ts-patch-mongoose) - Patch history & events plugin for mongoose