Множественные базы данных¶

Использование других команд управления¶

Большинство других команд django-admin, взаимодействующих с базой данных, работают так же, как и migrate - они работают только с одной базой данных одновременно, используя --database для управления используемой базой данных.

Исключением из этого правила является команда makemigrations. Она проверяет историю миграций в базах данных, чтобы отловить проблемы с существующими файлами миграций (которые могут быть вызваны их редактированием) перед созданием новых миграций. По умолчанию она проверяет только базу данных default, но обращается к методу allow_migrate() и routers, если таковые установлены.

Маршрутизаторы баз данных¶

Маршрутизатор базы данных - это класс, который предоставляет до четырех методов:

db_for_read(model, **hints)¶

Предложите базу данных, которая должна использоваться для операций чтения объектов типа model.

Если операция с базой данных способна предоставить какую-либо дополнительную информацию, которая может помочь в выборе базы данных, она будет предоставлена в словаре hints. Подробности о допустимых подсказках приведены в below.

Возвращает None, если предложение отсутствует.

db_for_write(model, **hints)¶

Предложите базу данных, которая должна использоваться для записи объектов типа Model.

Если операция с базой данных способна предоставить какую-либо дополнительную информацию, которая может помочь в выборе базы данных, она будет предоставлена в словаре hints. Подробности о допустимых подсказках приведены в below.

Возвращает None, если предложение отсутствует.

allow_relation(obj1, obj2, **hints)¶

Возвращает True, если связь между obj1 и obj2 должна быть разрешена, False, если связь должна быть запрещена, или None, если маршрутизатор не имеет мнения. Это чисто проверочная операция, используемая внешним ключом и операциями «многие ко многим» для определения того, должна ли быть разрешена связь между двумя объектами.

Если ни один маршрутизатор не имеет мнения (т.е. все маршрутизаторы возвращают None), допускаются только отношения в пределах одной базы данных.

allow_migrate(db, app_label, model_name=None, **hints)¶

Определите, разрешена ли операция миграции для базы данных с псевдонимом db. Возвращает True, если операция должна быть запущена, False, если она не должна быть запущена, или None, если маршрутизатор не имеет мнения.

Позиционный аргумент app_label - это метка переносимого приложения.

model_name устанавливается большинством операций миграции в значение model._meta.model_name (строчная версия модели __name__) мигрируемой модели. Для операций None и RunPython его значение равно RunSQL, если только они не предоставляют его с помощью подсказок.

hints используются некоторыми операциями для передачи дополнительной информации маршрутизатору.

Когда установлено model_name, hints обычно содержит класс модели под ключом 'model'. Обратите внимание, что он может быть historical model, и, следовательно, не иметь никаких пользовательских атрибутов, методов или менеджеров. Вы должны полагаться только на _meta.

Этот метод также может быть использован для определения доступности модели на данной базе данных.

makemigrations всегда создает миграции для изменений модели, но если allow_migrate() возвращает False, любые операции миграции для model_name будут молча пропущены при выполнении migrate на db. Изменение поведения allow_migrate() для моделей, которые уже имеют миграции, может привести к неработающим внешним ключам, лишним таблицам или отсутствующим таблицам. Когда makemigrations проверяет историю миграций, он пропускает базы данных, в которые не разрешено мигрировать ни одному приложению.

Маршрутизатор не обязан предоставлять все эти методы - он может опустить один или несколько из них. Если один из методов опущен, Django пропустит этот маршрутизатор при выполнении соответствующей проверки.

Использование маршрутизаторов¶

Маршрутизаторы базы данных устанавливаются с помощью настройки DATABASE_ROUTERS. Эта настройка определяет список имен классов, каждый из которых указывает маршрутизатор, который должен использоваться главным маршрутизатором (django.db.router).

Главный маршрутизатор используется операциями с базами данных Django для распределения использования баз данных. Всякий раз, когда запросу нужно узнать, какую базу данных использовать, он обращается к главному маршрутизатору, предоставляя модель и подсказку (если она доступна). Затем Django пробует каждый маршрутизатор по очереди, пока не будет найдено предложение базы данных. Если предложение не найдено, он пробует текущий _state.db экземпляр подсказки. Если экземпляр подсказки не был предоставлен, или у экземпляра нет текущего состояния базы данных, главный маршрутизатор выделит базу данных default.

Пример¶

Итак, что это означает на практике? Рассмотрим еще один пример конфигурации. В этой конфигурации будет несколько баз данных: одна для приложения auth, а все остальные приложения используют первичную/реплику с двумя копиями для чтения. Вот настройки, определяющие эти базы данных:

DATABASES = {
    'default': {},
    'auth_db': {
        'NAME': 'auth_db',
        'ENGINE': 'django.db.backends.mysql',
        'USER': 'mysql_user',
        'PASSWORD': 'swordfish',
    },
    'primary': {
        'NAME': 'primary',
        'ENGINE': 'django.db.backends.mysql',
        'USER': 'mysql_user',
        'PASSWORD': 'spam',
    },
    'replica1': {
        'NAME': 'replica1',
        'ENGINE': 'django.db.backends.mysql',
        'USER': 'mysql_user',
        'PASSWORD': 'eggs',
    },
    'replica2': {
        'NAME': 'replica2',
        'ENGINE': 'django.db.backends.mysql',
        'USER': 'mysql_user',
        'PASSWORD': 'bacon',
    },
}

