Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zcong1993/db-cache
https://github.com/zcong1993/db-cache
Last synced: about 23 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/zcong1993/db-cache
- Owner: zcong1993
- License: mit
- Created: 2021-07-30T09:05:30.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-06T08:26:27.000Z (3 months ago)
- Last Synced: 2024-08-31T23:04:29.788Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 340 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# db-cache
[](https://npmjs.com/package/@zcong/db-cache)
[](https://npmjs.com/package/@zcong/db-cache)
[](https://github.com/zcong1993/db-cache/actions/workflows/js-test.yml)
[](https://codecov.io/gh/zcong1993/db-cache)
> like [go-zero cache](https://go-zero.dev/cn/redis-cache.html), but for NodeJS
## Features
- **universal** Support [typeorm](https://github.com/typeorm/typeorm) and [sequelize-typescript](https://github.com/RobinBuschmann/sequelize-typescript) by default, alsoe support extensions
- **singleflight** Concurrent requests for the same instance will only call the database once
- **cache nonexist** Records that do not exist in the database will also be cached for a period of time
- **memory efficient** A record will only cache one complete data, and a unique key will cache one primary key reference
- **sharding** Out-of-the-box support for Redis cluster sharding by [@zcong/node-redis-cache](https://github.com/zcong1993/node-redis-cache)
- **metrics** Out-of-the-box support prometheus metrics by [@zcong/node-redis-cache](https://github.com/zcong1993/node-redis-cache)
## Install
```bash
$ yarn add @zcong/db-cache
# or npm
$ npm i @zcong/db-cache --save
```
## Usage
### Typeorm
```ts
@Entity()
export class Student {
@PrimaryGeneratedColumn()
studentId: number
@Column({
unique: true,
})
cardId: string
@Column()
age: number
}
const redis = new Redis()
const cache = new RedisCache({ redis, prefix: 'typeorm' })
const student = new TypeormCache(new TypeormAdaptor(StudentRepository), cache, {
disable: false,
expire: 60, // cache expire seconds
uniqueFields: ['cardId'], // cacheFindByUniqueKey method fields allowlist, filed must be unique
})
// findone with cache
console.log(await student.cacheFindByPk(1))
console.log(await student.cacheFindByUniqueKey('cardId', 'card-01'))
// updateone, will clear record cache
console.log(await student.cacheUpdateByPk(record))
// deleteone, will clear record cache
console.log(await student.deleteByPk(1))
// only clear record cache
console.log(await student.deleteCache(real))
```
### Sequelize-Typescript
```ts
@Table
export class Student extends Model> {
@Column({
primaryKey: true,
autoIncrement: true,
})
studentId: number
@Column({
unique: true,
})
cardId: string
@Column
age: number
}
const redis = new Redis()
const cache = new RedisCache({ redis, prefix: 'sequelize' })
const student = new TypeormCache(
new SequelizeTypescriptAdaptor(StudentRepository),
cache,
{
disable: false,
expire: 60, // cache expire seconds
uniqueFields: ['cardId'], // cacheFindByUniqueKey method fields allowlist, filed must be unique
}
)
// findone with cache
console.log(await student.cacheFindByPk(1))
console.log(await student.cacheFindByUniqueKey('cardId', 'card-01'))
// updateone, will clear record cache
console.log(await student.cacheUpdateByPk(record))
// deleteone, will clear record cache
console.log(await student.deleteByPk(1))
// only clear record cache
console.log(await student.deleteCache(real))
```
## License
MIT © zcong1993