:tocdepth: 3

:py:mod:`gws.base.job.manager`
==============================

.. py:module:: gws.base.job.manager

.. autoapi-nested-parse::

   Job manager.



**Source code:** :source:`gws.base.job.manager<gws/base/job/manager.py>`



Module Contents
---------------



.. py:class:: Object


   Bases: :py:obj:`gws.JobManager`

   Job Manager.

   .. py:attribute:: dbPath
      :type:  str

   .. py:attribute:: DDL
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 CREATE TABLE IF NOT EXISTS jobs (
                     uid           TEXT NOT NULL PRIMARY KEY,
                     userUid       TEXT DEFAULT '',
                     userStr       TEXT DEFAULT '',
                     worker        TEXT DEFAULT '',
                     state         TEXT DEFAULT '',
                     error         TEXT DEFAULT '',
                     numSteps      INTEGER DEFAULT 0,
                     step          INTEGER DEFAULT 0,
                     stepName      TEXT DEFAULT '',
                     payload       TEXT DEFAULT '',
                     created       INTEGER DEFAULT 0,
                     updated       INTEGER DEFAULT 0
                 )
             """

      .. raw:: html

         </details>



   .. py:attribute:: TABLE
      :value: 'jobs'


   .. py:method:: cancel_job(job: gws.Job) -> Optional[gws.Job]

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: create_job(user, worker, payload=None)

   .. py:method:: get_job(job_uid: str, user=None, state=None)

   .. py:method:: get_job_or_fail(job_uid: str, user=None, state=None)

   .. py:method:: handle_cancel_request(req, p)

   .. py:method:: handle_status_request(req, p)

   .. py:method:: job_status_response(job, **kwargs)

   .. py:method:: periodic_task()

      Periodic task hook.


   .. py:method:: remove_job(job: gws.Job)

   .. py:method:: require_job(req, p)

   .. py:method:: run_job(job: gws.Job)

   .. py:method:: schedule_job(job: gws.Job)

   .. py:method:: update_job(job, **kwargs)