sqlalchemy.orm.util._ORMJoin

class documentation

class _ORMJoin(expression.Join):

View In Hierarchy

Extend Join to support ORM constructs as input.
Method __init__ Construct a new _expression.Join.
Method ​_splice​_into​_center Splice a join into the center.
Method join Return a _expression.Join from this _expression.FromClause to another FromClause.
Method outerjoin No summary
Class Variable inherit​_cache Indicate if this .HasCacheKey instance should make use of the cache key generation scheme used by its immediate superclass.
Instance Variable ​_joined​_from​_info Undocumented
Instance Variable ​_left​_memo Undocumented
Instance Variable ​_right​_memo Undocumented
Instance Variable ​_target​_adapter Undocumented
Instance Variable onclause Undocumented

Inherited from Join:

Method alias Return an alias of this _expression.Join.
Method is​_derived​_from Return True if this _expression.FromClause is 'derived' from the given FromClause.
Method select Create a _expression.Select from this _expression.Join.
Method self​_group Apply a 'grouping' to this _expression.ClauseElement.
Class Method ​_can​_join Undocumented
Class Method ​_create​_join Produce a _expression.Join object, given two _expression.FromClause expressions.
Class Method ​_create​_outerjoin Return an OUTER JOIN clause element.
Class Method ​_join​_condition Create a join condition between two tables or selectables.
Class Method ​_joincond​_scan​_left​_right Undocumented
Class Method ​_joincond​_trim​_constraints Undocumented
Method ​_anonymous​_fromclause Undocumented
Method ​_copy​_internals Reassign internal elements to be clones of themselves.
Method ​_match​_primaries Undocumented
Method ​_populate​_column​_collection Called on subclasses to establish the .c collection.
Method ​_refresh​_for​_new​_column Given a column added to the .c collection of an underlying selectable, produce the local version of that column, assuming this selectable ultimately should proxy this column.
Class Variable __visit​_name__ Undocumented
Class Variable ​_is​_join Undocumented
Class Variable ​_traverse​_internals Undocumented
Instance Variable full Undocumented
Instance Variable isouter Undocumented
Instance Variable left Undocumented
Instance Variable right Undocumented
Property ​_from​_objects Undocumented
Property ​_hide​_froms Undocumented
Property bind Return the bound engine associated with either the left or right side of this _sql.Join.
Property description A brief description of this _expression.FromClause.

Inherited from DMLTableRole (via Join):

Class Variable ​_role​_name Undocumented

Inherited from FromClauseRole (via Join, DMLTableRole):

Class Variable ​_is​_subquery Undocumented

Inherited from ColumnsClauseRole (via Join, DMLTableRole, FromClauseRole):

Property ​_select​_iterable Undocumented

Inherited from AllowsLambdaRole (via Join, DMLTableRole, FromClauseRole, ColumnsClauseRole):

Class Variable allows​_lambda Undocumented

Inherited from UsesInspection (via Join, DMLTableRole, FromClauseRole, ColumnsClauseRole):

Class Variable ​_post​_inspect Undocumented
Class Variable uses​_inspection Undocumented

Inherited from SQLRole (via Join, DMLTableRole, FromClauseRole, ColumnsClauseRole, ColumnListRole):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from AllowsLambdaRole (via Join, DMLTableRole, FromClauseRole, JoinTargetRole):

Class Variable allows​_lambda Undocumented

Inherited from UsesInspection (via Join, DMLTableRole, FromClauseRole, JoinTargetRole):

Class Variable ​_post​_inspect Undocumented
Class Variable uses​_inspection Undocumented

Inherited from SQLRole (via Join, DMLTableRole, FromClauseRole, JoinTargetRole, StructuralRole):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from FromClause (via Join):

Method table​_valued Return a _sql.TableValuedColumn object for this _expression.FromClause.
Method tablesample Return a TABLESAMPLE alias of this _expression.FromClause.
Class Variable c Undocumented
Class Variable schema Define the 'schema' attribute for this _expression.FromClause.
Instance Variable foreign​_keys Return the collection of _schema.ForeignKey marker objects which this FromClause references.
Instance Variable primary​_key Return the iterable collection of _schema.Column objects which comprise the primary key of this _selectable.FromClause.
Method ​_generate​_fromclause​_column​_proxies Undocumented
Method ​_init​_collections Undocumented
Method ​_is​_lexical​_equivalent Return True if this _expression.FromClause and the other represent the same lexical identity.
Method ​_reset​_column​_collection Reset the attributes linked to the FromClause.c attribute.
Class Variable ​_is​_from​_clause Undocumented
Class Variable ​_select​_iterable Undocumented
Class Variable ​_use​_schema​_map Undocumented
Class Variable is​_selectable Undocumented
Class Variable named​_with​_column Undocumented
Instance Variable ​_columns Undocumented
Property ​_cols​_populated Undocumented
Property columns A named-based collection of _expression.ColumnElement objects maintained by this _expression.FromClause.
Property entity​_namespace Return a namespace used for name-based access in SQL expressions.
Property exported​_columns A _expression.ColumnCollection that represents the "exported" columns of this _expression.Selectable.

