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
class ScheduleStore(IScheduleStore): (source)
Constructor: ScheduleStore(app, db_manager)
Construct scheduler job stores from application configuration.
| Method | __init__ |
Initialize the schedule store. |
| Method | _migrate |
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 |
Scheduler conf produced by ConfigScheduler. |
| Instance Variable | _db |
The database connection manager. |
| Property | config |
Get the full scheduler configuration entity. |
| Property | store |
Get the configured job store type. |
Initialize the schedule store.
| Parameters | |
app:orionis.IApplication | The application instance. |
dborionis.database.contracts.IConnectionManager | The database connection manager. |
| Returns | |
None | This method does not return a value. |
Create the configured job store table and release its temporary engine.
| Returns | |
None | Create APScheduler's native table and indexes if absent. |
| Raises | |
orionis.database.QueryException | If SQLAlchemy cannot create or close the storage; omit driver details. |
Create a database job store for the scheduler.
| Returns | |
apscheduler.jobstores.sqlalchemy.SQLAlchemyJobStore | A configured SQLAlchemy job store instance. |
| Raises | |
RuntimeError | If the database store is absent or its backend lacks required capabilities. |
orionis.database.MissingDatabaseDependencyException | If the resolved driver package is not installed. |
Create the native database job table without starting the scheduler.
| Returns | |
None | Create missing storage on a worker thread and preserve existing jobs. |
| Raises | |
RuntimeError | If database storage is not configured or its backend is unsupported. |
orionis.database.DatabaseException | If the SQL connection, driver, or schema creation fails. |
Create a Redis job store for the scheduler.
| Returns | |
apscheduler.jobstores.redis.RedisJobStore | A configured Redis job store instance. |
| Raises | |
RuntimeError | If the Redis store configuration is not set. |
Get the full scheduler configuration entity.
| Returns | |
orionis.foundation.config.scheduler.Scheduler | The scheduler configuration (store, jitter, max_instances, misfire_grace_time, coalesce, replace_existing, etc.). |