Examples

• 5

  Creating a JSONField
  5

  Available in Django 1.9+

  from django.contrib.postgres.fields import JSONField
  from django.db import models
  
  class IceCream(models.Model):
      metadata = JSONField()
  

  You can add the normal **options if you wish.

  ! Note that you must put 'django.contrib.postgres' in INSTALLED_APPS in your settings.py

  edited Nov 26 '16 at 23:38

  

  
  edit share view discussion request improvement

  edit move example delete example
• 3

  Creating an object with data in a JSONField
  3

  Pass data in native Python form, for example list, dict, str, None, bool, etc.

  IceCream.objects.create(metadata={
      'date': '1/1/2016',
      'ordered by': 'Jon Skeet',
      'buyer': {
           'favorite flavor': 'vanilla',
           'known for': ['his rep on SO', 'writing a book']
       },
      'special requests': ['hot sauce'],
  })
  

  See the note in the "Remarks" section about using JSONField in practice.

  edited Aug 2 '16 at 20:06

  
  edit share view discussion request improvement

  edit move example delete example
• 2

  Querying data nested in dictionaries
  2

  Get all ice cream cones that were ordered by people liking chocolate:

  IceCream.objects.filter(metadata__buyer__favorite_flavor='chocolate')
  

  See the note in the "Remarks" section about chaining queries.

  edited Jul 21 '16 at 23:22

  
  edit share view discussion request improvement

  edit move example delete example
• 1

  Querying data present in arrays
  1

  An integer will be interpreted as an index lookup.

  IceCream.objects.filter(metadata__buyer__known_for__0='creating stack overflow')
  

  See the note in the "Remarks" section about chaining queries.

  created Jul 21 '16 at 23:01

  
  edit share view discussion request improvement

  edit move example delete example
• 0

  Ordering by JSONField values
  0

  Ordering directly on JSONField is not yet supported in Django. But it's possible via RawSQL using PostgreSQL functions for jsonb:

  from django.db.models.expressions import RawSQL
  RatebookDataEntry.objects.all().order_by(RawSQL("data->>%s", ("json_objects_key",)))
  

  This example orders by data['json_objects_key'] inside JSONField named data:

  data = JSONField()
  

  created Jul 31 '16 at 11:01

  
  edit share view discussion request improvement

  edit move example delete example
• 0

  Querying top-level data
  0

  IceCream.objects.filter(metadata__ordered_by='Guido Van Rossum')
  

  edited Jul 22 '16 at 1:26

  
  edit share view discussion request improvement

  edit move example delete example