Inherited from FromClauseRole (via Join, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole):

Class Variable ​_is​_subquery Undocumented
Class Variable ​_role​_name Undocumented

Inherited from AllowsLambdaRole (via Join, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

Class Variable allows​_lambda Undocumented

Inherited from UsesInspection (via Join, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

Class Variable ​_post​_inspect Undocumented
Class Variable uses​_inspection Undocumented

Inherited from SQLRole (via Join, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, ColumnListRole):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from AllowsLambdaRole (via Join, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

Class Variable allows​_lambda Undocumented

Inherited from UsesInspection (via Join, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

Class Variable ​_post​_inspect Undocumented
Class Variable uses​_inspection Undocumented

Inherited from SQLRole (via Join, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole, StructuralRole):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from Selectable (via Join, FromClause):

Method corresponding​_column No summary
Method lateral Return a LATERAL alias of this _expression.Selectable.
Method replace​_selectable Replace all occurrences of _expression.FromClause 'old' with the given _expression.Alias object, returning a copy of this _expression.FromClause.

Inherited from ReturnsRows (via Join, FromClause, Selectable):

Class Variable ​_is​_lateral Undocumented
Class Variable ​_is​_returns​_rows Undocumented
Class Variable ​_is​_select​_statement Undocumented
Property ​_all​_selected​_columns A sequence of column expression objects that represents the "selected" columns of this _expression.ReturnsRows.
Property selectable Undocumented

Inherited from ReturnsRowsRole (via Join, FromClause, Selectable, ReturnsRows):

Class Variable ​_role​_name Undocumented

Inherited from SQLRole (via Join, FromClause, Selectable, ReturnsRows, ReturnsRowsRole):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from ClauseElement (via Join, FromClause, Selectable, ReturnsRows):

Method compare Compare this _expression.ClauseElement to the given _expression.ClauseElement.
Method compile Compile this SQL expression.
Method params Return a copy with _expression.bindparam elements replaced.
Method unique​_params Return a copy with _expression.bindparam elements replaced.
Method __bool__ Undocumented
Method __getstate__ Undocumented
Method __invert__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method ​_clone Create a shallow copy of this ClauseElement.
Method ​_cloned​_set Return the set consisting all cloned ancestors of this ClauseElement.
Method ​_compile​_w​_cache Undocumented
Method ​_compiler Return a compiler appropriate for this ClauseElement, given a Dialect.
Method ​_execute​_on​_connection Undocumented
Method ​_negate Undocumented
Method ​_negate​_in​_binary a hook to allow the right side of a binary expression to respond to a negation of the binary expression.
Method ​_replace​_params Undocumented
Method ​_set​_propagate​_attrs Undocumented
Method ​_ungroup Return this _expression.ClauseElement without any groupings.
Method ​_with​_binary​_element​_type in the context of binary expression, convert the type of this object to the one given.
Class Variable ​_cache​_key​_traversal Undocumented
Class Variable ​_is​_bind​_parameter Undocumented
Class Variable ​_is​_clause​_list Undocumented
Class Variable ​_is​_clone​_of Undocumented
Class Variable ​_is​_from​_container Undocumented
Class Variable ​_is​_immutable Undocumented
Class Variable ​_is​_lambda​_element Undocumented
Class Variable ​_is​_select​_container Undocumented
Class Variable ​_is​_singleton​_constant Undocumented
Class Variable ​_is​_text​_clause Undocumented
Class Variable ​_is​_textual Undocumented
Class Variable ​_order​_by​_label​_element Undocumented
Class Variable is​_clause​_element Undocumented
Class Variable stringify​_dialect Undocumented
Class Variable supports​_execution Undocumented
Instance Variable ​_propagate​_attrs like annotations, however these propagate outwards liberally as SQL constructs are built, and are set up at construction time.
Property ​_constructor return the 'constructor' for this ClauseElement.

Inherited from SQLRole (via Join, FromClause, Selectable, ReturnsRows, ClauseElement):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from SupportsWrappingAnnotations (via Join, FromClause, Selectable, ReturnsRows, ClauseElement):

Method ​_annotate return a copy of this ClauseElement with annotations updated by the given dictionary.
Method ​_deannotate return a copy of this _expression.ClauseElement with annotations removed.
Method ​_with​_annotations return a copy of this ClauseElement with annotations replaced by the given dictionary.

Inherited from SupportsAnnotations (via Join, FromClause, Selectable, ReturnsRows, ClauseElement, SupportsWrappingAnnotations):

Property ​_annotations​_cache​_key Undocumented

Inherited from MemoizedHasCacheKey (via Join, FromClause, Selectable, ReturnsRows, ClauseElement):

Method ​_generate​_cache​_key return a cache key.

Inherited from HasCacheKey (via Join, FromClause, Selectable, ReturnsRows, ClauseElement, MemoizedHasCacheKey):

Class Method ​_generate​_cache​_attrs generate cache key dispatcher for a new class.
Class Method ​_generate​_cache​_key​_for​_object Undocumented
Method ​_gen​_cache​_key return an optional cache key.
Class Variable __slots__ Undocumented
Class Variable ​_hierarchy​_supports​_caching private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses.
Class Variable ​_is​_has​_cache​_key Undocumented

Inherited from Traversible (via Join, FromClause, Selectable, ReturnsRows, ClauseElement):

Method get​_children Return immediate child .visitors.Traversible elements of this .visitors.Traversible.
Method __class​_getitem__ Undocumented
def __init__(self, left, right, onclause=None, isouter=False, full=False, _left_memo=None, _right_memo=None, _extra_criteria=()):
overrides sqlalchemy.sql.expression.Join.__init__

Construct a new _expression.Join.

The usual entrypoint here is the _expression.join function or the _expression.FromClause.join method of any _expression.FromClause object.

def _splice_into_center(self, other):

Splice a join into the center.

Given join(a, b) and join(b, c), return join(a, b).join(c)

def join(self, right, onclause=None, isouter=False, full=False, join_to_left=None):
overrides sqlalchemy.sql.expression.FromClause.join

Return a _expression.Join from this _expression.FromClause to another FromClause.

E.g.:

from sqlalchemy import join

j = user_table.join(address_table,
                user_table.c.id == address_table.c.user_id)
stmt = select(user_table).select_from(j)

would emit SQL along the lines of:

SELECT user.id, user.name FROM user
JOIN address ON user.id = address.user_id

See Also

_expression.join - standalone function

_expression.Join - the type of object produced

Parameters
rightthe right side of the join; this is any _expression.FromClause object such as a _schema.Table object, and may also be a selectable-compatible object such as an ORM-mapped class.
onclausea SQL expression representing the ON clause of the join. If left at None, _expression.FromClause.join will attempt to join the two tables based on a foreign key relationship.
isouterif True, render a LEFT OUTER JOIN, instead of JOIN.
full

if True, render a FULL OUTER JOIN, instead of LEFT OUTER JOIN. Implies :paramref:`.FromClause.join.isouter`.

New in version 1.1.
join​_to​_leftUndocumented
def outerjoin(self, right, onclause=None, full=False, join_to_left=None):
overrides sqlalchemy.sql.expression.FromClause.outerjoin

Return a _expression.Join from this _expression.FromClause to another FromClause, with the "isouter" flag set to True.

E.g.:

from sqlalchemy import outerjoin

j = user_table.outerjoin(address_table,
                user_table.c.id == address_table.c.user_id)

The above is equivalent to:

j = user_table.join(
    address_table,
    user_table.c.id == address_table.c.user_id,
    isouter=True)

See Also

_expression.FromClause.join

_expression.Join

Parameters
rightthe right side of the join; this is any _expression.FromClause object such as a _schema.Table object, and may also be a selectable-compatible object such as an ORM-mapped class.
onclausea SQL expression representing the ON clause of the join. If left at None, _expression.FromClause.join will attempt to join the two tables based on a foreign key relationship.
full

if True, render a FULL OUTER JOIN, instead of LEFT OUTER JOIN.

New in version 1.1.
join​_to​_leftUndocumented
inherit_cache: bool =
overrides sqlalchemy.sql.traversals.HasCacheKey.inherit_cache

Indicate if this .HasCacheKey instance should make use of the cache key generation scheme used by its immediate superclass.

The attribute defaults to None, which indicates that a construct has not yet taken into account whether or not its appropriate for it to participate in caching; this is functionally equivalent to setting the value to False, except that a warning is also emitted.

This flag can be set to True on a particular class, if the SQL that corresponds to the object does not change based on attributes which are local to this class, and not its superclass.

See Also

:ref:`compilerext_caching` - General guideslines for setting the .HasCacheKey.inherit_cache attribute for third-party or user defined SQL constructs.

_joined_from_info =

Undocumented

_left_memo =

Undocumented

_right_memo =

Undocumented

_target_adapter =

Undocumented

onclause =
overrides sqlalchemy.sql.expression.Join.onclause

Undocumented