Skip to content

SectorLabs/django-postgres-extra

Repository files navigation

django-postgres-extra

Tests CircleCI
馃摑 License License
馃摝 PyPi PyPi
馃崁 Code coverage Coverage Status
Django Versions 2.0, 2.1, 2.2, 3.0, 3.1, 3.2, 4.0, 4.1, 4.2, 5.0
Python Versions 3.6, 3.7, 3.8, 3.9, 3.10, 3.11
Psycopg Versions 2, 3
馃摉 Documentation Read The Docs
鈿狅笍 Upgrade Upgrade from v1.x
馃弫 Installation Installation Guide
馃敟 Features Features & Documentation
馃挧 Future enhancements Potential features

django-postgres-extra aims to make all of PostgreSQL's awesome features available through the Django ORM. We do this by taking care of all the hassle. As opposed to the many small packages that are available to try to bring a single feature to Django with minimal effort. django-postgres-extra goes the extra mile, with well tested implementations, seamless migrations and much more.

With seamless we mean that any features we add will work truly seamlessly. You should not have to manually modify your migrations to work with fields and objects provided by this package.


鈿狅笍 This README is for v2. See the v1 branch for v1.x.


Major features

See the full list

  • Native upserts

    • Single query
    • Concurrency safe
    • With bulk support (single query)
  • Extended support for HStoreField

    • Unique constraints
    • Null constraints
    • Select individual keys using .values() or .values_list()
  • PostgreSQL 11.x declarative table partitioning

    • Supports both range and list partitioning
  • Faster deletes

    • Truncate tables (with cascade)
  • Indexes

    • Conditional unique index.
    • Case sensitive unique index.

Working with the code

Prerequisites

  • PostgreSQL 10 or newer.
  • Django 2.0 or newer (including 3.x, 4.x).
  • Python 3.6 or newer.

Getting started

  1. Clone the repository:

     位 git clone https://github.com/SectorLabs/django-postgres-extra.git
    
  2. Create a virtual environment:

    位 cd django-postgres-extra
    位 virtualenv env
    位 source env/bin/activate
    
  3. Create a postgres user for use in tests (skip if your default user is a postgres superuser):

    位 createuser --superuser psqlextra --pwprompt
    位 export DATABASE_URL=postgres://psqlextra:<password>@localhost/psqlextra
    

    Hint: if you're using virtualenvwrapper, you might find it beneficial to put the export line in $VIRTUAL_ENV/bin/postactivate so that it's always available when using this virtualenv.

  4. Install the development/test dependencies:

    位 pip install .[test] .[analysis]
    
  5. Run the tests:

    位 tox
    
  6. Run the benchmarks:

    位 py.test -c pytest-benchmark.ini
    
  7. Auto-format code, sort imports and auto-fix linting errors:

    位 python setup.py fix