À quoi sert «related_name» dans Django?

Quel est l' related_nameargument utile pour les champs on ManyToManyFieldet ForeignKey? Par exemple, étant donné le code suivant, quel est l'effet de related_name='maps'?

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

L' related_nameattribut spécifie le nom de la relation inverse du Usermodèle vers votre modèle.

Si vous ne spécifiez pas de related_name, Django en crée automatiquement un en utilisant le nom de votre modèle avec le suffixe _set, par exemple User.map_set.all().

Si vous ne spécifiez, par exemple related_name=mapssur le Usermodèle, User.map_setcontinuera à fonctionner, mais la User.maps.syntaxe est évidemment un peu plus propre et moins maladroits; ainsi, par exemple, si vous aviez un objet utilisateur current_user, vous pouvez utiliser current_user.maps.all()pour obtenir toutes les instances de votre Mapmodèle qui ont une relation avec current_user.

La documentation Django contient plus de détails.

Ajouter au nom existant lié à la réponse est un must dans le cas où 2 FK dans le modèle pointent vers la même table. Par exemple en cas de nomenclature

@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)

Ainsi, lorsque vous devrez accéder à ces données, vous ne pouvez utiliser que le nom associé

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

Cela ne fonctionne pas autrement (au moins, je n'ai pas pu ignorer l'utilisation du nom associé dans le cas de 2 FK dans la même table.)

L' related_nameargument est également utile si vous avez des noms de classe liés plus complexes. Par exemple, si vous avez une relation de clé étrangère:

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

Pour accéder à des UserMapDataFrameobjets à partir de la relation User, l'appel par défaut serait User.usermapdataframe_set.all(), ce qui est assez difficile à lire.

L'utilisation de related_namevous permet de spécifier un nom plus simple ou plus lisible pour obtenir la relation inverse. Dans ce cas, si vous spécifiez user = models.ForeignKey(User, related_name='map_data'), l'appel serait alors User.map_data.all().

Le paramètre de nom associé est en fait une option. Si nous ne le définissons pas, Django crée automatiquement l'autre côté de la relation pour nous. Dans le cas du modèle Map, Django aurait créé un map_setattribut, permettant l'accès via m.map_setdans votre exemple (m étant votre instance de classe). La formule utilisée par Django est le nom du modèle suivi de la chaîne _set. Le paramètre de nom associé remplace donc simplement la valeur par défaut de Django plutôt que de fournir un nouveau comportement.

prefetch_relatedutiliser pour les données de prélecture pour les données de relation plusieurs à plusieurs et plusieurs à un. select_relatedconsiste à sélectionner des données à partir d'une relation de valeur unique. Ces deux éléments sont utilisés pour extraire des données de leurs relations à partir d'un modèle. Par exemple, vous créez un modèle et un modèle qui a une relation avec d'autres modèles. Lorsqu'une demande arrive, vous interrogerez également leurs données de relation et Django dispose de très bons mécanismes pour accéder aux données de leur relation comme book.author.namemais lorsque vous parcourez une liste de modèles pour récupérer leurs données de relation, Django crée chaque demande pour chaque donnée de relation. Pour remédier à cela , nous n'avons prefetchd_relatedetselected_related