class documentation

class Join:

View In Hierarchy

Used by sql.Query and sql.SQLCompiler to generate JOIN clauses into the FROM entry. For example, the SQL generated could be

LEFT OUTER JOIN "sometable" T1 ON ("othertable"."sometable_id" = "sometable"."id")

This class is primarily used in Query.alias_map. All entries in alias_map must be Join compatible by providing the following attributes and methods:

  • table_name (string)
  • table_alias (possible alias for the table, can be None)
  • join_type (can be None for those entries that aren't joined from anything)
  • parent_alias (which table is this join's parent, can be None similarly to join_type)
  • as_sql()
  • relabeled_clone()
Method __eq__ Undocumented
Method __hash__ Undocumented
Method __init__ Undocumented
Method as​_sql Generate the full LEFT OUTER JOIN sometable ON sometable.somecol = othertable.othercol, params clause for this join.
Method demote Undocumented
Method equals Undocumented
Method promote Undocumented
Method relabeled​_clone Undocumented
Instance Variable filtered​_relation Undocumented
Instance Variable join​_cols Undocumented
Instance Variable join​_field Undocumented
Instance Variable join​_type Undocumented
Instance Variable nullable Undocumented
Instance Variable parent​_alias Undocumented
Instance Variable table​_alias Undocumented
Instance Variable table​_name Undocumented
Property identity Undocumented
def __eq__(self, other):

Undocumented

def __hash__(self):

Undocumented

def __init__(self, table_name, parent_alias, table_alias, join_type, join_field, nullable, filtered_relation=None):

Undocumented

def as_sql(self, compiler, connection):
Generate the full
LEFT OUTER JOIN sometable ON sometable.somecol = othertable.othercol, params

clause for this join.

def demote(self):

Undocumented

def equals(self, other):

Undocumented

def promote(self):

Undocumented

def relabeled_clone(self, change_map):

Undocumented

filtered_relation =

Undocumented

join_cols =

Undocumented

join_field =

Undocumented

join_type =

Undocumented

nullable =

Undocumented

parent_alias =

Undocumented

table_alias =

Undocumented

table_name =

Undocumented

@property
identity =

Undocumented