多表查詢是模型層的重要功能之一, Django提供了一套基於關聯字段獨特的解決方案.
ForeignKey
來自Django官方文檔的模型示例:
from django.db import models
class Blog(models.Model):
name = models.CharField(max_length=100)
tagline = models.TextField()
class Author(models.Model):
name = models.CharField(max_length=50)
email = models.EmailField()
class Entry(models.Model):
blog = models.ForeignKey(Blog)
authors = models.ManyToManyField(Author)
headline = models.CharField(max_length=255)
body_text = models.TextField()
pub_date = models.DateField()
mod_date = models.DateField()
n_comments = models.IntegerField()
n_pingbacks = models.IntegerField()
rating = models.IntegerField()
class ForeignKey
ForeignKey字段接受一個Model類作為參數, 類型與被參照的字段完全相同:
blog = models.ForeignKey(Blog)
ForeignKey.to_field
關聯到的關聯對象的字段名稱。默認地,Django 使用關聯對象的主鍵。
blog = models.ForeignKey(Blog, to_field=Blog.name)
ForeignKey.db_constraint
Django Model的ForeignKey字段的主要功能是維護一個一對多的關系, 以進行關聯查詢.
只有在db_constraint=True
時Django model才會在數據庫上建立外鍵約束, 在該值為False時不建立約束.
默認db_constraint=True
.
ForeignKey.related_name
這個名稱用於讓關聯的對象反查到源對象.
如果你不想讓Django 創建一個反向關聯,請設置related_name 為 '+' 或者以'+' 結尾.
ForeignKey.related_query_name
以ForeignKey.related_name
作為默認值, 兩者功能的具體說明請參見相關文檔
使用ForeignKey查詢
前向查詢
若關系模型A包含與模型B關聯的關聯字段, 模型A的實例可以通過關聯字段訪問與其關聯的模型B的實例:
>>> e = Entry.objects.get(id=2)
>>> e.blog # Returns the related Blog object.
修改e.blog並調用save方法存入數據庫
>>> e.blog = some_blog
>>> e.save()
如果ForeignKey 字段有null=True 設置(即它允許NULL值),可以分配None來刪除對應的關聯性
>>> e = Entry.objects.get(id=2)
>>> e.blog = None
>>> e.save() # "UPDATE blog_entry SET blog_id = NULL ...;"
Django提供了一種使用雙下划線__
的查詢語法:
>>> Entry.objects.filter(blog__name='Beatles Blog')
反向查詢
被索引的關系模型可以訪問所有參照它的模型的實例,如Entry.blog作為Blog的外鍵,默認情況下Blog.entry_set是包含所有參照Blog的Entry示例的查詢集,可以使用查詢集API取出相應的實例。
>>>b = Blog.objects.get(id=1)
>>>b.entry_set.all()
Entry.blog的related_name和related_query_name可以設置該查詢集的名字。
ManyToManyField
來自Django官網的示例:
from django.db import models
class Person(models.Model):
name = models.CharField(max_length=50)
class Group(models.Model):
name = models.CharField(max_length=128)
members = models.ManyToManyField(Person, through='Membership', through_fields=('group', 'person'))
class Membership(models.Model):
group = models.ForeignKey(Group)
person = models.ForeignKey(Person)
inviter = models.ForeignKey(Person, related_name="membership_invites")
invite_reason = models.CharField(max_length=64)
class ManyToManyField
ManyToManyField.through
Django 會自動創建一個表來管理多對多關系, 若要手動指定關聯表則需要使用through關鍵字參數.
ManyToManyField.through_fields
上文示例中Membership 有兩個外鍵指向Person (person 和inviter),這使得關聯關系含混不清並讓Django 不知道使用哪一個。
在這種情況下,必須使用through_fields 明確指定Django 應該使用哪些外鍵
through_fields 接收一個二元組('field1', 'field2'),其中field1 為指向定義ManyToManyField 字段的模型的外鍵名稱(本例中為group),field2 為指向目標模型的外鍵的名稱(本例中為person).
ManyToManyField.db_table
默認情況下,關聯表的名稱使用多對多字段的名稱和包含這張表的模型的名稱以及Hash值生成,如:memberShip_person_3c1f5
若要想要手動指定表的名稱,可以使用db_table
關鍵字參數指定.
others
下列API和ForeignKey中的同名API相同.
-
ManyToManyField.db_constraint
-
ManyToManyField.related_name
-
ManyToManyField.related_query_name
使用ManyToManyField查詢
多對多關系和ForeignKey具有相似的API.
>>>e = Group.objects.get(id=3)
>>>e.members.all() # Returns all members objects for this Group.
反向查詢:
>>>a = Person.objects.get(id=1)
>>>a.group_set.all()
同樣related_name可以設置反向查詢集的名稱。
添加刪除關聯
因為ManyToManyField自動維護關聯表,程序員不便於直接訪問.ManyToManyField提供了API用於添加和刪除關聯(即through表中的記錄).
使用一個自動維護through表的模型作為示例:
class User(models.Model):
user_id = models.IntegerField(primary_key=True)
class Flight(models.Model):
flight_id = models.IntegerField(primary_key=True)
reserve = models.ManyToManyField(User, related_name='flight_reserve')
首先獲得要進行關聯的Flight和User實例:
flights = Flight.objects.filter(flight_id=flight_id)
if flights.count() != 0:
flight = flights[0]
users = User.objects.filter(id=user_id)
if users.count() != 0:
user = users[0]
通過擁有關聯字段的Flight實例進行添加關聯操作:
flight.reserve.add(user)
flight.save()
刪除操作與這類似:
flight.reserve.remove(user)
flight.save()
參考資料: