註解Django的查詢集有一個左外連接？

Question

說我有一個模型：

class Foo(models.Model): 
    ... 

和另一種模式，基本上給出了關於Foo每個用戶的信息：

class UserFoo(models.Model): 
    user = models.ForeignKey(User) 
    foo = models.ForeignKey(Foo) 
    ... 

    class Meta: 
     unique_together = ("user", "foo") 

我想產生的Foo個查詢集，但與註解基於user=request.user（可選）相關UserFoo。

因此，這實際上是一個LEFT OUTER JOIN on (foo.id = userfoo.foo_id AND userfoo.user_id = ...)

Answer 1

與raw一個解決方案可能看起來像

foos = Foo.objects.raw("SELECT foo.* FROM foo LEFT OUTER JOIN userfoo ON (foo.id = userfoo.foo_id AND foo.user_id = %s)", [request.user.id]) 

你需要修改SELECT包括來自userfoo額外的字段將被註釋在查詢集所產生的Foo實例。

Answer 2

你的建議是，你會得到好這兩個查詢（不使用生（）），這種類型的查詢是不是在目前的ORM所能表述。

Answer 3

你可以做到這一點使用simonw的django-queryset-transform避免硬編碼原始的SQL查詢 - 代碼將是這個樣子：

def userfoo_retriever(qs): 
    userfoos = dict((i.pk, i) for i in UserFoo.objects.filter(foo__in=qs)) 
    for i in qs: 
     i.userfoo = userfoos.get(i.pk, None) 

for foo in Foo.objects.filter(…).tranform(userfoo_retriever): 
    print foo.userfoo 

這種做法已經相當成功了這一需求，並有效地檢索M2M值;您的查詢次數不會是相當低，但在某些數據庫（咳嗽 MySQL的咳嗽）做兩個簡單的查詢，往往比一個複雜的連接和衆多的地方，我最需要的情況下，有更多的快更難以侵入ORM表達式的複雜性。

Answer 4

說明：此方法在Django 1.6+中不起作用。正如tcarobruce的comment below解釋的那樣，promote參數被移除的ticket #19849: ORM Cleanup一部分。

---

Django不提供完全內置的方式做到這一點，但它不是neccessary構建一個完全原始查詢。 （此方法不適用於從UserFoo選擇*工作，所以我使用.comment作爲一個例子場從UserFoo包括。）

的QuerySet.extra() method使我們能夠項添加到SELECT和WHERE我們的查詢的WHERE子句。我們用這包括在我們的結果UserFoo表中的字段，並限制我們的UserFoo匹配當前用戶。

results = Foo.objects.extra(
    select={"user_comment": "UserFoo.comment"}, 
    where=["(UserFoo.user_id IS NULL OR UserFoo.user_id = %s)"], 
    params=[request.user.id] 
) 

該查詢仍然需要UserFoo表。這將有可能使用.extras(tables=...)得到一個隱含的INNER JOIN，但對於OUTER JOIN，我們需要修改內部查詢對象我們自己。

connection = (
    UserFoo._meta.db_table, User._meta.db_table, # JOIN these tables 
    "user_id",    "id",     # on these fields 
) 

results.query.join( # modify the query 
    connection,  # with this table connection 
    promote=True, # as LEFT OUTER JOIN 
) 

我們現在可以評估結果。每個實例的.user_comment屬性都包含UserFoo或None（如果不存在）的值。

print results[0].user_comment 

（感謝this blog post科林·科普蘭用於顯示我怎麼做外連接。）

Answer 5

我偶然發現了這個問題，我無法不訴諸原始SQL來解決，但我不想重寫整個查詢。

以下是關於如何使用外部原始sql擴充查詢集而不必關心生成查詢集的實際查詢的說明。

下面是一個典型場景：你有一個像網站reddit的一個LinkPost模型和UserPostVote模式，就像這樣：

class LinkPost(models.Model): 
some fields.... 

class UserPostVote(models.Model): 
    user = models.ForeignKey(User,related_name="post_votes") 
    post = models.ForeignKey(LinkPost,related_name="user_votes") 
    value = models.IntegerField(null=False, default=0) 

其中userpostvote表收集的用戶的票上的帖子。 現在，您正在嘗試使用分頁應用顯示用戶的首頁，但您希望箭頭對用戶已投票的帖子顯示爲紅色。

首先你得到的職位頁：

post_list = LinkPost.objects.all() 
paginator = Paginator(post_list,25) 
posts_page = paginator.page(request.GET.get('page')) 

所以現在你通過選擇職位，以顯示Django的分頁程序生成的查詢集posts_page。我們現在如何在將每個帖子呈現在模板中之前添加用戶投票的註釋？

這裏是棘手的，我無法找到一個乾淨的ORM解決方案。 select_related不會允許您僅獲取與登錄用戶相對應的投票，並且循環發佈帖子會執行一堆查詢而不是一個，並且執行所有原始意思是我們不能使用分頁應用程序中的查詢集。

因此，這裏是我如何做到這一點：

q1 = posts_page.object_list.query # The query object of the queryset 
q1_alias = q1.get_initial_alias() # This forces the query object to generate it's sql 
(q1str, q1param) = q1.sql_with_params() #This gets the sql for the query along with 
             #parameters, which are none in this example 

我們現在擁有的查詢集查詢，只是包裝它，別名和左外連接到它：

q2_augment = "SELECT B.value as uservote, A.* 
from ("+q1str+") A LEFT OUTER JOIN reddit_userpostvote B 
ON A.id = B.post_id AND B.user_id = %s" 
q2param = (request.user.id,) 
posts_augmented = LinkPost.objects.raw(q2_augment,q1param+q2param) 

瞧！現在我們可以在擴充的查詢集中訪問post.uservote。 而我們只需用一個查詢就可以打開數據庫。

Answer 6

這個答案可能不是你正在尋找的，但是因爲它在google搜索「django annotate outer join」時的第一個結果，所以我會在這裏發佈它。

注：在Djang上測試1。7

假設你有以下型號

class User(models.Model): 
    name = models.CharField() 

class EarnedPoints(models.Model): 
    points = models.PositiveIntegerField() 
    user = models.ForgeinKey(User) 

爲了讓你可以做這樣的事情

User.objects.annotate(points=Sum("earned_points__points")) 

這會工作總用戶點，但它會不回報用戶誰沒有點，這裏我們需要外部連接，沒有任何直接的黑客或原始sql

你可以通過這樣做來實現

users_with_points = User.objects.annotate(points=Sum("earned_points__points")) 
result = users_with_points | User.objects.exclude(pk__in=users_with_points) 

這將被翻譯成OUTER LEFT JOIN並且所有用戶都將被返回。沒有積分的用戶的積分屬性值爲None。

希望幫助

Answer 7

對於外連接： 一旦你有一個從Foo一個QuerySet qs，其中包括來自userfoo到列的引用，可以促進內連接到外部與連接 qs.query.promote_joins(["userfoo"])

Answer 8

你不應該爲此採用extra或raw。

以下應該工作。

Foo.objects.filter(
    Q(userfoo_set__user=request.user) | 
    Q(userfoo_set=None) # This forces the use of LOUTER JOIN. 
).annotate(
    comment=F('userfoo_set__comment'), 
    # ... annotate all the fields you'd like to see added here. 
)