sqla-paranoid3 0.1.4

Installation

pip install sqla-paranoid3

Usage

from paranoid.models import (
    Model,
    Query,
    Session,
)

class User(Model):
    __tablename__ = 'user'
    __softdelete__ = True

    id = Column(Integer, primary_key=True)
    name = Column(String)


engine = create_engine('sqlite://')
session = sessionmaker(engine, class_=Session, query_cls=Query)()

session.query(User)

# retrieve a user that has not been deleted (assuming ID is 1)
user = User.query.get(1)

# soft delete the user
user.delete()

# query for a soft deleted user
user = User.query.with_deleted().get(1)
# or
user = User.query.with_deleted().filter_by(id=1).first()

# restore the user (undo soft delete)
user.restore()

# save the changes
session.add(user)
session.commit()

# hard delete the user
session.delete(user, hard=True)
session.commit()

Flask

Paranoid3 comes with a ready to use Flask extension built on top of Flask-SQLAlchemy:

from paranoid.flask import SQLAlchemy


db = SQLAlchemy(app)
# or you can use the factory style of initialisation
db = SQLAlchemy()
db.init_app(app)

Model = db.Model


class User(Model):
    __softdelete__ = True

    id = Column(Integer, primary_key=True)
    name = Column(String)

User.query