ORIONIS API REFERENCE

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.

Explore modules View classes

orionis.orm.query.SelectPlan

class documentation

class SelectPlan: (source)

View In Hierarchy

Complete, engine-agnostic description of a SELECT query.

Method clone Return an independent copy of the plan.
Instance Variable aggregate Aggregate projection replacing the column list when present.
Instance Variable alias Name the main table is referred to by inside the query, or None to use its logical table name. Required to self-join a table against itself once joins are composed on top of a plan.
Instance Variable columns Projected columns; empty means all columns. Entries may be qualified as "table.column" once joins is non-empty.
Instance Variable distinct Whether duplicate rows are collapsed via SELECT DISTINCT.
Instance Variable groups Grouping columns.
Instance Variable havings Conditions applied after grouping.
Instance Variable joins Additional table sources joined onto the main table.
Instance Variable limit_value Maximum number of rows to return.
Instance Variable lock Row locking mode requested for the selected rows.
Instance Variable offset_value Number of rows to skip.
Instance Variable orders Ordering rules.
Instance Variable table Table the query runs against.
Instance Variable unions Queries appended to this one through UNION.
Instance Variable wheres Filtering conditions combined left to right.
def clone(self) -> SelectPlan: (source)

Return an independent copy of the plan.

Mutable clause lists are shallow-copied so the clone can be modified without affecting the original plan.

Returns
SelectPlanDetached copy of this plan.
aggregate: AggregateClause or None = (source)

Aggregate projection replacing the column list when present.

alias: str or None = (source)

Name the main table is referred to by inside the query, or None to use its logical table name. Required to self-join a table against itself once joins are composed on top of a plan.

columns: tuple of str = (source)

Projected columns; empty means all columns. Entries may be qualified as "table.column" once joins is non-empty.

distinct: bool = (source)

Whether duplicate rows are collapsed via SELECT DISTINCT.

groups: list of str = (source)

Grouping columns.

havings: list of WhereClause = (source)

Conditions applied after grouping.

joins: list of JoinExpression = (source)

Additional table sources joined onto the main table.

limit_value: int or None = (source)

Maximum number of rows to return.

lock: LockMode or None = (source)

Row locking mode requested for the selected rows.

offset_value: int or None = (source)

Number of rows to skip.

orders: list of OrderClause = (source)

Ordering rules.

table: TableDefinition = (source)

Table the query runs against.

unions: list of UnionClause = (source)

Queries appended to this one through UNION.

wheres: list of WhereClause = (source)

Filtering conditions combined left to right.