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

Construct scheduler job stores from application configuration.

Method __init__ Initialize the schedule store.
Method _migrateDatabase Create the configured job store table and release its temporary engine.
Method database Create a database job store for the scheduler.
Async Method migrate Create the native database job table without starting the scheduler.
Method redis Create a Redis job store for the scheduler.
Instance Variable __application The application instance.
Instance Variable __scheduler_conf Scheduler conf produced by ConfigScheduler.
Instance Variable _db_manager The database connection manager.
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:orionis.IApplicationThe application instance.
db_manager:orionis.database.contracts.IConnectionManagerThe database connection manager.
Returns
NoneThis method does not return a value.
def _migrateDatabase(self): (source)

Create the configured job store table and release its temporary engine.

Returns
NoneCreate APScheduler's native table and indexes if absent.
Raises
orionis.database.QueryExceptionIf SQLAlchemy cannot create or close the storage; omit driver details.
def database(self) -> SQLAlchemyJobStore: (source)

Create a database job store for the scheduler.

Returns
apscheduler.jobstores.sqlalchemy.SQLAlchemyJobStoreA configured SQLAlchemy job store instance.
Raises
RuntimeErrorIf the database store is absent or its backend lacks required capabilities.
orionis.database.MissingDatabaseDependencyExceptionIf the resolved driver package is not installed.
async def migrate(self): (source)

Create the native database job table without starting the scheduler.

Returns
NoneCreate missing storage on a worker thread and preserve existing jobs.
Raises
RuntimeErrorIf database storage is not configured or its backend is unsupported.
orionis.database.DatabaseExceptionIf the SQL connection, driver, or schema creation fails.
def redis(self) -> RedisJobStore: (source)

Create a Redis job store for the scheduler.

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

The application instance.

__scheduler_conf: ConfigScheduler = (source)

Scheduler conf produced by ConfigScheduler.

_db_manager: IConnectionManager = (source)

The database connection manager.

config: ConfigScheduler = (source)

Get the full scheduler configuration entity.

Returns
orionis.foundation.config.scheduler.SchedulerThe 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').