Теперь нам нужно разобраться с маршрутизацией. Сначала нам нужен маршрутизатор, который знает, что нужно посылать запросы для приложений auth и contenttypes в auth_db (модели auth связаны с ContentType, поэтому они должны храниться в одной базе данных):

class AuthRouter:
    """
    A router to control all database operations on models in the
    auth and contenttypes applications.
    """
    route_app_labels = {'auth', 'contenttypes'}

    def db_for_read(self, model, **hints):
        """
        Attempts to read auth and contenttypes models go to auth_db.
        """
        if model._meta.app_label in self.route_app_labels:
            return 'auth_db'
        return None

    def db_for_write(self, model, **hints):
        """
        Attempts to write auth and contenttypes models go to auth_db.
        """
        if model._meta.app_label in self.route_app_labels:
            return 'auth_db'
        return None

    def allow_relation(self, obj1, obj2, **hints):
        """
        Allow relations if a model in the auth or contenttypes apps is
        involved.
        """
        if (
            obj1._meta.app_label in self.route_app_labels or
            obj2._meta.app_label in self.route_app_labels
        ):
           return True
        return None

    def allow_migrate(self, db, app_label, model_name=None, **hints):
        """
        Make sure the auth and contenttypes apps only appear in the
        'auth_db' database.
        """
        if app_label in self.route_app_labels:
            return db == 'auth_db'
        return None

И нам также нужен маршрутизатор, который отправляет все другие приложения к конфигурации основной/реплики, и случайным образом выбирает реплику для чтения из:

import random

class PrimaryReplicaRouter:
    def db_for_read(self, model, **hints):
        """
        Reads go to a randomly-chosen replica.
        """
        return random.choice(['replica1', 'replica2'])

    def db_for_write(self, model, **hints):
        """
        Writes always go to primary.
        """
        return 'primary'

    def allow_relation(self, obj1, obj2, **hints):
        """
        Relations between objects are allowed if both objects are
        in the primary/replica pool.
        """
        db_list = ('primary', 'replica1', 'replica2')
        if obj1._state.db in db_list and obj2._state.db in db_list:
            return True
        return None

    def allow_migrate(self, db, app_label, model_name=None, **hints):
        """
        All non-auth models end up in this pool.
        """
        return True

Наконец, в файл настроек мы добавляем следующее (заменяя path.to. реальным Python-путем к модулю (модулям), где определены маршрутизаторы):

DATABASE_ROUTERS = ['path.to.AuthRouter', 'path.to.PrimaryReplicaRouter']

Порядок, в котором обрабатываются маршрутизаторы, имеет значение. Маршрутизаторы будут запрашиваться в том порядке, в котором они перечислены в настройке DATABASE_ROUTERS. В данном примере параметр AuthRouter обрабатывается раньше, чем PrimaryReplicaRouter, и в результате решения, касающиеся моделей в параметре auth, обрабатываются до принятия любого другого решения. Если бы параметр DATABASE_ROUTERS перечислял два маршрутизатора в другом порядке, то первым обрабатывался бы параметр PrimaryReplicaRouter.allow_migrate(). Всеобъемлющий характер реализации PrimaryReplicaRouter означает, что все модели будут доступны во всех базах данных.

Установив эту установку, запустим код Django:

>>> # This retrieval will be performed on the 'auth_db' database
>>> fred = User.objects.get(username='fred')
>>> fred.first_name = 'Frederick'

>>> # This save will also be directed to 'auth_db'
>>> fred.save()

>>> # These retrieval will be randomly allocated to a replica database
>>> dna = Person.objects.get(name='Douglas Adams')

>>> # A new object has no database allocation when created
>>> mh = Book(title='Mostly Harmless')

>>> # This assignment will consult the router, and set mh onto
>>> # the same database as the author object
>>> mh.author = dna

>>> # This save will force the 'mh' instance onto the primary database...
>>> mh.save()

>>> # ... but if we re-retrieve the object, it will come back on a replica
>>> mh = Book.objects.get(title='Mostly Harmless')

В этом примере определен маршрутизатор для обработки взаимодействия с моделями из приложения auth, и другие маршрутизаторы для обработки взаимодействия со всеми остальными приложениями. Если вы оставили свою базу данных default пустой и не хотите определять маршрутизатор для обработки всех приложений, не указанных иначе, ваши маршрутизаторы должны обрабатывать имена всех приложений в INSTALLED_APPS перед миграцией. Смотрите Поведение приложений вклада для получения информации о приложениях, которые должны находиться в одной базе данных.

Ручной выбор базы данных для QuerySet¶

Вы можете выбрать базу данных для QuerySet в любой точке QuerySet «цепочки». Просто вызовите using() на QuerySet, чтобы получить другой QuerySet, который использует указанную базу данных.

