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

Represent all database connections used by the application.

Method __post_init__ Validate and convert database connection attributes after initialization.
Instance Variable mysql Configuration for the MySQL database connection.
Instance Variable oracle Configuration for the Oracle database connection.
Instance Variable pgsql Configuration for the PostgreSQL database connection.
Instance Variable redshift Configuration for the Amazon Redshift database connection.
Instance Variable sqlite Configuration for the SQLite database connection.
Instance Variable sqlserver Configuration for the Microsoft SQL Server database connection.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
def __post_init__(self): (source)

Validate and convert database connection attributes after initialization.

Ensures every connection attribute is an instance of its entity class, converting from a dictionary when needed.

Returns
NoneThis method does not return a value.
Raises
TypeErrorIf any attribute is not an instance of its expected class or dict.
mysql: orionis.foundation.config.database.MySQL | dict = (source)

Configuration for the MySQL database connection.

oracle: orionis.foundation.config.database.Oracle | dict = (source)

Configuration for the Oracle database connection.

pgsql: orionis.foundation.config.database.PGSQL | dict = (source)

Configuration for the PostgreSQL database connection.

redshift: orionis.foundation.config.database.Redshift | dict = (source)

Configuration for the Amazon Redshift database connection.

sqlite: orionis.foundation.config.database.SQLite | dict = (source)

Configuration for the SQLite database connection.

sqlserver: orionis.foundation.config.database.SQLServer | dict = (source)

Configuration for the Microsoft SQL Server database connection.