mirror of
https://github.com/bringout/oca-technical.git
synced 2026-04-18 07:32:04 +02:00
131 lines
4.2 KiB
ReStructuredText
131 lines
4.2 KiB
ReStructuredText
===============
|
|
Job Queue Batch
|
|
===============
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:7eceb569ec18547f2b64717734aecc66c0db338d51e13d6f1324785c6c2f8407
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
|
:target: https://odoo-community.org/page/development-status
|
|
:alt: Beta
|
|
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
|
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
|
:alt: License: AGPL-3
|
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/queue/tree/16.0/queue_job_batch
|
|
:alt: OCA/queue
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/queue-16-0/queue-16-0-queue_job_batch
|
|
:alt: Translate me on Weblate
|
|
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
|
:target: https://runboat.odoo-community.org/builds?repo=OCA/queue&target_branch=16.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
This addon adds an a grouper for queue jobs.
|
|
|
|
It allows to show your jobs in a batched form in order to know better the
|
|
results.
|
|
|
|
Example:
|
|
|
|
.. code-block:: python
|
|
|
|
from odoo import models, fields, api
|
|
from odoo.addons.queue_job.job import job
|
|
|
|
class MyModel(models.Model):
|
|
_name = 'my.model'
|
|
|
|
@api.multi
|
|
@job
|
|
def my_method(self, a, k=None):
|
|
_logger.info('executed with a: %s and k: %s', a, k)
|
|
|
|
|
|
class MyOtherModel(models.Model):
|
|
_name = 'my.other.model'
|
|
|
|
@api.multi
|
|
def button_do_stuff(self):
|
|
batch = self.env['queue.job.batch'].get_new_batch('Group')
|
|
for i in range(1, 100):
|
|
self.env['my.model'].with_context(
|
|
job_batch=batch
|
|
).with_delay().my_method('a', k=i)
|
|
batch.enqueue()
|
|
|
|
|
|
In the snippet of code above, when we call ``button_do_stuff``, 100 jobs
|
|
capturing the method and arguments will be postponed. It will be executed as
|
|
soon as the Jobrunner has a free bucket, which can be instantaneous if no other
|
|
job is running.
|
|
|
|
Once all the jobs have finished, the grouper will be marked as finished.
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Usage
|
|
=====
|
|
|
|
You can manage your batch jobs from the Systray. A new button will be shown
|
|
with your currently executing job batches and the recently finished job groups.
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/queue/issues>`_.
|
|
In case of trouble, please check there if your issue has already been reported.
|
|
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
|
`feedback <https://github.com/OCA/queue/issues/new?body=module:%20queue_job_batch%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
|
|
|
Do not contact contributors directly about support or help with technical issues.
|
|
|
|
Credits
|
|
=======
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
* Creu Blanca
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Enric Tobella <etobella@creublanca.es>
|
|
* `Trobz <https://trobz.com>`_:
|
|
* Hoang Diep <hoang@trobz.com>
|
|
* `ForgeFlow <https://forgeflow.com>`_:
|
|
* Lois Rilo <lois.rilo@forgeflow.com>
|
|
* Jasmin Solanki <jasmin.solanki@forgeflow.com>
|
|
|
|
Other credits
|
|
~~~~~~~~~~~~~
|
|
|
|
The migration of this module from 12.0 to 14.0 was financially supported by Camptocamp
|
|
|
|
Maintainers
|
|
~~~~~~~~~~~
|
|
|
|
This module is maintained by the OCA.
|
|
|
|
.. image:: https://odoo-community.org/logo.png
|
|
:alt: Odoo Community Association
|
|
:target: https://odoo-community.org
|
|
|
|
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
|
mission is to support the collaborative development of Odoo features and
|
|
promote its widespread use.
|
|
|
|
This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/16.0/queue_job_batch>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|