You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

112 lines
3.6 KiB

  1. ============
  2. Oneshot cron
  3. ============
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/11.0/base_cron_oneshot
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-base_cron_oneshot
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module extends the functionality of Odoo crons
  25. to allow you to create single-purpose crons without any further setup or modules
  26. such as `queue_job`.
  27. The typical use case is: you have an expensive task to run on demand and only once.
  28. A main cron called "Oneshot cron cleanup" will delete already executed crons each day.
  29. You might want to tune it according to your needs.
  30. **Table of contents**
  31. .. contents::
  32. :local:
  33. Usage
  34. =====
  35. You can create crons as usual via the admin interface or via code.
  36. The important thing, in both case, is to set `oneshot` flag as true.
  37. **Developer shortcut**
  38. You can easily create a oneshot cron like this:
  39. .. code-block:: python
  40. cron = self.env['ir.cron'].schedule_oneshot(
  41. 'res.partner', method='my_cron_method')
  42. If you need to customize other parameters you can pass them as keyword args:
  43. .. code-block:: python
  44. my_values = {...}
  45. cron = self.env['ir.cron'].schedule_oneshot(
  46. 'res.partner', method='my_cron_method', **my_values)
  47. Changelog
  48. =========
  49. 11.0.1.0.0 (2018-08-30)
  50. ~~~~~~~~~~~~~~~~~~~~~~~
  51. * First release
  52. Bug Tracker
  53. ===========
  54. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  55. In case of trouble, please check there if your issue has already been reported.
  56. If you spotted it first, help us smashing it by providing a detailed and welcomed
  57. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20base_cron_oneshot%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  58. Do not contact contributors directly about support or help with technical issues.
  59. Credits
  60. =======
  61. Authors
  62. ~~~~~~~
  63. * Camptocamp
  64. Contributors
  65. ~~~~~~~~~~~~
  66. * Simone Orsi <simone.orsi@camptocamp.com>
  67. * Artem Kostyuk <a.kostyuk@mobilunity.com>
  68. Maintainers
  69. ~~~~~~~~~~~
  70. This module is maintained by the OCA.
  71. .. image:: https://odoo-community.org/logo.png
  72. :alt: Odoo Community Association
  73. :target: https://odoo-community.org
  74. OCA, or the Odoo Community Association, is a nonprofit organization whose
  75. mission is to support the collaborative development of Odoo features and
  76. promote its widespread use.
  77. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/11.0/base_cron_oneshot>`_ project on GitHub.
  78. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.