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

Define the contract for schedule store implementations.

Method database Create a database job store for the scheduler.
Async Method migrate Create the configured database job table without starting the scheduler.
Method redis Create a Redis job store for the scheduler.
Property config Get the full scheduler configuration entity.
Property store Get the configured job store type.
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 configuration is not set.
orionis.database.MissingDatabaseDependencyExceptionIf the resolved driver package is not installed.
async def migrate(self): (source)

Create the configured database job table without starting the scheduler.

Returns
NoneCreate missing native storage and preserve existing job data.
Raises
RuntimeErrorIf database storage is absent or the backend is unsupported.
orionis.database.DatabaseExceptionIf the 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.
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').