Skip to content

Commit

Permalink
Document do_auto_join argument.
Browse files Browse the repository at this point in the history
  • Loading branch information
bodik committed Jun 12, 2019
1 parent e0a9ba0 commit aa1517e
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,10 @@ The automatic join is only possible if SQLAlchemy_ can implictly
determine the condition for the join, for example because of a foreign
key relationship.
Automatic joins allow flexibility for clients to filter and sort by
related objects without specifying all possible joins on the server
beforehand.
Automatic joins allow flexibility for clients to filter and sort by related
objects without specifying all possible joins on the server beforehand. Feature
can be explicitly disabled by passing ``do_auto_join=False`` argument to the
``apply_filters``` call.
Note that first filter of the second block does not specify a model.
It is implictly applied to the ``Foo`` model because that is the only
Expand Down

0 comments on commit aa1517e

Please sign in to comment.