Transações e Sessões

Visão geral

Neste guia, você pode aprender como usar o Backend do Django MongoDB para executar transações. As transações permitem que você execute uma série de operações que alteram os dados somente se toda a transação estiver confirmada. Se qualquer operação na transação não for bem-sucedida, o Django MongoDB Backend interromperá a transação e descartará todas as alterações nos dados antes que elas se tornem visíveis. Esse recurso é chamado de atomicidade.

No MongoDB, as transações são executadas dentro de sessões lógicas. Uma sessão é um agrupamento de operações de leitura ou escrita relacionadas que você deseja executar sequencialmente. As sessões permitem consistência causal para um grupo de operações e permitem executar operações em uma transação compatível com ACID, que é uma transação que atende a uma expectativa de atomicidade, consistência, isolamento e durabilidade.

A API de transação nativa do Django não é suportada, mas o Django MongoDB Backend fornece uma API de transação personalizada que habilita a mesma funcionalidade. Para executar operações dentro de uma transação, defina-as dentro de um bloco atômico de código. O Django MongoDB Backend gerencia a lógica da sessão internamente, portanto, você não precisa iniciar manualmente uma sessão antes de executar uma transação.

from django.db import models
from django_mongodb_backend.fields import ArrayField
class Movie(models.Model):
    title = models.CharField(max_length=200)
    plot = models.TextField(blank=True)
    runtime = models.IntegerField(default=0)
    released = models.DateTimeField("release date", null=True, blank=True)
    genres = ArrayField(models.CharField(max_length=100), null=True, blank=True)
    class Meta:
        db_table = "movies"
        managed = False
    
    def __str__(self):
        return self.title

python manage.py shell

from <your application name>.models import Movie
from django.utils import timezone
from datetime import datetime

Iniciar uma transação

Para iniciar uma transação no banco de dados , chame a função django_mongodb_backend.transaction.atomic(). Você pode utilizar esta função como construtor ou gerenciador de contexto.

Certifique-se de importar o módulo transaction usando a seguinte instrução de importação:

from django_mongodb_backend import transaction

@transaction.atomic
def insert_movie_transaction():
    Movie.objects.create(
        title="Poor Things",
        runtime=141,
        genres=["Comedy", "Romance"]
    )

def insert_movie_transaction():
    with transaction.atomic():
        Movie.objects.create(
            title="Poor Things",
            runtime=141,
            genres=["Comedy", "Romance"]
        )

Executar chamadas de resposta após uma transação

Para executar determinadas ações somente se uma transação for concluída com êxito, você pode usar a função transaction.on_commit() . Esta função permite a você registrar chamadas de resposta que são executadas após uma transação ser confirmada no banco de dados. Passe uma função ou qualquer objeto chamado como argumento para on_commit().

As seguintes queries de exemplo para filmes que têm um valor genre de ["Horror", "Comedy"] somente após a conclusão de uma transação de banco de dados relacionada:

def get_horror_comedies():
    movies = Movie.objects.filter(genres=["Horror", "Comedy"])
    for m in movies:
        print(f"Title: {m.title}, runtime: {m.runtime}")
def insert_movie_with_callback():
    with transaction.atomic():
        Movie.objects.create(
            title="The Substance",
            runtime=140,
            genres=["Horror", "Comedy"]
        )
        transaction.on_commit(get_horror_comedies)

Lidar com erros de transação

Para lidar com exceções que ocorrem durante uma transação, adicione lógica de tratamento de erros em torno do bloco de código atômico. Se você lidar com erros dentro do bloco atômico, poderá ocultar esses erros do Django. Como o Django usa erros para determinar se deve confirmar ou reverter uma transação, isso pode causar um comportamento inesperado.

Se uma transação não for bem-sucedida, o Django não reverterá nenhuma alteração feita nos campos de um modelo. Para evitar inconsistências entre seus modelos e documentos do banco de dados , talvez seja necessário restaurar manualmente os valores de campo originais.

movie = Movie.objects.get(title="Jurassic Park")
movie.title = "Jurassic Park I"
try:
    with transaction.atomic():
        movie.save()
except DatabaseError:
    movie.title = "Jurassic Park"
if movie.title == "Jurassic Park I":
    movie.plot = "An industrialist invites experts to visit his theme park of cloned dinosaurs. After a power failure," \
    "   the creatures run loose, putting everyone's lives, including his grandchildren's, in danger."
    movie.save()

Informações adicionais

To learn more about the Django transaction API, see Database Transactions in the Django documentation.