How to Use Proxy Model in Django: Syntax and Example

In Django, a proxy model lets you create a new class that uses the same database table as the original model but can have different Python behavior. You define it by subclassing the original model and setting proxy = True in the model's Meta class.

Syntax

A proxy model is defined by subclassing an existing model and adding proxy = True inside the Meta class. This tells Django to use the same database table but allow different Python-level behavior like methods or default ordering.

• Subclass: Inherit from the original model.
• Meta.proxy: Set to True to mark it as a proxy.
• New methods or ordering: Add or override methods and change ordering if needed.

python

class OriginalModel(models.Model):
    field = models.CharField(max_length=100)

    class Meta:
        ordering = ['field']

class ProxyModel(OriginalModel):
    class Meta:
        proxy = True
        ordering = ['-field']  # different ordering

    def new_method(self):
        return f"Proxy says: {self.field}"

Example

This example shows how to create a proxy model to change the default ordering and add a new method without creating a new database table.

python

from django.db import models

class Person(models.Model):
    name = models.CharField(max_length=50)
    age = models.IntegerField()

    class Meta:
        ordering = ['name']

class OlderPerson(Person):
    class Meta:
        proxy = True
        ordering = ['-age']  # order by age descending

    def is_senior(self):
        return self.age >= 65

# Usage example (in Django shell or view):
# p = OlderPerson.objects.create(name='Alice', age=70)
# print(p.is_senior())  # True
# print(list(OlderPerson.objects.all()))  # ordered by age descending

Output

True
[<OlderPerson: Alice>]

Common Pitfalls

Common mistakes when using proxy models include:

• Not setting proxy = True in Meta, which creates a new table instead of a proxy.
• Trying to add new fields to the proxy model, which is not allowed because it shares the original table.
• Confusing proxy models with model inheritance that creates new tables.

python

class WrongProxy(Person):
    new_field = models.CharField(max_length=20)  # This will cause errors

    class Meta:
        proxy = True

# Correct way: do not add new fields in proxy models.

Quick Reference

• Proxy model: Subclass original model + proxy = True in Meta.
• Same DB table: No new database table is created.
• Use cases: Change Python behavior, add methods, change ordering.
• Limitations: Cannot add new fields.

Key Takeaways

Set proxy = True in the Meta class to create a proxy model.

Proxy models share the same database table as the original model without adding new fields.

Use proxy models to add methods or change default ordering without changing the database schema.

Do not add new fields in proxy models; this will cause errors.

Proxy models are useful for customizing Python behavior while keeping the database unchanged.