Soft delete for MongoEngine
Project description
MongoEngine Soft Delete
Make a document soft deletable.
Installation
Install mongoengine-softdelete
through pip as usual:
pip install mongoengine-softdelete
Usage
Here is an example on how to use a soft deletable document:
from mongoengine_softdelete.document import SoftDeleteNoCacheDocument
class IceCream(SoftDeleteNoCacheDocument):
meta = {
'collection': 'ice_cream',
'soft_delete': {'deleted': True},
'indexes': [ 'flavor' ],
'strict': False
}
flavor = fields.StringField(required=True)
color = fields.StringField(required=True)
price = fields.FloatField(default=0)
created_at = fields.DateTimeField()
# Declare the field used to check if the record is soft deleted
# this field must also be reported in the `meta['soft_delete']` dict
deleted = fields.BooleanField(default=False)
# Save a new document
ice = IceCream(flavor="Vanilla", color="White").save()
assert not ice.is_soft_deleted
# Mark the document as soft deleted
ice.soft_delete()
assert len(IceCream.objects()) == 0
assert ice.is_soft_deleted
# Soft undelete the document
ice.soft_undelete()
assert len(IceCream.objects()) > 0
assert not ice.is_soft_deleted
Tests
The test suit requires that you run a local instance of MongoDB on the standard
port and have pytest
installed.
You can run tests with the pytest
command or with make test
.
Linting is done with mypy
and pycodestyle
with the make lint
command.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mongoengine-softdelete-0.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e1cfe0cf5a01684504bce163f0b009bb2567c69d499d128328193556f0d5e28 |
|
MD5 | 80a3c6136cb3801dc1a4532930827bab |
|
BLAKE2b-256 | ccc0222dfd792b55bd62d1ab6d6f0e376c4ddc5e50bb2764b176b3b94c9536e0 |
Close
Hashes for mongoengine_softdelete-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44554ef3a55dfe0b051469ad4e21c16e026e1c703d946b6103301ef5f122dd24 |
|
MD5 | 1ae790de0e5e8c10898e947b79a85aeb |
|
BLAKE2b-256 | bbafc7a20f0f5f277cac83601e9a9a26899cfc3c3da0c000bf84b451265ef125 |