Параметры метаданных модели

В данном документе описаны все возможные параметры метаданных, которые вы можете указать для вашей модели в её внутреннем class Meta.

Доступные Meta параметры

abstract

Options.abstract

Если abstract = True, эта модель будет абстрактным базовым классом.

app_label

Options.app_label

Если модель определена вне приложения в INSTALLED_APPS, она должна указать, к какому приложению она относится:

app_label = 'myapp'

Если вы хотите представить модель в формате app_label.object_name или app_label.model_name, вы можете использовать соответственно model._meta.label или model._meta.label_lower.

base_manager_name

Options.base_manager_name

Имя атрибута менеджера, например, 'objects', для использования в модели _base_manager.

db_table

Options.db_table

Имя таблицы базы данных для использования моделью:

db_table = 'music_album'

Имена таблиц

Для экономии времени Django автоматически вычисляет имя таблицы базы данных по имени вашего класса модели и приложению, в котором она находится. Имя таблицы базы данных модели формируется путём объединения "метки приложения" – имени, используемого вами в manage.py startapp – с именем класса модели через символ подчеркивания.

Например, если у вас есть приложение bookstore (созданное с помощью manage.py startapp bookstore), модель, определенная как class Book , будет иметь таблицу базы данных с именем bookstore_book.

Для переопределения имени таблицы базы данных используйте параметр db_table в class Meta.

Если имя вашей таблицы базы данных является зарезервированным словом SQL или содержит символы, которые не разрешены в именах переменных Python – в частности, дефис – это нормально. Django цитирует имена столбцов и таблиц внутри базы данных.

db_table = '"name_left_in_lowercase"'

db_tablespace

Options.db_tablespace

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

default_manager_name

Options.default_manager_name

Имя менеджера, используемого для _default_manager модели.

default_related_name

Options.default_related_name

Имя, которое будет использоваться по умолчанию для связи от связанного объекта обратно к этому. По умолчанию <model_name>_set.

Этот параметр также устанавливает related_query_name.

Так как имя обратной связи для поля должно быть уникальным, будьте внимательны, если вы намерены унаследовать свою модель. Для решения проблем с коллизиями имен часть имени должна содержать '%(app_label)s' и '%(model_name)s', которые соответственно заменяются именем приложения, в котором находится модель, и именем модели, оба в нижнем регистре. См. абзац о имя связи для абстрактных моделей.

get_latest_by

Options.get_latest_by

Имя поля или список имён полей в модели, обычно DateField, DateTimeField или IntegerField. Это задаёт поля по умолчанию для использования в Manager модели в методах latest() и earliest().

Пример:

# Latest by ascending order_date.
get_latest_by = "order_date"

# Latest by priority descending, order_date ascending.
get_latest_by = ['-priority', 'order_date']

См. документацию latest() для получения дополнительной информации.

managed

Options.managed

По умолчанию True, что означает, Django создаст соответствующие таблицы базы данных в migrate или в качестве части миграций и удалит их в рамках команды управления flush. То есть Django управляет жизненным циклом таблиц базы данных.

Если False, для этой модели не будут выполняться операции создания, изменения или удаления таблиц базы данных. Это полезно, если модель представляет существующую таблицу или представление базы данных, созданное другими средствами. Это единственное отличие, когда managed=False. Все остальные аспекты обработки модели точно такие же, как обычно. Это включает

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

2. Если модель с managed=False содержит ManyToManyField, указывающий на другую неуправляемую модель, то промежуточная таблица для объединения многие-ко-многим также не будет создана. Однако промежуточная таблица между управляемой и неуправляемой моделью будет создана.

   Если вам нужно изменить это поведение по умолчанию, создайте промежуточную таблицу как явную модель (с managed , как нужно) и используйте атрибут ManyToManyField.through для использования вашей пользовательской модели для связи.

Для тестов, включающих модели с managed=False, вам нужно убедиться, что правильные таблицы созданы в рамках настройки теста.

Если вас интересует изменение поведения модели на уровне Python, вы могли бы использовать managed=False и создать копию существующей модели. Однако для этой ситуации есть лучший подход: модели-прокси.

order_with_respect_to

Options.order_with_respect_to

Делает этот объект упорядоченным относительно заданного поля, обычно ForeignKey. Это можно использовать для упорядочивания связанных объектов относительно родительского объекта. Например, если Answer относится к объекту Question, и вопрос имеет более одного ответа, а порядок ответов важен, вы бы сделали так:

from django.db import models

class Question(models.Model):
    text = models.TextField()
    # ...

class Answer(models.Model):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    # ...

    class Meta:
        order_with_respect_to = 'question'

При установке order_with_respect_to, предоставляются два дополнительных метода для получения и установки порядка связанных объектов: get_RELATED_order() и set_RELATED_order(), где RELATED — название модели в нижнем регистре. Например, предположим, что объект Question имеет несколько связанных объектов Answer, список, возвращаемый функцией, содержит первичные ключи связанных объектов Answer.

>>> question = Question.objects.get(id=1)
>>> question.get_answer_order()
[1, 2, 3]

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

>>> question.set_answer_order([3, 1, 2])

Связанные объекты также получают два метода, get_next_in_order() и get_previous_in_order(), которые можно использовать для доступа к этим объектам в правильном порядке. Предполагая, что объекты Answer упорядочены по полю id.

>>> answer = Answer.objects.get(id=2)
>>> answer.get_next_in_order()
<Answer: 3>
>>> answer.get_previous_in_order()
<Answer: 1>

ordering

Options.ordering

Упорядочивание по умолчанию для объекта, используемое при получении списков объектов:

ordering = ['-order_date']

