How to Get or Create Objects in Django: Simple Guide

In Django, use the get_or_create() method on a model's manager to fetch an object if it exists or create it if it doesn't. This method returns a tuple with the object and a boolean indicating if it was created.

Syntax

The get_or_create() method is called on a Django model's manager. It takes keyword arguments to specify the fields to look up or create by. It returns a tuple: (object, created), where created is True if the object was created, or False if it was fetched.

python

Model.objects.get_or_create(field1=value1, field2=value2, defaults={"field3": value3})

Example

This example shows how to get or create a Book object by its title. If the book does not exist, it will be created with the given author.

python

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)

# Usage in code
book, created = Book.objects.get_or_create(
    title="The Great Gatsby",
    defaults={"author": "F. Scott Fitzgerald"}
)

if created:
    print(f"Created new book: {book.title} by {book.author}")
else:
    print(f"Found existing book: {book.title} by {book.author}")

Output

Created new book: The Great Gatsby by F. Scott Fitzgerald

Common Pitfalls

• Not using defaults correctly: Fields not used for lookup should be passed inside the defaults dictionary, or they will be ignored when creating.
• Unique constraints: If the lookup fields are not unique, get_or_create() may raise MultipleObjectsReturned.
• Race conditions: In highly concurrent environments, two processes might create the same object simultaneously; handle exceptions accordingly.

python

try:
    obj, created = Model.objects.get_or_create(
        unique_field=value,
        defaults={"other_field": other_value}
    )
except Model.MultipleObjectsReturned:
    # Handle the error or clean data
    pass

Quick Reference

Method	Purpose	Returns
get_or_create(**kwargs, defaults=None)	Fetch object by fields or create if missing	Tuple (object, created_bool)
defaults	Dictionary of fields to set if creating	Used only on creation
created	Boolean indicating if object was created	True if created, False if fetched

Key Takeaways

Use get_or_create() to fetch or create objects in one step safely.

Pass lookup fields as keyword arguments and other fields inside defaults dictionary.

Check the returned boolean to know if the object was newly created.

Handle exceptions for multiple objects or race conditions in concurrent use.

get_or_create() helps avoid duplicate entries and simplifies code.