summaryrefslogtreecommitdiff
path: root/doc/reference
diff options
context:
space:
mode:
authorJulien Castiaux <juc@odoo.com>2020-03-17 11:58:14 +0000
committerRaphael Collet <rco@odoo.com>2020-05-19 13:38:19 +0000
commitc5d3a109f530cd0763a1c3860086b5b7abef1b64 (patch)
tree559f2f3e61c0e54ca40c25a7740e6dff2a768b9f /doc/reference
parent64873d225ede01eb3116773b2ff0aed278ff0e6a (diff)
[REF] ir.autovacuum: declarative garbage collector registration
The ir.autovacuum model purpose is to run several garbage collecting operations like removing files from the filestore when no attachment references them anymore. The precedent strategy to register new garbage collection tasks was to override the `power_on` method and to imperatively execute a vacuum cleaning method on a given model. All calls were executed in a single SQL transaction without any error handling, meaning a single fail during any call resulted in a complete failure of the entire vacuum cleaning chain. We introduce a new `@autovacuum` api decorator, its purpose it to register garbage collecting methods that will be safely executed in their own transaction by the vacuum cleaner. In order to ensure this new strategy is used, we deprecate `power_on` extensions. By the way, garbage-collecting methods can be quite heavy and we don't want users to directly call them. We now ensure they are private. closes odoo/odoo#47842 Task: 2154079 Signed-off-by: Raphael Collet (rco) <rco@openerp.com> Co-authored-by: Raphael Collet <rco@odoo.com> Co-authored-by: Olivier Dony <odo@odoo.com>
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/orm.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/reference/orm.rst b/doc/reference/orm.rst
index ddc5918553b..b6161c7f88b 100644
--- a/doc/reference/orm.rst
+++ b/doc/reference/orm.rst
@@ -531,7 +531,7 @@ Method decorators
=================
.. automodule:: odoo.api
- :members: depends, depends_context, constrains, onchange, returns, model, model_create_multi
+ :members: depends, depends_context, constrains, onchange, returns, autovacuum, model, model_create_multi
.. .. currentmodule:: odoo.api
@@ -540,6 +540,7 @@ Method decorators
.. .. autodata:: constrains
.. .. autodata:: onchange
.. .. autodata:: returns
+.. .. autodata:: autovacuum
.. todo:: With sphinx 2.0 : autodecorator