https://github.com/jeanphix/sqla-paranoid

Brings transparent soft delete to SQLAlchemy ORM.
https://github.com/jeanphix/sqla-paranoid

python softdelete sqlalchemy

Last synced: about 1 year ago
JSON representation

Brings transparent soft delete to SQLAlchemy ORM.

• Host: GitHub
• URL: https://github.com/jeanphix/sqla-paranoid
• Owner: jeanphix
• Created: 2017-06-02T10:48:37.000Z (almost 9 years ago)
• Default Branch: dev
• Last Pushed: 2023-09-15T14:03:36.000Z (over 2 years ago)
• Last Synced: 2025-03-24T19:39:35.649Z (about 1 year ago)
• Topics: python, softdelete, sqlalchemy
• Language: Python
• Size: 6.84 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
Paranoid

========

Brings transparent soft delete to SQLAlchemy ORM.

.. image:: https://travis-ci.org/jeanphix/sqla-paranoid.svg?branch=dev

   :target: https://travis-ci.org/jeanphix/sqla-paranoid

   :alt: Build Status

Installation

------------

.. code-block:: bash

    pip install sqla-paranoid

Usage

-----

.. code-block:: python

    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)

Flask

-----

Paranoid comes with a ready to use ``Flask`` extension built

on top of Flask-SQLAlchemy:

.. code-block:: python

    from paranoid.flask import SQLAlchemy

    db = SQLAlchemy(app)

    Model = db.Model

    class User(Model):

        __softdelete__ = True

        id = Column(Integer, primary_key=True)

        name = Column(String)

    User.query