Skip to main content

Efficient tree-based datastructure for Django

Project description

Build Status Code Health Badge Documentation Status Test Coverage Version Badge License Badge

django-closuretree is an implementation of the closure tree technique for Django applications designed to provide efficient querying of tree-based structures in a relational database. Its goal is to reduce the number of queries required when querying the children or parents of a given object.

Given the following model:

class Node(models.Model):
    name = models.CharField(max_length=24)
    parent = models.ForeignKey('self', related_name='children')

The children of each model can be queried with:

Node.objects.get(name='A').children.all()

However, for recursive lookups, this results in a large number of queries. Instead, django-closuretree allows you to extract them all in one go:

from closuretree.models import ClosureModel

class Node(ClosureModel):
    name = models.CharField(max_length=24)
    parent = models.ForeignKey('self', related_name='children')

Node.objects.get(name='A').get_descendants()

A single query will obtain all the descendants.

Quick Start

  • Install django-closuretree with pip install django-closuretree.

  • Inherit your models from closuretree.models.ClosureModel instead of django.db.models.Model.

That’s it. You can now use get_descendants() and get_ancestors() on a model instance.

If you’re adding this to an existing application that already has data in the database, you’ll need to run the rebuildtable() method of each model before the closure tree will be populated with the existing data:

Node.rebuildtable()

Contributing

To contribute, fork the repo, do your work, and issue a pull request. We ask that contributors adhere to PEP8 standards, and include full tests for all their code.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-closuretree-1.1.9.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

django_closuretree-1.1.9-py2-none-any.whl (11.7 kB view details)

Uploaded Python 2

File details

Details for the file django-closuretree-1.1.9.tar.gz.

File metadata

File hashes

Hashes for django-closuretree-1.1.9.tar.gz
Algorithm Hash digest
SHA256 d3460ef2007a661a5209a2341f88bca726a30a72f15f935ab8c31ee70bfa04ab
MD5 b5e8ca4375364e3a60cf51dc18c2d222
BLAKE2b-256 fe5144710c0b247d0a3111129b5338260b8225f4f7ca6ff6d4890399781c0ab6

See more details on using hashes here.

File details

Details for the file django_closuretree-1.1.9-py2-none-any.whl.

File metadata

File hashes

Hashes for django_closuretree-1.1.9-py2-none-any.whl
Algorithm Hash digest
SHA256 7cd4431e72a08a791b46cf570eeab267195f6fb23181691eedc941899cb49056
MD5 7eacc8f3d423adfe666237128792f2ee
BLAKE2b-256 64767bb24ce466d3f61747f1b04a9ea932a5a64226121a0d1e90158d58acc99a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page