Job Queue

No new fields.

• delayable(self, priority=None, eta=None, max_retries=None, description=None, channel=None, identity_key=None)
  Return a ``Delayable`` The returned instance allows to enqueue any method of the recordset's Model. Usage:: delayable = self.env["res.users"].browse(10).delayable(priority=20) delayable.do_work(name="test"}).delay() In this example, the ``do_work`` method will not be executed directly. It will be executed in an asynchronous job. Method calls on a Delayable generally return themselves, so calls can be chained together:: delayable.set(priority=15).do_work(name="test"}).delay() The order of the calls that build the job is not relevant, beside the call to ``delay()`` that must happen at the very end. This is equivalent to the example above:: delayable.do_work(name="test"}).set(priority=15).delay() Very importantly, ``delay()`` must be called on the top-most parent of a chain of jobs, so if you have this:: job1 = record1.delayable().do_work() job2 = record2.delayable().do_work() job1.on_done(job2) The ``delay()`` call must be made on ``job1``, otherwise ``job2`` will be delayed, but ``job1`` will never be. When done on ``job1``, the ``delay()`` call will traverse the graph of jobs and delay all of them:: job1.delay() For more details on the graph dependencies, read the documentation of :module:`~odoo.addons.queue_job.delay`. :param priority: Priority of the job, 0 being the higher priority. Default is 10. :param eta: Estimated Time of Arrival of the job. It will not be executed before this date/time. :param max_retries: maximum number of retries before giving up and set the job state to 'failed'. A value of 0 means infinite retries. Default is 5. :param description: human description of the job. If None, description is computed from the function doc or name :param channel: the complete name of the channel to use to process the function. If specified it overrides the one defined on the function :param identity_key: key uniquely identifying the job, if specified and a job with the same key has not yet been run, the new job will not be added. It is either a string, either a function that takes the job as argument (see :py:func:`..job.identity_exact`). the new job will not be added. :return: instance of a Delayable :rtype: :class:`odoo.addons.queue_job.job.Delayable`
• with_delay(self, priority=None, eta=None, max_retries=None, description=None, channel=None, identity_key=None)
  Return a ``DelayableRecordset`` It is a shortcut for the longer form as shown below:: self.with_delay(priority=20).action_done() # is equivalent to: self.delayable().set(priority=20).action_done().delay() ``with_delay()`` accepts job properties which specify how the job will be executed. Usage with job properties:: env['a.model'].with_delay(priority=30, eta=60*60*5).action_done() delayable.export_one_thing(the_thing_to_export) # => the job will be executed with a low priority and not before a # delay of 5 hours from now When using :meth:``with_delay``, the final ``delay()`` is implicit. See the documentation of :meth:``delayable`` for more details. :return: instance of a DelayableRecordset :rtype: :class:`odoo.addons.queue_job.job.DelayableRecordset`

• ttype Selection
  ondelete={'job_serialized': 'cascade'} selection_add=[('job_serialized', 'Job Serialized')]

No public methods.

• channel Char
  index=True
• channel_method_name Char
  readonly=True string='Complete Method Name'
• company_id Many2one → res.company
  comodel_name='res.company' index=True string='Company'
• date_cancelled Datetime
  readonly=True
• date_created Datetime
  readonly=True string='Created Date'
• date_done Datetime
  readonly=True
• date_enqueued Datetime
  readonly=True string='Enqueue Time'
• date_started Datetime
  readonly=True string='Start Date'
• eta Datetime
  string='Execute only after'
• exc_info Text
  readonly=True string='Exception Info'
• exc_message Char
  readonly=True string='Exception Message' tracking=True
• exc_name Char
  readonly=True string='Exception'
• exec_time Float
  aggregator='avg' help='Time required to execute this job in seconds. Average when grouped.' readonly=True string='Execution Time (avg)'
• func_string Char
  readonly=True string='Task'
• graph_jobs_count Integer
  compute='_compute_graph_jobs_count'
• graph_uuid Char
  help='Single shared identifier of a Graph. Empty for a single job.' index=True readonly=True string='Graph UUID'
