Skip to content

Commit

Permalink
Adding more info in joins
Browse files Browse the repository at this point in the history
  • Loading branch information
coleifer committed Oct 8, 2012
1 parent 35a8464 commit aecc147
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 7 additions & 1 deletion docs/peewee/querying.rst
Expand Up @@ -76,13 +76,19 @@ familiar with Django's ORM, it is analagous to the ``filter()`` method.
Joining
^^^^^^^

You can join on tables related to one another by :py:class:`ForeignKeyField`. The ``join``
You can join on tables related to one another by :py:class:`ForeignKeyField`. The :py:meth:`~SelectQuery.join`
method acts on the :py:class:`Model` that is the current "query context".
This is either:

* the model the query class was initialized with
* the model most recently JOINed on

There are three types of joins by default:

* JOIN_INNER (default)
* JOIN_LEFT_OUTER
* JOIN_FULL

Here is an example using JOINs:

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/peewee/upgrading.rst
Expand Up @@ -131,7 +131,7 @@ to even write.
The 2.0 API is hopefully more consistent. Selections, groupings, functions, joins
and orderings all pretty much conform to the same API. Likewise, where and having
clauses are handled the same way (in 1.0 the having clause is simply a raw string).
The new ``fn`` object actually is a wrapper -- whatever appears to the right of the
The new :py:class:`fn` object actually is a wrapper -- whatever appears to the right of the
dot (i.e. fn.*Lower*) -- is treated as a function that can take any arbitrary
parameters.

Expand Down

0 comments on commit aecc147

Please sign in to comment.