mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Move default caching_config to PluginConfig class

Browse Source
This commit is contained in:
Jeremy Stretch
2020-04-01 12:10:19 -04:00
parent b2f4ef06c7
commit 0432b1a6f9
3 changed files with 22 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/plugins/development.md
View File

@ -360,17 +360,28 @@ template_extensions = [AddSiteAnimal, AddRackAnimal]
## Caching Configuration
By default, all query operations within a plugin are cached. To change this, define a caching configuration under the PluginConfig class' `caching_config` attribute. An example configuration is below:
By default, all query operations within a plugin are cached. To change this, define a caching configuration under the PluginConfig class' `caching_config` attribute. All configuration keys will be applied within the context of the plugin; there is no need to include the plugin name. An example configuration is below:
```python
class MyPluginConfig(PluginConfig):
...
caching_config = {
'my_plugin.foo': {
'foo': {
'ops': 'get',
'timeout': 60 * 15,
},
'*': {
'ops': 'all',
}
}
```
To disable caching for your plugin entirely, set:
```python
caching_config = {
'*': None
}
```
See the [django-cacheops](https://github.com/Suor/django-cacheops) documentation for more detail on configuring caching.