celery.backends.database.html 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Backend: Database - celery.backends.database &mdash; Celery v0.7.0 (unstable) documentation</title>
  7. <link rel="stylesheet" href="../static/nature.css" type="text/css" />
  8. <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../',
  12. VERSION: '0.7.0 (unstable)',
  13. COLLAPSE_MODINDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../static/jquery.js"></script>
  19. <script type="text/javascript" src="../static/doctools.js"></script>
  20. <link rel="top" title="Celery v0.7.0 (unstable) documentation" href="../index.html" />
  21. <link rel="up" title="Module API Reference" href="index.html" />
  22. <link rel="next" title="Backend: Cache - celery.backends.cache" href="celery.backends.cache.html" />
  23. <link rel="prev" title="Backend: Base - celery.backends.base" href="celery.backends.base.html" />
  24. </head>
  25. <body>
  26. <div class="related">
  27. <h3>Navigation</h3>
  28. <ul>
  29. <li class="right" style="margin-right: 10px">
  30. <a href="../genindex.html" title="General Index"
  31. accesskey="I">index</a></li>
  32. <li class="right" >
  33. <a href="../modindex.html" title="Global Module Index"
  34. accesskey="M">modules</a> |</li>
  35. <li class="right" >
  36. <a href="celery.backends.cache.html" title="Backend: Cache - celery.backends.cache"
  37. accesskey="N">next</a> |</li>
  38. <li class="right" >
  39. <a href="celery.backends.base.html" title="Backend: Base - celery.backends.base"
  40. accesskey="P">previous</a> |</li>
  41. <li><a href="../index.html">Celery v0.7.0 (unstable) documentation</a> &raquo;</li>
  42. <li><a href="index.html" accesskey="U">Module API Reference</a> &raquo;</li>
  43. </ul>
  44. </div>
  45. <div class="document">
  46. <div class="documentwrapper">
  47. <div class="bodywrapper">
  48. <div class="body">
  49. <div class="section" id="module-celery.backends.database">
  50. <h1>Backend: Database - celery.backends.database<a class="headerlink" href="#module-celery.backends.database" title="Permalink to this headline">¶</a></h1>
  51. <p>celery.backends.database</p>
  52. <dl class="class">
  53. <dt id="celery.backends.database.Backend">
  54. <em class="property">
  55. class </em><tt class="descclassname">celery.backends.database.</tt><tt class="descname">Backend</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.backends.database.Backend" title="Permalink to this definition">¶</a></dt>
  56. <dd><p>The database backends. Using Django models to store task metadata.</p>
  57. <dl class="method">
  58. <dt id="celery.backends.database.Backend.cleanup">
  59. <tt class="descname">cleanup</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.backends.database.Backend.cleanup" title="Permalink to this definition">¶</a></dt>
  60. <dd>Delete expired metadata.</dd></dl>
  61. <dl class="method">
  62. <dt id="celery.backends.database.Backend.get_result">
  63. <tt class="descname">get_result</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.database.Backend.get_result" title="Permalink to this definition">¶</a></dt>
  64. <dd>Get the result for a task.</dd></dl>
  65. <dl class="method">
  66. <dt id="celery.backends.database.Backend.get_status">
  67. <tt class="descname">get_status</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.database.Backend.get_status" title="Permalink to this definition">¶</a></dt>
  68. <dd>Get the status of a task.</dd></dl>
  69. <dl class="method">
  70. <dt id="celery.backends.database.Backend.get_traceback">
  71. <tt class="descname">get_traceback</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.database.Backend.get_traceback" title="Permalink to this definition">¶</a></dt>
  72. <dd>Get the traceback of a failed task.</dd></dl>
  73. <dl class="method">
  74. <dt id="celery.backends.database.Backend.init_periodic_tasks">
  75. <tt class="descname">init_periodic_tasks</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.backends.database.Backend.init_periodic_tasks" title="Permalink to this definition">¶</a></dt>
  76. <dd>Create entries for all periodic tasks in the database.</dd></dl>
  77. <dl class="method">
  78. <dt id="celery.backends.database.Backend.is_done">
  79. <tt class="descname">is_done</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.database.Backend.is_done" title="Permalink to this definition">¶</a></dt>
  80. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if task with <tt class="docutils literal"><span class="pre">task_id</span></tt> has been executed.</dd></dl>
  81. <dl class="method">
  82. <dt id="celery.backends.database.Backend.run_periodic_tasks">
  83. <tt class="descname">run_periodic_tasks</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.backends.database.Backend.run_periodic_tasks" title="Permalink to this definition">¶</a></dt>
  84. <dd><p>Run all waiting periodic tasks.</p>
  85. <table class="docutils field-list" frame="void" rules="none">
  86. <col class="field-name" />
  87. <col class="field-body" />
  88. <tbody valign="top">
  89. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">a list of <tt class="docutils literal"><span class="pre">(task,</span> <span class="pre">task_id)</span></tt> tuples containing
  90. the task class and id for the resulting tasks applied.</td>
  91. </tr>
  92. </tbody>
  93. </table>
  94. </dd></dl>
  95. <dl class="method">
  96. <dt id="celery.backends.database.Backend.store_result">
  97. <tt class="descname">store_result</tt><big>(</big><em>task_id</em>, <em>result</em>, <em>status</em>, <em>traceback=None</em><big>)</big><a class="headerlink" href="#celery.backends.database.Backend.store_result" title="Permalink to this definition">¶</a></dt>
  98. <dd>Store return value and status of an executed task.</dd></dl>
  99. </dd></dl>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. <div class="sphinxsidebar">
  105. <div class="sphinxsidebarwrapper">
  106. <h4>Previous topic</h4>
  107. <p class="topless"><a href="celery.backends.base.html"
  108. title="previous chapter">Backend: Base - celery.backends.base</a></p>
  109. <h4>Next topic</h4>
  110. <p class="topless"><a href="celery.backends.cache.html"
  111. title="next chapter">Backend: Cache - celery.backends.cache</a></p>
  112. <h3>This Page</h3>
  113. <ul class="this-page-menu">
  114. <li><a href="../sources/reference/celery.backends.database.txt"
  115. rel="nofollow">Show Source</a></li>
  116. </ul>
  117. <div id="searchbox" style="display: none">
  118. <h3>Quick search</h3>
  119. <form class="search" action="../search.html" method="get">
  120. <input type="text" name="q" size="18" />
  121. <input type="submit" value="Go" />
  122. <input type="hidden" name="check_keywords" value="yes" />
  123. <input type="hidden" name="area" value="default" />
  124. </form>
  125. <p class="searchtip" style="font-size: 90%">
  126. Enter search terms or a module, class or function name.
  127. </p>
  128. </div>
  129. <script type="text/javascript">$('#searchbox').show(0);</script>
  130. </div>
  131. </div>
  132. <div class="clearer"></div>
  133. </div>
  134. <div class="related">
  135. <h3>Navigation</h3>
  136. <ul>
  137. <li class="right" style="margin-right: 10px">
  138. <a href="../genindex.html" title="General Index"
  139. >index</a></li>
  140. <li class="right" >
  141. <a href="../modindex.html" title="Global Module Index"
  142. >modules</a> |</li>
  143. <li class="right" >
  144. <a href="celery.backends.cache.html" title="Backend: Cache - celery.backends.cache"
  145. >next</a> |</li>
  146. <li class="right" >
  147. <a href="celery.backends.base.html" title="Backend: Base - celery.backends.base"
  148. >previous</a> |</li>
  149. <li><a href="../index.html">Celery v0.7.0 (unstable) documentation</a> &raquo;</li>
  150. <li><a href="index.html" >Module API Reference</a> &raquo;</li>
  151. </ul>
  152. </div>
  153. <div class="footer">
  154. &copy; Copyright 2009, Ask Solem.
  155. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
  156. </div>
  157. </body>
  158. </html>