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

Undocumented

Method __init__ Initialize the schedule store.
Method database Create a database job store for the scheduler.
Method redis Create a Redis job store for the scheduler.
Instance Variable __application Undocumented
Instance Variable __scheduler_conf Undocumented
Instance Variable _db_manager Undocumented
Property config Get the full scheduler configuration entity.
Property store Get the configured job store type.
def __init__(self, app: IApplication, db_manager: IConnectionManager): (source)

Initialize the schedule store.

Parameters
app:IApplicationThe application instance.
db_manager:IConnectionManagerThe database connection manager.
Returns
NoneThis method does not return a value.
def database(self) -> SQLAlchemyJobStore: (source)

Create a database job store for the scheduler.

Returns
SQLAlchemyJobStoreA configured SQLAlchemy job store instance.
Raises
RuntimeErrorIf the database store configuration is not set.
MissingDatabaseDependencyExceptionIf the resolved driver package is not installed.
def redis(self) -> RedisJobStore: (source)

Create a Redis job store for the scheduler.

Returns
RedisJobStoreA configured Redis job store instance.
Raises
RuntimeErrorIf the Redis store configuration is not set.
__application: IApplication = (source)

Undocumented

__scheduler_conf: ConfigScheduler = (source)

Undocumented

_db_manager: IConnectionManager = (source)

Undocumented

config: ConfigScheduler = (source)

Get the full scheduler configuration entity.

Returns
ConfigSchedulerThe scheduler configuration (store, jitter, max_instances, misfire_grace_time, coalesce, replace_existing, etc.).

Get the configured job store type.

Returns
strThe job store type (e.g., 'redis', 'database').