orionis.orm.query.join_clause.JoinClause

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class JoinClause: (source)

Constructor: JoinClause()

Accumulator of ON conditions for a join declared with a callback.

Handed to the callback form of the join helpers so several ON conditions can be combined, mirroring the fluent join syntax of query builders.

Method	`__init__`	Initialize an empty set of ON conditions.
Method	`conditions`	Return the ON conditions collected so far.
Method	`on`	Add an AND-combined column comparison to the ON clause.
Method	`orOn`	Add an OR-combined column comparison to the ON clause.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_conditions`	Undocumented

Initialize an empty set of ON conditions.

Returns
`None`	This method does not return a value.

def conditions(self) -> list[JoinCondition]: (source) ¶

Return the ON conditions collected so far.

Returns
`list of JoinCondition`	Conditions in declaration order.

def on(self, first: str, operator: str, second: str) -> Self: (source) ¶

Add an AND-combined column comparison to the ON clause.

Parameters
first:`str`	Left-hand column reference, optionally qualified.
operator:`str`	Comparison operator relating both sides.
second:`str`	Right-hand column reference, optionally qualified.

Returns
`JoinClause`	The same clause, enabling fluent chaining.

def orOn(self, first: str, operator: str, second: str) -> Self: (source) ¶

Add an OR-combined column comparison to the ON clause.

Parameters
first:`str`	Left-hand column reference, optionally qualified.
operator:`str`	Comparison operator relating both sides.
second:`str`	Right-hand column reference, optionally qualified.

Returns
`JoinClause`	The same clause, enabling fluent chaining.

Undocumented

_conditions: list[JoinCondition] = (source) ¶

Undocumented