• identity_key Char
  readonly=True
• job_function_id Many2one → queue.job.function
  comodel_name='queue.job.function' readonly=True string='Job Function'
• max_retries Integer
  help='The job will fail if the number of tries reach the max. retries.\nRetries are infinite when empty.' string='Max. retries'
• method_name Char
  readonly=True
• model_name Char
  readonly=True string='Model'
• name Char
  readonly=True string='Description'
• priority Integer
  aggregator=False
• result Text
  readonly=True
• retry Integer
  string='Current try'
• state Selection
  index=True readonly=True required=True args: STATES
• user_id Many2one → res.users
  comodel_name='res.users' string='User ID'
• uuid Char
  index=True readonly=True required=True string='UUID'
• worker_pid Integer
  readonly=True

• autovacuum(self)
  Delete all jobs done based on the removal interval defined on the channel Called from a cron.
• button_cancelled(self)
• button_done(self)
• create(self, vals_list)
  @api.model_create_multi@api.private
• init(self)
• open_graph_jobs(self)
  Return action that opens all jobs of the same graph
• open_related_action(self)
  Open the related action associated to the job
• related_action_open_record(self)
  Open a form view with the record(s) of the job. For instance, for a job on a ``product.product``, it will open a ``product.product`` form view with the product record(s) concerned by the job. If the job concerns more than one record, it opens them in a list. This is the default related action.
• requeue(self)
• write(self, vals)

• complete_name Char
  compute='_compute_complete_name' readonly=True recursive=True store=True
• job_function_ids One2many → queue.job.function
  comodel_name='queue.job.function' inverse_name='channel_id' string='Job Functions'
• name Char
• parent_id Many2one → queue.job.channel
  comodel_name='queue.job.channel' ondelete='restrict' string='Parent Channel'
• removal_interval Integer
  default=<expr> required=True

• create(self, vals_list)
  @api.model_create_multi
• parent_required(self)
  @api.constrains('parent_id', 'name')
• write(self, values)

• allow_commit Boolean
  help='Allows the job to commit transactions during execution. Under the hood, this executes the job in a new database cursor, which incurs an overhead as it requires an extra connection to the database. '
• channel Char
  readonly=True related='channel_id.complete_name' store=True
• channel_id Many2one → queue.job.channel
  comodel_name='queue.job.channel' default=<expr> required=True string='Channel'
• edit_related_action Text
  compute='_compute_edit_related_action' help='The action when the button *Related Action* is used on a job. The default action is to open the view of the record related to the job. Configured as a dictionary with optional keys: enable, func_name, kwargs.\nSee the module description for details.' inverse='_inverse_edit_related_action' string='Related Action'
• edit_retry_pattern Text
  compute='_compute_edit_retry_pattern' help='Pattern expressing from the count of retries on retryable errors, the number of of seconds to postpone the next execution. Setting the number of seconds to a 2-element tuple or list will randomize the retry interval between the 2 values.\nExample: {1: 10, 5: 20, 10: 30, 15: 300}.\nExample: {1: (1, 10), 5: (11, 20), 10: (21, 30), 15: (100, 300)}.\nSee the module description for details.' inverse='_inverse_edit_retry_pattern' string='Retry Pattern'
• method Char
• model_id Many2one → ir.model
  comodel_name='ir.model' ondelete='cascade' string='Model'
• name Char
  compute='_compute_name' index=True inverse='_inverse_name' store=True

• create(self, vals_list)
  @api.model_create_multi
• job_config(self, name)
  @tools.ormcache('name')
• job_default_config(self)
• job_function_name(model_name, method_name)
  @staticmethod
• unlink(self)
• write(self, values)

• queue_job_id Many2one → queue.job
  comodel_name='queue.job' index=True ondelete='cascade' required=True

No public methods.

No new fields.

• set_cancelled(self)

No new fields.

• set_done(self)

• job_ids Many2many → queue.job
  comodel_name='queue.job' default=<expr> string='Jobs'

• requeue(self)