Optimistic concurrency: select subset of fields to apply optimistic concurrency to

[vkarpov15]

Do you want to request a feature or report a bug?

Feature

What is the current behavior?

The Schema optimisticConcurrency option is currently a boolean: optimistic concurrency is either on for the whole document, or off for the entire document. Would be nice to allow specifying either fields to enable optimistic concurrency:

const opts = { optimisticConcurrency: ['status'] };

new Schema({
  name: String,
  age: Number,
  status: { type: String, enum: ['PENDING', 'APPROVED', 'REJECTED' ] }
}, opts);

Or fields to exclude from optimistic concurrency:

const opts = { optimisticConcurrency: { exclude: ['name'] } };

new Schema({
  name: String,
  age: Number,
  status: { type: String, enum: ['PENDING', 'APPROVED', 'REJECTED' ] }
}, opts);

See #10583

If the current behavior is a bug, please provide the steps to reproduce.

What is the expected behavior?

What are the versions of Node.js, Mongoose and MongoDB you are using? Note that "latest" is not a version.

[BOVAGE]

Hi @vkarpov15 !

Please, is this feature live? It's not in the documentation.

[vkarpov15]

This feature has been live for years: https://mongoosejs.com/docs/6.x/docs/api/schema.html#options, https://thecodebarbarian.com/whats-new-in-mongoose-5-10-optimistic-concurrency.html

[BOVAGE]

optimisticConcurrency: bool - defaults to false. Set to true to enable optimistic concurrency.

The documentation does not mention the "select & exclude fields" functionalities mentioned in this issue.

[BOVAGE]

Thanks. It's actually working like it was described here. Just tested it.

[vkarpov15]

Added to docs and types in #15405, thanks for pointing out the oversight in our docs 👍