MCPcopy
hub / github.com/sqlalchemy/sqlalchemy / outerjoin

Function outerjoin

lib/sqlalchemy/sql/_selectable_constructors.py:358–386  ·  view source on GitHub ↗

Return an ``OUTER JOIN`` clause element. The returned object is an instance of :class:`_expression.Join`. Similar functionality is also available via the :meth:`_expression.FromClause.outerjoin` method on any :class:`_expression.FromClause`. :param left: The left side of the j

(
    left: _FromClauseArgument,
    right: _FromClauseArgument,
    onclause: Optional[_OnClauseArgument] = None,
    full: bool = False,
)

Source from the content-addressed store, hash-verified

356
357
358def outerjoin(
359 left: _FromClauseArgument,
360 right: _FromClauseArgument,
361 onclause: Optional[_OnClauseArgument] = None,
362 full: bool = False,
363) -> Join:
364 """Return an ``OUTER JOIN`` clause element.
365
366 The returned object is an instance of :class:`_expression.Join`.
367
368 Similar functionality is also available via the
369 :meth:`_expression.FromClause.outerjoin` method on any
370 :class:`_expression.FromClause`.
371
372 :param left: The left side of the join.
373
374 :param right: The right side of the join.
375
376 :param onclause: Optional criterion for the ``ON`` clause, is
377 derived from foreign key relationships established between
378 left and right otherwise.
379
380 To chain joins together, use the :meth:`_expression.FromClause.join`
381 or
382 :meth:`_expression.FromClause.outerjoin` methods on the resulting
383 :class:`_expression.Join` object.
384
385 """
386 return Join(left, right, onclause, isouter=True, full=full)
387
388
389# START OVERLOADED FUNCTIONS select Select 1-10

Callers

nothing calls this directly

Calls 1

JoinClass · 0.85

Tested by

no test coverage detected