Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shikhar97/prisma-cache
A Prisma extension for caching database queries
https://github.com/shikhar97/prisma-cache
cache extension middleware orm prisma redis server-side-cache
Last synced: about 1 month ago
JSON representation
A Prisma extension for caching database queries
- Host: GitHub
- URL: https://github.com/shikhar97/prisma-cache
- Owner: Shikhar97
- License: mit
- Created: 2024-09-17T18:40:02.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-24T04:52:37.000Z (about 2 months ago)
- Last Synced: 2024-10-09T17:43:14.677Z (about 1 month ago)
- Topics: cache, extension, middleware, orm, prisma, redis, server-side-cache
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/prisma-cache-extension
- Size: 195 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Prisma Cache Extension
[](https://github.com/Shikhar97/prisma-cache/actions/workflows/build.yml)
The `prisma-cache-extension` is a robust package designed to optimize database performance by improving access times,
streamlining cache management, and offering flexible tools for efficient maintenance.
### Databases supported:
- Redis
### **Installation**
##### **Using npm:**
```bash
npm install prisma-cache-extension
```
##### **Using yarn:**
```bash
yarn add prisma-cache-extension
```
### Initializtion of setup
```javascript
import {PrismaClient} from '@prisma/client';
import {Redis} from 'ioredis';
import {
PrismaCacheExtension,
} from 'prisma-cache-extension';
// Create a Redis client
const redis = new Redis({
host: env.REDIS_HOST_NAME, // Specify Redis host name
port: env.REDIS_PORT, // Specify Redis port
});
```
### Cache Client Config
This configuration is required for enabling caching.
```javascript
const cache: CacheConfig = {
storage: {
type: 'redis',
options: {
client: redis,
invalidation: {
referencesTTL: 15
}, // Invalidation settings
// Logger for cache events
log: console,
},
},
};
```
### Create Prisma Extended Client
```javascript
// Create a Prisma client instance
const prisma = new PrismaClient();
return prisma.$extends(
PrismaExtensionRedis(30, {
cache, redis
}));
```
### Use case 1: Caching Configuration
```javascript
// Example: Query a user and cache the result when caching is enabled
prisma.user.findUnique({
where,
cache: {
key: JSON.stringify(where)
}
});
// Disable caching for this operation, if not mentioned
extendedPrisma.user.findFirst({
where: {userId: id},
});
```
### Use case 2: Invalidation of Cached Data
```javascript
// Example: Update a user and invalidate related cache keys
extendedPrisma.user.update({
where: {id},
data: {username},
uncache: {
uncacheKey: "*",
models: ["user", "userprofile"],
hasPattern: true, // Use wildcard pattern for key matching
},
});
```
### Dependencies
- `ioredis`
- `micromatch`
- `async-cache-dedupe`
### Key Features
### Why Choose `prisma-cache-extension`?
**Effortless Query Caching:** Seamlessly cache your Prisma query results in Redis with minimal setup required.
**Targeted Cache Invalidation:** Easily invalidate specific Prisma queries to maintain accurate and up-to-date data.
**Granular Control:** Adjust caching and invalidation settings for each query, giving you precise control over caching
behavior.
**Dynamic Invalidation Strategies:** Apply effective cache invalidation strategies to keep your cached data current.
**Versatile Maintenance:** Leverage general-purpose functions to efficiently manage Redis or Dragonfly databases.
---
**Benefits of `prisma-cache-extension`:**
- **Unified Dependencies:** Replace multiple packages with a single `prisma-cache-extension` dependency, simplifying
your setup.
- **Streamlined Maintenance:** Enjoy centralized updates and improvements, making maintenance more straightforward.
- **Optimized Codebase:** Reduce redundancy and enhance performance by consolidating your codebase.
- **Community Engagement:** Connect with the `prisma-cache-extension` community for support and collaborative
development.
Upgrade to `prisma-cache-extension` today for a more efficient and integrated Redis caching solution. If this proves
helpful, consider giving it a star! [⭐ Star Me!](https://github.com/Shikhar97/prisma-cache.git)