diff options
| author | Jacob Walls <jacobtylerwalls@gmail.com> | 2025-12-02 10:25:26 -0500 |
|---|---|---|
| committer | Natalia <124304+nessita@users.noreply.github.com> | 2025-12-03 13:09:57 -0300 |
| commit | a9f5ca5c58df7b662ad23ba9a39619c41a7e39ff (patch) | |
| tree | 6f14313b8272de1862e82b714cfa2fba013886d2 /docs/ref | |
| parent | 45f9e0e969257c0938fec4b51b9b0264aa49bd25 (diff) | |
[6.0.x] Refs #35859 -- Clarified Tasks ref and topics docs regarding available backends.
Backport of d3f142f2cd36ba0458cc679397555bd5ee7db744 from main.
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/tasks.txt | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/ref/tasks.txt b/docs/ref/tasks.txt index c427c4c4d3..99d8eb6a0a 100644 --- a/docs/ref/tasks.txt +++ b/docs/ref/tasks.txt @@ -7,6 +7,10 @@ Tasks .. module:: django.tasks :synopsis: Django's built-in background Task system. +The Task framework provides the contract and plumbing for background work, not +the engine that runs it. The Tasks API defines how work is described, queued, +and tracked, but leaves actual execution to external infrastructure. + Task definition =============== @@ -274,6 +278,10 @@ Task errors Backends ======== +Backends handle how Tasks are stored and executed. All backends share a common +interface defined by ``BaseTaskBackend``, which specifies the core methods for +enqueueing Tasks and retrieving results. + Base backend ------------ @@ -365,6 +373,10 @@ Feature :class:`.DummyBackend` :class:`.ImmediateBackend` Available backends ------------------ +Django includes only development and testing backends. These support local +execution and inspection, for production ready backends refer to +:ref:`configuring-a-task-backend`. + Immediate backend ~~~~~~~~~~~~~~~~~ |
