https://github.com/junzhengca/mongoose-document-lock

Redis or In-Memory Document Lock for Mongoose
https://github.com/junzhengca/mongoose-document-lock

lock mongodb mongoose nosql plugin redis

Last synced: 14 days ago
JSON representation

Redis or In-Memory Document Lock for Mongoose

• Host: GitHub
• URL: https://github.com/junzhengca/mongoose-document-lock
• Owner: junzhengca
• License: other
• Created: 2018-10-27T14:02:02.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-27T16:12:47.000Z (about 6 years ago)
• Last Synced: 2024-12-04T13:45:37.568Z (23 days ago)
• Topics: lock, mongodb, mongoose, nosql, plugin, redis
• Language: JavaScript
• Homepage:
• Size: 9.77 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Mongoose Document Lock

Easy to use document lock plugin for mongoose. Both in-memory lock and Redis lock.

If you are implementing this lock, it is usually a good idea to remove the `versionKey` field in your schema, since you don't need an optimistic lock if you are using this library.

## Install

```

$ npm install mongoose-schema-lock

```

> Unfortunately mongoose-document-lock is taken :(

Then in your code

```js

mongoose.plugin(require('mongoose-schema-lock'));

```

By default, locks will be stored in-memory, if you wish to use Redis, you can pass an `node_redis` client instance in config (more on this later).

## Basic Usage

To lock a document, simply call `document.lock(callback)`.

```javascript

User.findOne({name: "Jun"}, function(err, user) {

    user.lock(function(release) {

        // Do you stuff here

        release();

    })

})

```

Once you lock a document, no other `.lock` calls will be able to obtain the lock for that specific document until you call `release()`.

You can find some demos within `/demo` folder.

## Use Promises

You can choose to use promises instead of callbacks, to do this, simply pass `promise: true` in configurations.

```javascript

mongoose.plugin(require('mongoose-schema-lock'), {promise: true});

User.findOne({name: "Jun"}, function(err, user) {

    user.lock().then(lock => {

        // Do your sutff

        lock.release();

    })

})

```

## Use Redis

If you have multiple servers load-balanced, or wish to share locks across applications, you might want to use Redis.

To use Redis, simply pass a Redis client in configurations.

```javascript

const redis = require("redis"),

      client = redis.createClient();

mongoose.plugin(require('../index'), {redis: client});

```

## Configurations

```

{

    redis: node_redis.client, // If this is set, locks will use Redis instead of in-memory

    promise: Boolean // If true, lock() will return a promise instead

}

```