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 BelongsToRelation(Relation[
Constructor: BelongsToRelation(parent, related, foreign_key, owner_key)
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 | add |
Constrain the query to the row owning the parent's foreign key. |
| Method | add |
Constrain the query to the rows owning every child's foreign key. |
| Async Method | get |
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 |
Whether eager loading has no parent keys to query. |
| Instance Variable | _foreign |
Column on the parent referencing the related row; defaults to snake_case(RelatedClass) + "_id". |
| Instance Variable | _owner |
Column on the related table identifying the owning row; defaults to the related model's primary key. |
Inherited from Relation:
| Class Method | no |
Build a relationship instance without its single-parent constraint. |
| Method | __await__ |
Allow await directly on a relationship without a terminal. |
| Async Method | get |
Execute the relationship query assembled for eager loading. |
| Instance Variable | _connection |
Use the parent's configured connection for an unbound related model. |
| Instance Variable | _parent |
Model instance the relationship is accessed from. |
| Instance Variable | _resolved |
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 | find |
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 | first |
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 | with |
Eager load the given relationships alongside the query. |
Inherited from IQueryBuilderBase (via Relation, IRelation, IModelQueryBuilder):
| Method | add |
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 | cross |
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 | doesnt |
Report whether the query matches no rows. |
| Async Method | exists |
Report whether the query matches at least one row. |
| Method | for |
Limit the query to a single page of results. |
| Method | full |
Add a FULL OUTER JOIN to the query. |
| Method | group |
Add grouping columns to the query. |
| Method | having |
Add a post-grouping condition to the query. |
| Method | having |
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 | join |
Join a subquery as a derived table with an INNER JOIN. |
| Method | latest |
Order the query by a timestamp column in descending order. |
| Method | left |
Add a LEFT OUTER JOIN to the query. |
| Method | left |
Join a subquery as a derived table with a LEFT OUTER JOIN. |
| Method | limit |
Limit the number of rows returned by the query. |
| Method | lock |
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 | order |
Add an ordering rule to the query. |
| Method | or |
Add an OR-combined post-grouping condition to the query. |
| Method | or |
Add an OR-combined filtering condition. |
| Method | or |
Add an OR-combined comparison between two columns. |
| Method | or |
Add an OR-combined EXISTS condition. |
| Method | or |
Add an OR-combined set-membership condition. |
| Method | or |
Add an OR-combined NOT EXISTS condition. |
| Method | or |
Add an OR-combined set-exclusion condition. |
| Method | or |
Add an OR-combined IS NOT NULL condition. |
| Method | or |
Add an OR-combined IS NULL condition. |
| Method | or |
Add an OR-combined raw SQL condition. |
| Method | right |
Add a RIGHT OUTER JOIN to the query. |
| Method | right |
Join a subquery as a derived table with a RIGHT OUTER JOIN. |
| Method | select |
Restrict the query projection to the given columns. |
| Method | select |
Append a raw SQL fragment to the projection. |
| Method | select |
Append a scalar subquery to the projection under an alias. |
| Method | shared |
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 | to |
Return the engine-agnostic plan assembled so far. |
| Method | to |
Render the current SELECT query without executing or mutating it. |
| Method | union |
Append another query's rows, collapsing duplicates. |
| Method | union |
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 | where |
Filter rows whose column value lies between two boundaries. |
| Method | where |
Compare two columns of the query against each other. |
| Method | where |
Filter rows whose column value contains the given text. |
| Method | where |
Filter rows whose column value ends with the given text. |
| Method | where |
Keep rows for which a correlated subquery returns any row. |
| Method | where |
Filter rows matching a case-insensitive SQL LIKE pattern. |
| Method | where |
Filter rows whose column value belongs to the given set. |
| Method | where |
Filter rows whose column value matches an SQL LIKE pattern. |
| Method | where |
Filter rows whose column value lies outside two boundaries. |
| Method | where |
Keep rows for which a correlated subquery returns no row. |
| Method | where |
Filter rows not matching a case-insensitive LIKE pattern. |
| Method | where |
Filter rows whose column value is outside the given set. |
| Method | where |
Filter rows not matching an SQL LIKE pattern. |
| Method | where |
Filter rows whose column value is not NULL. |
| Method | where |
Filter rows whose column value is NULL. |
| Method | where |
Add an AND-combined raw SQL condition. |
| Method | where |
Filter rows whose column value matches a regular expression. |
| Method | where |
Filter rows whose column value starts with the given text. |
_orm.Model, related: type[ TRelated], foreign_key: str | None, owner_key: str | None):
(source)
¶
orionis.orm.relations.Relation.__init__Bind the relationship.
| Parameters | |
parent:orionis.orm.Model | Model instance the relationship is accessed from. |
related:type of orionis.orm.Model | Model class the relationship targets. |
foreignstr or None | Column on the parent referencing the related row; defaults to snake_case(RelatedClass) + "_id". |
ownerstr or None | Column on the related table identifying the owning row; defaults to the related model's primary key. |
| Returns | |
None | No return value. |
Constrain the query to the rows owning every child's foreign key.
| Parameters | |
models:list of orionis.orm.Model | Child instances being eager loaded together. |
| Returns | |
None | No return value. |
Retrieve the owning row referenced by the parent's foreign key.
| Returns | |
orionis.orm.Model or None | Owning model, or None when the foreign key is unset or references no row. |
orionis.orm.relations.Relation.matchAttach the owning row to each child instance.
| Parameters | |
models:list of orionis.orm.Model | Child instances being eager loaded together. |
results:orionis.support.types.Collection | Owning rows produced by getEager. |
name:str | Relationship name the result is stored under. |
| Returns | |
None | No return value. |
orionis.orm.relations.Relation.__slots__Declare the instance attribute slots reserved by this class.