Cache Invalidation at model level extended features for sequelize-typescript (v2.1.0 or later)
$ npm install base-repo sequelize@^6.x.x sequelize-typescript@^2.x.xYour tsconfig.json needs the following flags:
"target": "es6", // or a more recent ecmascript version
"experimentalDecorators": true,
"emitDecoratorMetadata": truemake sure defined all model of sequelize at this level and
@Module({
...
imports: [
RedisModule.register(cacheConfig() as RedisModuleOptions),
SequelizeCacheModule.register({
defaultTTL: 5, // DEFINE TTL FOR ALL PROJECT seconds
// DEFINE HOW TO GET CACHE FROM GIVEN KEY
callbackGet: async ({ key }) => CacheConfigModule.store.get(key),
// DEFINE HOW TO INVALIDATE CACHE FROM GIVEN KEY
callbackInvalidate: ({ key }) => (CacheConfigModule?.store?.del?.(key) || null),
// DEFINE HOW TO SET CACHE FROM GIVEN KEY VALUE AND TTL
callbackSet: async ({ key, value, ttl }) => CacheConfigModule.store.set(key, value, { ttl }),
callbackGetKey: async ({ keyPattern }) => CacheConfigModule.store.keys?.(`${process.env.CACHE_PREFIX}${keyPattern}`) || [],
}),
SequelizeModule.forRoot({
...DBOptions,
}),
...
],
})
export class CacheConfigModule {
static store: Store;
constructor(@Inject(CACHE_MANAGER) private store: Store) {
CacheConfigModule.store = this.store;
}
}the @Cache is used for defined ttl and cache for findOne and automatically invalidate findOneCache/findByPkCache
| Options | Description |
|---|---|
options.ttl |
set TTL for this model, this will override ttl at module (Optional) |
@Cache({
ttl: 100,
})
@Table()
export class DmCourse extends BaseModel {}@Cache({
ttl: 100,
})
@Table()
export class DmCourse extends BaseModel {
// default `{modelName} data not found'
static notFoundMessage = 'your model not found message';
/**
* @default `updatedAt`
* @description `this is for checking newest updated timestamp for cached list.`
*/
static onUpdateAttribute = 'modifiedAt'
@UpdatedAt
@Column({ field: 'UpdatedAt' })
modifiedAt: Date;
}the Model need to extends BaseModel
interface DmCourseAtt {
id: number
name: string;
type: number;
}
interface DmCreateAtt extends DmCourseAtt Omit<DmCourseAtt, 'id'>
@Cache({
ttl: 100,
})
@Table()
export class DmCourse extends BaseModel<DmCourseAtt, DmCreateAtt> {}for strict type that can used at default function from sequelize-typescript can be planted at generic type 2 and 3 sequelize-typescript strict
cacheOptions : FindOptionslimited findOptions from sequelize-typescript
// file: DmCourse.ts
@Cache() //default ttl module
@Table()
export class DmCourse extends BaseModel<DmCourseAtt, DmCreateAtt> {}
...
// file: Course.controller.ts
class CourseController {
async getCourse() {
const course = await DmCourse.findOneCache({
where: {
isDeleted: false,
name: 'Math',
},
rejectOnEmpty: true, // use model default throw, or use use throw Exception
// rejectOnEmpty: new BadRequestException('message')
})
}
}- you have to use All defined cache attributes that has name
byIsDeletedAndName - every query that outside of defined cache will not executed
| Options | Description |
|---|---|
cacheOptions |
some function from Sequelize FindOptions |
cacheOptions.ttl |
set TTL for this cache key, this will override ttl at module and model (Optional), (Required) when has include Query |
cacheOptions.rejectOnEmpty |
will throw error when set true (Optional) |
class CourseController {
async getCourse() {
const course = await DmCourse.findByPkCache(1, {
ttl: 100,
});
}
}- find By Primary Cache will invalidate when any destroy or update
| Options | Description |
|---|---|
id |
value of id |
cacheOptions |
some function from Sequelize FindOptions |
cacheOptions.ttl |
set TTL for this cache key, this will override ttl at module and model (Optional), (Required) when has include Query |
cacheOptions.rejectOnEmpty |
will throw error when set true (Optional) |
class CourseController {
async getCourse() {
const course = await DmCourse.findAllCache({
ttl: 100,
attributes: ['id','name','type']
where: {
isDeleted: false,
},
order: [
['id','desc']
],
include: [
{
// any association
}
],
limit: 10,
})
}
}- find all data and Cache it when has value. will invalidate and update cache when ttl reach 0 or when get max updates or count is different from before
| Options | Description |
|---|---|
cacheOptions.ttl |
set TTL for this cache key, this will override ttl at module and model (Optional), (Required) when has include Query |
{...cacheOptions} |
is same with FindOptions from sequelize-typescript |
- Author - Fauzi Fadhillah
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent