mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-30 17:16:10 +00:00
Code Issues 32 Releases Wiki Activity

[1.11.x] Refs #23853 -- Updated sql.query.Query.join() docstring.

Browse Source 
Follow up to ab89414f40.

Backport of 7acbe89cc2 from master
This commit is contained in:
Tim Graham
2017-06-13 14:16:52 -04:00
parent 16431b03f8
commit 31d7fc8541
1 changed files with 7 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
django/db/models/sql/query.py
View File

@@ -902,27 +902,16 @@ class Query(object):
def join(self, join, reuse=None): def join(self, join, reuse=None):
""" """
Returns an alias for the join in 'connection', either reusing an Return an alias for the 'join', either reusing an existing alias for
existing alias for that join or creating a new one. 'connection' is a that join or creating a new one. 'join' is either a
tuple (lhs, table, join_cols) where 'lhs' is either an existing sql.datastructures.BaseTable or Join.
table alias or a table name. 'join_cols' is a tuple of tuples containing
columns to join on ((l_id1, r_id1), (l_id2, r_id2)). The join corresponds
to the SQL equivalent of::
lhs.l_id1 = table.r_id1 AND lhs.l_id2 = table.r_id2 The 'reuse' parameter can be either None which means all joins are
reusable, or it can be a set containing the aliases that can be reused.
The 'reuse' parameter can be either None which means all joins
(matching the connection) are reusable, or it can be a set containing
the aliases that can be reused.
A join is always created as LOUTER if the lhs alias is LOUTER to make A join is always created as LOUTER if the lhs alias is LOUTER to make
sure we do not generate chains like t1 LOUTER t2 INNER t3. All new sure chains like t1 LOUTER t2 INNER t3 aren't generated. All new
joins are created as LOUTER if nullable is True. joins are created as LOUTER if the join is nullable.
If 'nullable' is True, the join can potentially involve NULL values and
is a candidate for promotion (to "left outer") when combining querysets.
The 'join_field' is the field we are joining along (if any).
""" """
reuse = [a for a, j in self.alias_map.items() reuse = [a for a, j in self.alias_map.items()
if (reuse is None or a in reuse) and j == join] if (reuse is None or a in reuse) and j == join]