Class JoinTerm

source code

object --+
         |
        JoinTerm

Temporary object created while composing a join across tables using Table.join_on and '+' addition. JoinTerm's are usually created by calling join_on on a Table object, as in:

   customers.join_on("id") + orders.join_on("custid")

This join expression would set up the join relationship equivalent to:

   customers.join(orders, id="custid")

If tables are being joined on attributes that have the same name in both tables, then a join expression could be created by adding a JoinTerm of one table directly to the other table:

   customers.join_on("custid") + orders

Once the join expression is composed, the actual join is performed using function call notation:

   customerorders = customers.join_on("custid") + orders
   for custord in customerorders():
       print custord

When calling the join expression, you can optionally specify a list of attributes as defined in Table.join.