join docs (and docstring

Issue #230 resolved
Former user created an issue

neither one mentions that if no "on" parameter is given, SA will try to join on FKs

-JBE

Comments (2)

  1. Mike Bayer repo owner

    the SA docs themselves mention it:

    The join criterion in a join() call is optional. If not specified, the condition will be derived from the foreign key relationships of the two tables. If no criterion can be constructed, an exception will be raised.

    but as far as docstrings, theyre all over the place yah.

    please submit what verbiage you'd like to see for this (both the docs and the docstrings).

  2. Mike Bayer repo owner

    docstrings for join() also say:

        """return a JOIN clause element (regular inner join).
    
        left - the left side of the join
        right - the right side of the join
        onclause - optional criterion for the ON clause, 
        is derived from foreign key relationships otherwise
    

    since no alternate verbiage has been submitted here, closing it

  3. Log in to comment