Background Tasks allow you to fire off a function to run in the background, leaving your main program to continue executing while the function is running.
In other words, the function is run asynchronously, it does not block the control flow.
Any function decorated as
@anvil.server.background_task can be run in the background.
To run a Background Task, call
See Defining and Running for more information.
When a Background Task is launched,
anvil.server.launch_background_task returns a Task object that can be used
to send data from the Background Task to the main program. You can also get a Background Task’s status and stop it running
using the Task object.
See Communicating Back for more information.
You can view the status of all your Background Tasks by choosing “Background Tasks…” from the Gear Menu in the app builder.
To see all your Background Tasks, call
anvil.server.list_background_tasks(), which will return a list of
Running this function from the published version of your app will return only those Background Tasks that were started from the
published version, and running from the development version (i.e. by clicking “Run” in the designer) will only return tasks started
in that environment. To return all tasks regardless of environment, set the
all_environments keyword argument to
This function can only be run from the server side.
You can trigger Background Tasks automatically according to a schedule. Users familiar with Cron will find this familiar.
Open the Scheduled Tasks dialog in the Gear Menu to set up your Scheduled Tasks.
See Scheduled Tasks for more information.