Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/next-boost/hybrid-disk-cache
A hybrid disk cache library that utilized both the solid SQLite3 and file system.
https://github.com/next-boost/hybrid-disk-cache
cache disk-cache file-cache javascript sqlite3 typescript
Last synced: 1 day ago
JSON representation
A hybrid disk cache library that utilized both the solid SQLite3 and file system.
- Host: GitHub
- URL: https://github.com/next-boost/hybrid-disk-cache
- Owner: next-boost
- Created: 2020-04-17T08:34:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T13:31:18.000Z (4 months ago)
- Last Synced: 2024-12-26T02:12:05.532Z (8 days ago)
- Topics: cache, disk-cache, file-cache, javascript, sqlite3, typescript
- Language: TypeScript
- Size: 340 KB
- Stars: 21
- Watchers: 3
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://coveralls.io/github/next-boost/hybrid-disk-cache?branch=master) [](https://codeclimate.com/github/next-boost/hybrid-disk-cache/maintainability)
# hybrid-disk-cache
A hybrid disk cache library that utilizes both a solid SQLite3 database and the file system.
```bash
yarn add @next-boost/hybrid-disk-cache
```
When the value is larger than 10 kilobytes, it will be written to the file system; otherwise, it's saved in the SQLite3 database.
The benefits of using this hybrid cache are:
- Always uses the small footprint and high-performance SQLite3 index.
- Uses the file system for larger files. No need to run `vacuum` for releasing space.
Additional features:
- 100% test coverage
- Pure TypeScript
- Used in production with 300K keys
- SQLite3's indices are always used when searching for a key (which is FAST)
This hybrid idea is inspired by [`python-diskcache`](https://github.com/grantjenks/python-diskcache). We use it in our Python production stack, and it works just as well as expected.
## APIs
```javascript
// tbd, time before deletion: This is used to control how long a key
// should remain in the cache after expired (ttl)
// And `cache.purge` will delete all records with ttl + tbd < now
const cache = new Cache({ path, ttl, tbd })
// set. if ttl empty, use the cache's ttl
cache.set(key, value)
// set. will expire in 5 seconds
cache.set(key, value, 5)
// get
cache.get(key, defaultValue)
// del
cache.del(key)
// check cache availability and status
// status in 'miss' | 'stale' | 'hit'
const status = cache.has(key)
// if you want to serve even the stale value
if (cache.has(key) !== 'miss') {
const value = cache.get(key)
}
// if you only want the unexpired one
if (cache.has(key) === 'hit') {
const value = cache.get(key)
}
// delete all expired keys
cache.purge()
```
Check [`index.test.ts`](https://github.com/next-boost/hybrid-disk-cache/blob/master/test/index.test.ts) for examples.
## Benchmarks
With a series of 10B ~ 500KB data writing and reading, here are the results on a Samsung 860 EVO SATA SSD:
Here is the [benchmark source code](https://github.com/next-boost/hybrid-disk-cache/blob/master/src/bench.ts).
```
> cache located at: /tmp/hdc
> generating bench data from 10B to 500000B
> starting 3000 x 15 writes
done: 69.34 μs/record.
> starting 3000 x 15 reads
done: 26.65 μs/record.
```
## License
MIT. Copyright 2024, Rakuraku Jyo.