mongoose Soft delete using object ID

Question

So I am trying to use mongoose-delete plugin to soft delete data in mongoDB, but the request has only got the object ID for the mongoose object. So in order to "soft-delete" the data, I am having to first do a findOne, and then use the delete function on it. Is there any plugin or function which can let me soft-delete this data using only the object ID? instead of using two hits to the DB. The data is critical, hence only need a soft delete option, and not a hard delete. And I cannot use the common update function, need some plugin, or node module to do this for me.

Looking at the documentation for bulk operations for that plugin, wouldn't it just be `MyModel.delete({_id: id}, function (err, result) { ... });`? — JohnnyHK, Apr 07 '17 at 12:27

score 17 · Answer 1 · answered May 25 '20 at 14:53

you don't need any libraries, it's easy to write yourself using middleware and $isDeleted document method

example plugin code:

import mongoose from 'mongoose';

export type TWithSoftDeleted = {
  isDeleted: boolean;
  deletedAt: Date | null;
}

type TDocument = TWithSoftDeleted & mongoose.Document;

const softDeletePlugin = (schema: mongoose.Schema) => {
  schema.add({
    isDeleted: {
      type: Boolean,
      required: true,
      default: false,
    },
    deletedAt: {
      type: Date,
      default: null,
    },
  });

  const typesFindQueryMiddleware = [
    'count',
    'find',
    'findOne',
    'findOneAndDelete',
    'findOneAndRemove',
    'findOneAndUpdate',
    'update',
    'updateOne',
    'updateMany',
  ];

  const setDocumentIsDeleted = async (doc: TDocument) => {
    doc.isDeleted = true;
    doc.deletedAt = new Date();
    doc.$isDeleted(true);
    await doc.save();
  };

  const excludeInFindQueriesIsDeleted = async function (
    this: mongoose.Query<TDocument>,
    next: mongoose.HookNextFunction
  ) {
    this.where({ isDeleted: false });
    next();
  };

  const excludeInDeletedInAggregateMiddleware = async function (
    this: mongoose.Aggregate<any>,
    next: mongoose.HookNextFunction
  ) {
    this.pipeline().unshift({ $match: { isDeleted: false } });
    next();
  };

  schema.pre('remove', async function (
    this: TDocument,
    next: mongoose.HookNextFunction
  ) {
    await setDocumentIsDeleted(this);
    next();
  });

  typesFindQueryMiddleware.forEach((type) => {
    schema.pre(type, excludeInFindQueriesIsDeleted);
  });

  schema.pre('aggregate', excludeInDeletedInAggregateMiddleware);
};

export {
  softDeletePlugin,
};

you can use it as a global plugin or as a plugin for speciffed schema

do we have such a example for nestjs/mongoose ? – Nihal Chandwani Aug 09 '23 at 08:11 — Nihal Chandwani, Aug 09 '23 at 08:11

Dominik Dragičević · Answer 2 · 2017-04-07T11:41:16.160

2

You can use mongoose-delete: https://github.com/dsanel/mongoose-delete.

It provides new delete function.

edited Apr 07 '17 at 11:41

answered Apr 07 '17 at 11:22

Dominik Dragičević

195
9

score 0 · Answer 3 · answered Dec 02 '18 at 05:32

0

You can use Mongoosejs Soft delete. Look at the code at GitHub Repository.

answered Dec 02 '18 at 05:32

Parth Patel

3,937
2
27
44

score 0 · Answer 4 · answered May 02 '21 at 10:28

0

I know it's a bit late. But, I hope this can help someone out there

Here's an npm package that's compatible with JS & TS for soft deleting elements and restoring them using mongoose

https://www.npmjs.com/package/soft-delete-plugin-mongoose

answered May 02 '21 at 10:28

nour karoui

33
5

mongoose Soft delete using object ID

4 Answers4