Use Cases

Real-world scenarios for choosing between HStore and JSONB in your Django application.

Use HStore When

Product Attributes

Products have varying attributes like color, size, material that don't warrant dedicated columns. HStore stores them as flat key-value pairs with a clean admin interface.

from django_hstore_field import HStoreField

class Product(models.Model):
    name = models.CharField(max_length=200)
    attributes = HStoreField(
        default=dict,
        blank=True,
    )

Django ORM SQL

# Find all red products
Product.objects.filter(attributes__color='red')

# Products with a size attribute
Product.objects.filter(attributes__has_key='size')

User Preferences

Store user settings like timezone, language, notification preferences as flexible key-value pairs:

class UserProfile(models.Model):
    user = models.OneToOneField(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
    preferences = HStoreField(
        default=dict,
    )

Content Metadata

Tags, categories, and custom fields for articles, media, or any content model:

class Article(models.Model):
    title = models.CharField(max_length=300)
    metadata = HStoreField(
        default=dict,
        blank=True,
    )

Use JSONB When

Nested Configuration

Application settings with hierarchical structure:

class SiteConfig(models.Model):
    settings = models.JSONField(default=dict)
    # {
    #     "email": {"from_addr": "noreply@example.com", "enabled": True},
    #     "cache": {"backend": "redis", "ttl": 300},
    # }

Django ORM SQL

# Query nested values
SiteConfig.objects.filter(settings__email__enabled=True)

API Response Cache

Store and query nested API responses:

class CachedResponse(models.Model):
    endpoint = models.CharField(max_length=500)
    response = models.JSONField()
    cached_at = models.DateTimeField(auto_now_add=True)

Search Facets

Dynamic filter options with mixed types:

class SearchFacet(models.Model):
    name = models.CharField(max_length=100)
    options = models.JSONField(default=list)
    # [
    #     {"label": "Under $50", "value": 50, "type": "price_max"},
    #     {"label": "In Stock", "value": True, "type": "boolean"},
    # ]

Guidelines

Scenario

Scenario	HStore	JSONB
Product attributes	Yes
User preferences	Yes
Content tags / metadata	Yes
Nested app config		Yes
API response caching		Yes
Mixed-type form data		Yes
Document storage		Yes

পরামর্শ

When in doubt, start with HStore. It's simpler, more compact, and gives you a better admin experience. Migrate to JSONB only when you genuinely need nested structures or mixed value types.