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.

class documentation

Inverse relationship: the foreign key lives on the parent row.

Mirrors Eloquent's BelongsTo: for instance Post belongsTo User, where posts.user_id points back at users.id. Unlike hasOne/hasMany, the foreign key is read from the parent instance itself, never queried on the related table.

Method __init__ Bind the relationship.
Method addConstraints Constrain the query to the row owning the parent's foreign key.
Method addEagerConstraints Constrain the query to the rows owning every child's foreign key.
Async Method getResults Retrieve the owning row referenced by the parent's foreign key.
Method match Attach the owning row to each child instance.
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _eager_keys_empty Whether eager loading has no parent keys to query.
Instance Variable _foreign_key Column on the parent referencing the related row; defaults to snake_case(RelatedClass) + "_id".
Instance Variable _owner_key Column on the related table identifying the owning row; defaults to the related model's primary key.

Inherited from Relation:

Class Method noConstraints Build a relationship instance without its single-parent constraint.
Method __await__ Allow await directly on a relationship without a terminal.
Async Method getEager Execute the relationship query assembled for eager loading.
Instance Variable _connection_name Use the parent's configured connection for an unbound related model.
Instance Variable _parent Model instance the relationship is accessed from.
Instance Variable _resolved_connection Retain the connection that owns the parent model's loaded state.

Inherited from IModelQueryBuilder (via Relation, IRelation):

Async Method find Retrieve a model by its primary key.
Async Method findOrFail Retrieve a model by primary key or raise when absent.
Async Method first Execute the query and hydrate only the first matching row.
Async Method firstOrFail Return the first matching row or raise when none exists.
Async Method get Execute the query and hydrate every matching row.
Method load Eager load the given relationships; alias of withRelations.
Async Method paginate Execute the query returning a length-aware page of results.
Async Method pluck Return one column of every matching row.
Async Method value Return a single column value of the first matching row.
Method withRelations Eager load the given relationships alongside the query.

Inherited from IQueryBuilderBase (via Relation, IRelation, IModelQueryBuilder):

