Быстрый старт¶

Настройки¶

Добавьте simple_history к вашему INSTALLED_APPS.

INSTALLED_APPS = [
    # ...
    'simple_history',
]

Исторические модели могут отслеживать, кто внес каждое изменение. Чтобы автоматически заполнять историю пользователей, вы можете добавить HistoryRequestMiddleware в настройки Django:

MIDDLEWARE = [
    # ...
    'simple_history.middleware.HistoryRequestMiddleware',
]

Если вы не хотите использовать промежуточное ПО, вы можете явно указать пользователя, вносящего изменения, как это описано в Отслеживание пользователей.

История пути¶

Чтобы отследить историю для модели, создайте экземпляр simple_history.models.HistoricalRecords на модели.

Пример для отслеживания изменений в моделях Poll и << 1 >>> в учебнике Django:

from django.db import models
from simple_history.models import HistoricalRecords

class Poll(models.Model):
    question = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')
    history = HistoricalRecords()

class Choice(models.Model):
    poll = models.ForeignKey(Poll)
    choice_text = models.CharField(max_length=200)
    votes = models.IntegerField(default=0)
    history = HistoricalRecords()

Теперь все изменения в экземплярах моделей Poll и << 1 >>> будут отслеживаться в базе данных.

История пути для модели третьей стороны¶

Чтобы отследить историю для модели, которую вы не создавали, используйте функцию simple_history.register. Вы можете использовать ее для отслеживания моделей из сторонних приложений, над которыми у вас нет контроля. Вот пример использования функции simple_history.register для отслеживания истории модели User из приложения django.contrib.auth:

from simple_history import register
from django.contrib.auth.models import User

register(User)

Если вы хотите отделить миграции исторической модели в приложение, отличное от приложения сторонней модели, вы можете установить параметр app в register. Например, если вы хотите, чтобы миграции жили в папке migrations пакета, в котором вы зарегистрировали модель, вы можете сделать следующее:

register(User, app=__package__)

Существующие проекты¶

Для существующих проектов можно вызвать команду populate, чтобы сгенерировать начальные изменения для ранее существовавших экземпляров модели:

$ python manage.py populate_history --auto

По умолчанию строки истории вставляются партиями по 200 штук. При необходимости это можно изменить для больших таблиц, используя опцию --batchsize, например --batchsize 500.