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.

package documentation

Group the orm query components and public imports.

Module base_builder Engine shared by every Orionis query builder.
Module builder Fluent query builder bound to a model class.
Module expressions Provide orm query operations.
Module join_clause Accumulator of ON conditions for a join declared with a callback.
Module raw_builder Fluent query builder over a plain table name.

From __init__.py:

Class AggregateClause Aggregate projection applied to a select plan.
Class AggregateFunction Aggregate functions supported by the query language.
Class DeletePlan Engine-agnostic description of a DELETE statement.
Class InsertPlan Engine-agnostic description of an INSERT statement.
Class ModelQueryBuilder Fluent query builder bound to a model class.
Class OrderClause Single ordering rule inside a query plan.
Class SelectPlan Complete, engine-agnostic description of a SELECT query.
Class SortDirection Sort directions supported by order clauses.
Class UpdatePlan Engine-agnostic description of an UPDATE statement.
Class WhereClause Single filtering condition inside a query plan.
Class WhereType Kinds of where clauses supported by the query language.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
Constant _EXPRESSIONS_MODULE Module defining the public query plan entities and enumerations.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
_EXPORTS = (source)

Public export names mapped to their defining modules and attributes.

Value
{'AggregateClause': (_EXPRESSIONS_MODULE, 'AggregateClause'),
 'AggregateFunction': (_EXPRESSIONS_MODULE, 'AggregateFunction'),
 'DeletePlan': (_EXPRESSIONS_MODULE, 'DeletePlan'),
 'InsertPlan': (_EXPRESSIONS_MODULE, 'InsertPlan'),
 'ModelQueryBuilder': ('orionis.orm.query.builder', 'ModelQueryBuilder'),
 'OrderClause': (_EXPRESSIONS_MODULE, 'OrderClause'),
 'SelectPlan': (_EXPRESSIONS_MODULE, 'SelectPlan'),
...
_EXPRESSIONS_MODULE: str = (source)

Module defining the public query plan entities and enumerations.

Value
'orionis.orm.query.expressions'