Method addSelect Append columns to the current projection.
Async Method avg Return the average value of a column among matching rows.
Method chunks Iterate bounded, explicitly ordered result batches when supported.
Method clone Return an independent copy of this builder.
Async Method count Count the rows matched by the query.
Method crossJoin Add a CROSS JOIN to the query.
Async Method delete Delete the rows matched by the query.
Method distinct Collapse duplicate rows from the query results.
Async Method doesntExist Report whether the query matches no rows.
Async Method exists Report whether the query matches at least one row.
Method forPage Limit the query to a single page of results.
Method fullJoin Add a FULL OUTER JOIN to the query.
Method groupBy Add grouping columns to the query.
Method having Add a post-grouping condition to the query.
Method havingRaw Add a raw SQL post-grouping condition.
Async Method insert Insert one or many rows into the target table.
Method join Add an INNER JOIN to the query.
Method joinSub Join a subquery as a derived table with an INNER JOIN.
Method latest Order the query by a timestamp column in descending order.
Method leftJoin Add a LEFT OUTER JOIN to the query.
Method leftJoinSub Join a subquery as a derived table with a LEFT OUTER JOIN.
Method limit Limit the number of rows returned by the query.
Method lockForUpdate Lock the selected rows against concurrent writes.
Async Method max Return the maximum value of a column among matching rows.
Async Method min Return the minimum value of a column among matching rows.
Method offset Skip the given number of rows before returning results.
Method oldest Order the query by a timestamp column in ascending order.
Method orderBy Add an ordering rule to the query.
Method orHaving Add an OR-combined post-grouping condition to the query.
Method orWhere Add an OR-combined filtering condition.
Method orWhereColumn Add an OR-combined comparison between two columns.
Method orWhereExists Add an OR-combined EXISTS condition.
Method orWhereIn Add an OR-combined set-membership condition.
Method orWhereNotExists Add an OR-combined NOT EXISTS condition.
Method orWhereNotIn Add an OR-combined set-exclusion condition.
Method orWhereNotNull Add an OR-combined IS NOT NULL condition.
Method orWhereNull Add an OR-combined IS NULL condition.
Method orWhereRaw Add an OR-combined raw SQL condition.
Method rightJoin Add a RIGHT OUTER JOIN to the query.
Method rightJoinSub Join a subquery as a derived table with a RIGHT OUTER JOIN.
Method select Restrict the query projection to the given columns.
Method selectRaw Append a raw SQL fragment to the projection.
Method selectSub Append a scalar subquery to the projection under an alias.
Method sharedLock Lock the selected rows in shared mode.
Method skip Skip the given number of rows; alias of offset.
Async Method sum Return the sum of a column among matching rows.
Method take Limit the number of rows returned; alias of limit.
Method toPlan Return the engine-agnostic plan assembled so far.
Method toSql Render the current SELECT query without executing or mutating it.
Method union Append another query's rows, collapsing duplicates.
Method unionAll Append another query's rows, keeping duplicates.
Async Method update Mass update the rows matched by the query.
Method where Add an AND-combined filtering condition.
Method whereBetween Filter rows whose column value lies between two boundaries.
Method whereColumn Compare two columns of the query against each other.
Method whereContains Filter rows whose column value contains the given text.
Method whereEndsWith Filter rows whose column value ends with the given text.
Method whereExists Keep rows for which a correlated subquery returns any row.
Method whereILike Filter rows matching a case-insensitive SQL LIKE pattern.
Method whereIn Filter rows whose column value belongs to the given set.
Method whereLike Filter rows whose column value matches an SQL LIKE pattern.
Method whereNotBetween Filter rows whose column value lies outside two boundaries.
Method whereNotExists Keep rows for which a correlated subquery returns no row.
Method whereNotILike Filter rows not matching a case-insensitive LIKE pattern.
Method whereNotIn Filter rows whose column value is outside the given set.
Method whereNotLike Filter rows not matching an SQL LIKE pattern.
Method whereNotNull Filter rows whose column value is not NULL.
Method whereNull Filter rows whose column value is NULL.
Method whereRaw Add an AND-combined raw SQL condition.
Method whereRegexpMatch Filter rows whose column value matches a regular expression.
Method whereStartsWith Filter rows whose column value starts with the given text.
def __init__(self, parent: _orm.Model, related: type[TRelated], foreign_key: str | None, owner_key: str | None): (source)

Bind the relationship.

Parameters
parent:orionis.orm.ModelModel instance the relationship is accessed from.
related:type of orionis.orm.ModelModel class the relationship targets.
foreign_key:str or NoneColumn on the parent referencing the related row; defaults to snake_case(RelatedClass) + "_id".
owner_key:str or NoneColumn on the related table identifying the owning row; defaults to the related model's primary key.
Returns
NoneNo return value.
def addConstraints(self): (source)

Constrain the query to the row owning the parent's foreign key.

Returns
NoneNo return value.
def addEagerConstraints(self, models: list[_orm.Model]): (source)

Constrain the query to the rows owning every child's foreign key.

Parameters
models:list of orionis.orm.ModelChild instances being eager loaded together.
Returns
NoneNo return value.
async def getResults(self) -> TRelated | None: (source)

Retrieve the owning row referenced by the parent's foreign key.

Returns
orionis.orm.Model or NoneOwning model, or None when the foreign key is unset or references no row.
def match(self, models: list[_orm.Model], results: Collection, name: str): (source)

Attach the owning row to each child instance.

Parameters
models:list of orionis.orm.ModelChild instances being eager loaded together.
results:orionis.support.types.CollectionOwning rows produced by getEager.
name:strRelationship name the result is stored under.
Returns
NoneNo return value.
__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

_eager_keys_empty = (source)

Whether eager loading has no parent keys to query.

_foreign_key = (source)

Column on the parent referencing the related row; defaults to snake_case(RelatedClass) + "_id".

_owner_key = (source)

Column on the related table identifying the owning row; defaults to the related model's primary key.