Это кортеж или список строк и/или выражений запроса. Каждая строка — это имя поля с необязательным префиксом «-», который указывает порядок убывания. Поля без ведущего «-» будут упорядочены по возрастанию. Используйте строку «?» для случайного упорядочивания.

Например, для упорядочения по полю pub_date по возрастанию используйте это:

ordering = ['pub_date']

Для упорядочения по полю pub_date по убыванию используйте это:

ordering = ['-pub_date']

Для упорядочения по полю pub_date по убыванию, а затем по полю author по возрастанию, используйте это:

ordering = ['-pub_date', 'author']

Вы также можете использовать выражения запроса. Для упорядочения по полю author по возрастанию и размещения нулевых значений в конце используйте это:

from django.db.models import F

ordering = [F('author').asc(nulls_last=True)]

permissions

Options.permissions

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

permissions = [('can_deliver_pizzas', 'Can deliver pizzas')]

Это список или кортеж из 2-кортежей в формате (permission_code, human_readable_permission_name).

default_permissions

Options.default_permissions

По умолчанию ('add', 'change', 'delete', 'view'). Вы можете настроить этот список, например, установив его в пустой список, если ваше приложение не требует каких-либо стандартных разрешений. Он должен быть указан в модели перед созданием модели с помощью migrate, чтобы предотвратить создание пропущенных разрешений.

proxy

Options.proxy

Если proxy = True, модель, которая является подклассом другой модели, будет обрабатываться как модель-прокси.

required_db_features

Options.required_db_features

Список функций базы данных, которые должно поддерживать текущее соединение, чтобы модель учитывалась на фазе миграции. Например, если вы установите этот список в ['gis_enabled'], модель будет синхронизироваться только на базах данных, поддерживающих GIS. Это также полезно для пропуска некоторых моделей при тестировании с несколькими базами данных. Избегайте отношений между моделями, которые могут или не могут быть созданы, так как ORM не обрабатывает это.

required_db_vendor

Options.required_db_vendor

Имя поддерживаемого поставщика баз данных, специфичного для этой модели. Текущие встроенные имена поставщиков: sqlite, postgresql, mysql, oracle. Если этот атрибут не пустой и поставщик текущего соединения не соответствует ему, модель не будет синхронизирована.

select_on_save

Options.select_on_save

Определяет, будет ли Django использовать алгоритм django.db.models.Model.save() версии до 1.6. Старый алгоритм использует SELECT для определения, существует ли существующая строка для обновления. Новый алгоритм пытается выполнить UPDATE напрямую. В некоторых редких случаях UPDATE существующей строки не видна для Django. Примером является триггер PostgreSQL ON UPDATE, который возвращает NULL. В таких случаях новый алгоритм в конечном итоге выполнит INSERT даже когда строка существует в базе данных.

Обычно нет необходимости устанавливать этот атрибут. По умолчанию False.

См. django.db.models.Model.save() для получения более подробной информации об алгоритмах сохранения.

indexes

Options.indexes

Список индексов, которые вы хотите определить в модели:

from django.db import models

class Customer(models.Model):
    first_name = models.CharField(max_length=100)
    last_name = models.CharField(max_length=100)

    class Meta:
        indexes = [
            models.Index(fields=['last_name', 'first_name']),
            models.Index(fields=['first_name'], name='first_name_idx'),
        ]

unique_together

Options.unique_together

Используйте UniqueConstraint с опцией constraints вместо этого.

UniqueConstraint предоставляет больше функциональности, чем unique_together. unique_together может быть устаревшим в будущем.

Наборы имён полей, которые вместе должны быть уникальными:

unique_together = [['driver', 'restaurant']]

Это список списков, которые должны быть уникальными, когда рассматриваются вместе. Используется в Django admin и применяется на уровне базы данных (т.е., соответствующие UNIQUE инструкции включаются в CREATE TABLE инструкции).

Для удобства unique_together может быть единственным списком при работе с одним набором полей:

unique_together = ['driver', 'restaurant']

ManyToManyField не может быть включено в unique_together. (Непонятно, что это даже означает!) Если вам нужно проверить уникальность, связанную с ManyToManyField, попробуйте использовать сигнал или явную through модель.

Ошибка ValidationError при проверке модели, когда ограничение нарушено, имеет код ошибки unique_together.

index_together

Options.index_together

Используйте параметр indexes вместо этого.

Новый параметр indexes предоставляет больше функциональности, чем index_together. index_together может быть в будущем устаревшим.

Наборы имён полей, которые вместе индексируются:

index_together = [
    ["pub_date", "deadline"],
]

Этот список полей будет индексирован вместе (т.е. будет выдан соответствующий CREATE INDEX оператор).

Для удобства, index_together может быть одним списком при работе с одним набором полей:

index_together = ["pub_date", "deadline"]

constraints

Options.constraints

Список ограничений, которые вы хотите определить для модели:

from django.db import models

class Customer(models.Model):
    age = models.IntegerField()

    class Meta:
        constraints = [
            models.CheckConstraint(check=models.Q(age__gte=18), name='age_gte_18'),
        ]

verbose_name

Options.verbose_name

Читаемое человеком имя объекта в единственном числе:

verbose_name = "pizza"

Если оно не указано, Django будет использовать модифицированную версию имени класса: CamelCase становится camel case.

verbose_name_plural

Options.verbose_name_plural

Множественное имя объекта:

verbose_name_plural = "stories"

Если оно не указано, Django будет использовать verbose_name + "s".

Только для чтения Meta атрибуты

label

Options.label

Представление объекта, возвращает app_label.object_name, например 'polls.Question'.

label_lower

Options.label_lower

Представление модели, возвращает app_label.model_name, например 'polls.question'.