Skip to main content

Django query optimization supports for multi db relations.

Project description

# django-multi-db-relation

> Queryset optimization supports for multi database spanning relations between Django models.

## Requirements

- Python (>= 3.5)
- Django (>= 1.10)

## Installation

```sh
pip install django-multi-db-relation
```

## Usage

For models

```python
class ModelA(models.Model):
name = models.CharField(max_length=10)

class ModelB(models.Model):
a = models.ForeignKey(ModelA, on_delete=models.DO_NOTHING)

class ModelC(models.Model):
b = models.ForeignKey(ModelB, on_delete=models.DO_NOTHING, db_constraint=False)
```

suppose that `ModelA` and `ModelB` is routed to `db1` and `ModelC` to `db2`.

We **cannot** run a queryset with `select_related()`.

```python
>>> ModelC.objects.select_related('b') # Table not found
```

In this case, modify `ModelC` like:

```python
from multi_db_relation.mixins import ExternalDbQuerySetMixin


class ModelCQuerySet(ExternalDbQuerySetMixin, models.QuerySet):
pass

class ModelC(models.Model):
b = models.ForeignKey(ModelB, on_delete=models.DO_NOTHING, db_constraint=False)

objects = models.Manager.from_queryset(queryset_class=ModelCQuerySet)()

class Meta:
external_db_fields = ['b']
```

then:

```python
>>> ModelC.objects.select_related('b') # Number of queries is optimized from O(n) to O(1)
>>> ModelC.objects.select_related('b__a') # Also works well
```

## License

- See [LICENSE](LICENSE)

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Files for django-multi-db-relation, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size django_multi_db_relation-0.1-py3-none-any.whl (4.7 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page