Skip to content

Reference

Complete API reference for all public classes, functions, and parameters in Aio Fluid. See the home page for installation instructions.

Workers

Workers — base async worker types with start/stop lifecycle (Workers, WorkerFunction, AsyncConsumer).

Task Scheduler

  • Task — the @task decorator, Task, TaskPriority, TaskState, and K8sConfig.
  • Task RunTaskRun, the context object passed to every task executor.
  • Task RetryRetryPolicy for failure retries and rate-limit retries.
  • Task Schedulingevery() and crontab() schedule helpers.
  • Task ManagerTaskManager, the base class for running and queuing tasks.
  • Task ConsumerTaskConsumer, the worker that dequeues and executes tasks.
  • Task SchedulerTaskScheduler, combines consumer and scheduler.
  • Task BrokerTaskBroker interface and the Redis implementation.
  • Task Manager Plugins — extend TaskManager with lifecycle hooks.
  • Task Registry — internal registry that maps task names to Task objects.
  • Task Manager CLI — command-line tools for TaskManager applications.

Database

  • Database — async Postgres connection and query interface.
  • CrudDB — CRUD operations on top of Database.
  • DB Migration — schema migration management.
  • DB Pagination — paginated query results.
  • DB CLI — command-line tools for database management.

Utilities

  • Event DispatchersDispatcher and AsyncDispatcher for decoupled event handling.
  • HTTP Client — unified async HTTP client wrappers for aiohttp and httpx.
  • Errors — error hierarchies for utilities and the task scheduler.
  • Utils — miscellaneous helpers.