using() принимает единственный аргумент: псевдоним базы данных, на которой вы хотите выполнить запрос. Например:

>>> # This will run on the 'default' database.
>>> Author.objects.all()

>>> # So will this.
>>> Author.objects.using('default').all()

>>> # This will run on the 'other' database.
>>> Author.objects.using('other').all()

Выбор базы данных для save()¶

Используйте ключевые слова using и Model.save(), чтобы указать, в какую базу данных должны быть сохранены данные.

Например, чтобы сохранить объект в базе данных legacy_users, вы используете следующее:

>>> my_object.save(using='legacy_users')

Если вы не укажете using, метод save() будет сохранять в базу данных по умолчанию, выделенную маршрутизаторами.

>>> p = Person(name='Fred')
>>> p.save(using='first')  # (statement 1)
>>> p.save(using='second') # (statement 2)

>>> p = Person(name='Fred')
>>> p.save(using='first')
>>> p.pk = None # Clear the primary key.
>>> p.save(using='second') # Write a completely new object.

>>> p = Person(name='Fred')
>>> p.save(using='first')
>>> p.save(using='second', force_insert=True)

Выбор базы данных для удаления¶

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

>>> u = User.objects.using('legacy_users').get(username='fred')
>>> u.delete() # will delete from the `legacy_users` database

Чтобы указать базу данных, из которой будет удалена модель, передайте аргумент с ключевым словом using в метод Model.delete(). Этот аргумент работает так же, как и аргумент using с ключевым словом в методе save().

Например, если вы переносите пользователя из базы данных legacy_users в базу данных new_users, вы можете использовать следующие команды:

>>> user_obj.save(using='new_users')
>>> user_obj.delete(using='legacy_users')

Использование менеджеров с несколькими базами данных¶

Используйте метод db_manager() для менеджеров, чтобы предоставить менеджерам доступ к базе данных не по умолчанию.

Например, допустим, у вас есть пользовательский метод менеджера, который обращается к базе данных - User.objects.create_user(). Поскольку create_user() является методом менеджера, а не методом QuerySet, вы не можете сделать User.objects.using('new_users').create_user(). (Метод create_user() доступен только для User.objects, менеджера, а не для QuerySet объектов, производных от менеджера). Решением является использование метода db_manager(), например, так:

User.objects.db_manager('new_users').create_user(...)

db_manager() возвращает копию менеджера, привязанную к указанной вами базе данных.

class MyManager(models.Manager):
    def get_queryset(self):
        qs = CustomQuerySet(self.model)
        if self._db is not None:
            qs = qs.using(self._db)
        return qs

Межбазовые отношения¶

В настоящее время Django не поддерживает отношения типа «внешний ключ» или «многие ко многим», охватывающие несколько баз данных. Если вы использовали маршрутизатор для разделения моделей по разным базам данных, все отношения типа «внешний ключ» и «многие-ко-многим», определенные этими моделями, должны быть внутренними для одной базы данных.

Это происходит из-за ссылочной целостности. Для того чтобы поддерживать связь между двумя объектами, Django необходимо знать, что первичный ключ связанного объекта действителен. Если первичный ключ хранится в отдельной базе данных, то невозможно легко оценить действительность первичного ключа.

Если вы используете Postgres, Oracle или MySQL с InnoDB, это обеспечивается на уровне целостности базы данных - ключевые ограничения на уровне базы данных предотвращают создание отношений, которые не могут быть проверены.

Однако, если вы используете SQLite или MySQL с таблицами MyISAM, то принудительная ссылочная целостность отсутствует; в результате вы можете «подделать» перекрестные внешние ключи базы данных. Однако такая конфигурация официально не поддерживается Django.

Поведение приложений вклада¶

Несколько приложений contrib включают модели, и некоторые приложения зависят от других. Поскольку межбазовые связи невозможны, это создает некоторые ограничения на то, как вы можете разделить эти модели по базам данных:

• каждый из contenttypes.ContentType, sessions.Session и sites.Site может быть сохранен в любой базе данных, при наличии подходящего маршрутизатора.
• Модели auth - User, Group и Permission - связаны между собой и связаны с ContentType, поэтому они должны храниться в той же базе данных, что и ContentType.
• admin зависит от auth, поэтому его модели должны находиться в той же базе данных, что и auth.
• flatpages и redirects зависят от sites, поэтому их модели должны находиться в той же базе данных, что и sites.

Кроме того, некоторые объекты автоматически создаются сразу после того, как migrate создает таблицу для их хранения в базе данных:

• по умолчанию Site,
• a ContentType для каждой модели (включая те, которые не хранятся в этой базе данных),
• Permissions для каждой модели (включая те, которые не хранятся в этой базе данных).

Для распространенных настроек с несколькими базами данных не имеет смысла иметь эти объекты в нескольких базах данных. К распространенным настройкам относятся первичная/репликативная база данных и подключение к внешним базам данных. Поэтому рекомендуется написать database router, который позволяет синхронизировать эти три модели только с одной базой данных. Используйте тот же подход для приложений contrib и сторонних приложений, которым не нужны их таблицы в нескольких базах данных.