https://github.com/ratson/cacheman-mongodb
https://github.com/ratson/cacheman-mongodb
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ratson/cacheman-mongodb
- Owner: ratson
- Created: 2017-05-09T11:30:30.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-04-20T12:08:50.000Z (about 7 years ago)
- Last Synced: 2025-03-09T12:33:37.086Z (over 1 year ago)
- Language: JavaScript
- Size: 53.7 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cacheman-mongodb
[](http://badge.fury.io/js/cacheman-mongodb)
MongoDB standalone caching library for Node.JS and also cache engine for [cacheman](https://github.com/cayasso/cacheman).
## This is a fork
Fork from https://github.com/cayasso/cacheman-mongo with the following differences,
- Removed `pre-commit` from `dependencies`.
- Updated `dependencies`.
## Instalation
``` bash
npm install cacheman-mongodb --save
```
## Usage
```javascript
var CachemanMongo = require('cacheman-mongodb');
var cache = new CachemanMongo();
// set the value
cache.set('my key', { foo: 'bar' }, function (error) {
if (error) throw error;
// get the value
cache.get('my key', function (error, value) {
if (error) throw error;
console.log(value); //-> {foo:"bar"}
// delete entry
cache.del('my key', function (error){
if (error) throw error;
console.log('value deleted');
});
});
});
```
## API
### CachemanMongo([options])
Create `cacheman-mongodb` instance. `options` are mongo valid options including `port`, `host`, `database` and `collection`.
```javascript
var options = {
port: 9999,
host: '127.0.0.1',
username: 'beto',
password: 'my-p@ssw0rd'
database: 'my-cache-db',
collection: 'my-collection',
compression: false
};
var cache = new CachemanMongo(options);
```
You can also pass a valid mongodb connection string as first arguments like this:
```javascript
var options = {
collection: 'account'
};
var cache = new CachemanMongo('mongodb://127.0.0.1:27017/blog', options);
```
Or pass a mongodb db instance directly as client:
```javascript
MongoClient.connect('mongodb://127.0.0.1:27017/blog', function (err, db) {
var cache = new CachemanMongo(db, { collection: 'account' });
// or
cache = new CachemanMongo({ client: db, collection: 'account' });
});
```
#### Cache Value Compression
MongoDB has a 16MB document size limit, and, currently, does not have built in support for compression. You can enable cache value compression for large Buffers by setting the `compression` options to `true`, this will use the native node `zlib` module to compress with `gzip`. It only compresses Buffers because of the complexity in correctly decompressing and deserializing the variety of data structures and string encodings.
Thanks to @Jared314 for adding this [feature](https://github.com/cayasso/cacheman-mongo/pull/2).
```javascript
var cache = new Cache({ compression: true });
cache.set('test1', new Buffer("something big"), function (err) {...});
```
### cache.set(key, value, [ttl, [fn]])
Stores or updates a value.
```javascript
cache.set('foo', { a: 'bar' }, function (err, value) {
if (err) throw err;
console.log(value); //-> {a:'bar'}
});
```
Or add a TTL(Time To Live) in seconds like this:
```javascript
// key will expire in 60 seconds
cache.set('foo', { a: 'bar' }, 60, function (err, value) {
if (err) throw err;
console.log(value); //-> {a:'bar'}
});
```
### cache.get(key, fn)
Retreives a value for a given key, if there is no value for the given key a null value will be returned.
```javascript
cache.get('foo', function (err, value) {
if (err) throw err;
console.log(value);
});
```
### cache.del(key, [fn])
Deletes a key out of the cache.
```javascript
cache.del('foo', function (err) {
if (err) throw err;
// foo was deleted
});
```
### cache.clear([fn])
Clear the cache entirely, throwing away all values.
```javascript
cache.clear(function (err) {
if (err) throw err;
// cache is now clear
});
```
## Run tests
``` bash
$ make test
```
## License
(The MIT License)
Copyright (c) 2015 Jonathan Brumley <cayasso@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.