Djangoで使用される `related_name`は何ですか？

related_nameon ManyToManyFieldおよびForeignKeyfieldsに役立つ引数は何ですか？たとえば、次のコードの場合、どのような影響があり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。

Djangoのドキュメントには、より多くの詳細を持っています。

既存の回答に追加するには-モデルに同じテーブルを指す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()。

関連名パラメーターは、実際にはオプションです。設定しない場合、Djangoは自動的に関係の反対側を作成します。Mapモデルの場合、Djangoはmap_set属性を作成m.map_setし、例（mはクラスインスタンス）でのアクセスを許可します。Djangoが使用する式は、モデル名の後に文字列が続きます_set。したがって、関連する名前パラメーターは、新しい動作を提供するのではなく、単にDjangoのデフォルトをオーバーライドします。

prefetch_related多対多および多対1の関係データのプリフェッチデータに使用します。 select_related単一の値の関係からデータを選択することです。これらはどちらも、モデルからの関係からデータをフェッチするために使用されます。たとえば、モデルと、他のモデルと関係があるモデルを作成します。リクエストが来ると、リレーションシップデータのクエリも行われます。Djangoには、リレーションシップからデータにアクセスするための非常に優れたメカニズムbook.author.nameがあります。これを克服するには prefetchd_related、selected_related