NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-14 01:41:22 -06:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

#16971: Improve example in documentation

Browse Source
This commit is contained in:
Jeremy Stretch 2024-11-26 10:35:30 -05:00
parent a24576f126
commit 64e56cd7c8
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/plugins/development/background-jobs.md
View File

@ -87,14 +87,17 @@ class MyHousekeepingJob(JobRunner):
def run(self, *args, **kwargs): def run(self, *args, **kwargs):
MyModel.objects.filter(foo='bar').delete() MyModel.objects.filter(foo='bar').delete()
system_jobs = (
MyHousekeepingJob,
)
``` ```
!!! note !!! note
Ensure that any system jobs are imported on initialization. Otherwise, they won't be registered. This can be achieved by extending the PluginConfig's `ready()` method. Ensure that any system jobs are imported on initialization. Otherwise, they won't be registered. This can be achieved by extending the PluginConfig's `ready()` method. For example:
```python
def ready(self):
super().ready()
from .jobs import MyHousekeepingJob
```
## Task queues ## Task queues