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.10.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

django_closuretree-1.1.10-py2-none-any.whl (11.8 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for django-closuretree-1.1.10.tar.gz
Algorithm Hash digest
SHA256 afe3bb8ee594ce2e260e8fea15372de76c684c80d4e4891d828e019061a3a17c
MD5 d249a2b5076c81a17b25e5865396fc94
BLAKE2b-256 115dc2f9ba8a26513252b7a04e58c4ccc83852177b506b009a26d2541aaf701a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_closuretree-1.1.10-py2-none-any.whl
Algorithm Hash digest
SHA256 56d1269c041de8f7a5485581d2eb495b3c0fad93ff1006cc25bd909a6d685cfa
MD5 db03d65eaa72d1450685f2721c4a5198
BLAKE2b-256 ab68a969eeb1d3efe7c1bad2e293466db51bf384a6c2334fada217b76b3e093e

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