Для чого використовується "related_name" в Django?

Для чого related_nameкорисний аргумент для ManyToManyFieldта на ForeignKeyполях? Наприклад, з урахуванням наступного коду, на що впливає related_name='maps'?

class Map(db.Model):
    members = models.ManyToManyField(User, related_name='maps',
                                     verbose_name=_('members'))

related_nameАтрибут визначає ім'я зворотного зв'язку від Userмоделі спини до вашої моделі.

Якщо ви не вказати related_name, Django автоматично створює один , використовуючи ім'я вашої моделі з суфіксом _set, наприклад User.map_set.all().

Якщо ж вказати, наприклад , related_name=mapsна Userмоделі, User.map_setвсе ще буде працювати, але User.maps.синтаксис, очевидно , трохи чистіше і менш незграбним; наприклад, якщо у вас був об’єкт користувача current_user, ви можете використовувати current_user.maps.all()для отримання всіх примірників вашої Mapмоделі, які мають відношення до current_user.

Документація Джанго має більше деталей.

Додавання до існуючого імені, пов'язаного з відповіддю, є обов'язковим у випадку, якщо в моделі є 2 FK, які вказують на ту саму таблицю. Наприклад, у випадку з вексельним матеріалом

@with_author 
class BOM(models.Model): 
    name = models.CharField(max_length=200,null=True, blank=True)
    description = models.TextField(null=True, blank=True)
    tomaterial =  models.ForeignKey(Material, related_name = 'tomaterial')
    frommaterial =  models.ForeignKey(Material, related_name = 'frommaterial')
    creation_time = models.DateTimeField(auto_now_add=True, blank=True)
    quantity = models.DecimalField(max_digits=19, decimal_places=10)

Тож, коли вам доведеться отримати доступ до цих даних, ви можете використовувати лише відповідне ім’я

 bom = material.tomaterial.all().order_by('-creation_time')

Це не працює інакше (принаймні, я не зміг пропустити використання пов’язаного імені у випадку 2 FK до тієї ж таблиці.)

related_nameАргумент також корисно , якщо у вас є більш складні родинні імена класів. Наприклад, якщо у вас є відносини із зовнішнім ключем:

class UserMapDataFrame(models.Model):
    user = models.ForeignKey(User) 

Для того, щоб отримати доступ до UserMapDataFrameоб'єктів із пов'язаних User, був би дзвінок за замовчуванням User.usermapdataframe_set.all(), який читати досить складно.

Використання related_name дозволяє вказати більш просте або розбірливе ім'я для отримання зворотного відношення. У цьому випадку, якщо ви вкажете user = models.ForeignKey(User, related_name='map_data'), то дзвінок буде User.map_data.all().

Пов'язаний параметр імені - це фактично параметр. Якщо ми цього не встановимо, Джанго автоматично створить іншу сторону відносин для нас. У випадку з моделлю Map, Django створив би map_setатрибут, що дозволить отримувати доступ m.map_setу вашому прикладі (я - ваш екземпляр класу). Формула, яку використовує Джанго, - це назва моделі, за якою слідує рядок _set. Пов'язаний параметр імені, таким чином, просто замінює за замовчуванням Django, а не надає нову поведінку.

prefetch_relatedвикористовувати для попереднього вибору даних для даних багатьох для багатьох і багатьох до одного. select_relatedполягає у виборі даних із одного значення значення. Обидва вони використовуються для отримання даних про їх відносини з моделі. Наприклад, ви будуєте модель та модель, яка має стосунки з іншими моделями. Коли надходить запит, ви також запитаєте їх дані про стосунки, і у Django є дуже хороші механізми доступу до даних із їхніх стосунків, як, book.author.nameале коли ви ітератуєте список моделей для отримання даних про їх стосунки, Django створює кожен запит для кожного окремого даного стосунку. Для подолання цього у нас є prefetchd_relatedіselected_related