Para que o `related_name` é usado no Django?

Qual é o related_nameargumento útil para on ManyToManyFielde ForeignKeyfields? Por exemplo, dado o código a seguir, qual é o efeito related_name='maps'?

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

O related_nameatributo especifica o nome da relação reversa do Usermodelo para o seu modelo.

Se você não especificar a related_name, o Django criará automaticamente uma usando o nome do seu modelo com o sufixo _set, por exemplo User.map_set.all().

Se você não especificar, por exemplo, related_name=mapsno Usermodelo, User.map_setcontinuará a funcionar, mas a User.maps.sintaxe é, obviamente, um pouco mais limpo e menos desajeitado; por exemplo, se você tiver um objeto de usuário current_user, poderá usar current_user.maps.all()para obter todas as instâncias do seu Mapmodelo que tenham uma relação current_user.

A documentação do Django tem mais detalhes.

Para adicionar um nome relacionado à resposta existente, é necessário que haja 2 FKs no modelo que apontam para a mesma tabela. Por exemplo, no caso de lista técnica

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

Então, quando você precisar acessar esses dados, poderá usar apenas nomes relacionados

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

Não está funcionando de outra forma (pelo menos não pude usar o nome relacionado no caso de 2 FKs na mesma tabela.)

O related_nameargumento também é útil se você tiver nomes de classes relacionados mais complexos. Por exemplo, se você tiver um relacionamento de chave estrangeira:

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

Para acessar UserMapDataFrameobjetos do relacionado User, a chamada padrão seria User.usermapdataframe_set.all(), o que é bastante difícil de ler.

O uso de related_namepermite especificar um nome mais simples ou legível para obter a relação inversa. Nesse caso, se você especificar user = models.ForeignKey(User, related_name='map_data'), a chamada será então User.map_data.all().

O parâmetro de nome relacionado é realmente uma opção. Se não o definirmos, o Django criará automaticamente o outro lado da relação para nós. No caso do modelo Map, o Django teria criado um map_setatributo, permitindo o acesso m.map_setno seu exemplo (estou sendo sua instância de classe). A fórmula que o Django usa é o nome do modelo seguido pela string _set. O parâmetro name relacionado simplesmente substitui o padrão do Django em vez de fornecer um novo comportamento.

prefetch_relateduse para pré-buscar dados para Muitos para muitos e muitos para um dado de relacionamento. select_relatedé selecionar dados de um único relacionamento de valor. Ambos são usados ​​para buscar dados de seus relacionamentos de um modelo. Por exemplo, você constrói um modelo e um modelo que tem um relacionamento com outros modelos. Quando uma solicitação chega, você também consulta seus dados de relacionamento e o Django possui mecanismos muito bons. Para acessar dados do relacionamento, como book.author.namequando você itera uma lista de modelos para buscar seus dados de relacionamento, o Django cria cada solicitação para todos os dados de relacionamento. Para superar isso, temos prefetchd_relatedeselected_related