celery.models.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
  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>Django Models - celery.models &mdash; Celery v0.1.14 documentation</title>
  7. <link rel="stylesheet" href="../static/default.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.1.14',
  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.1.14 documentation" href="../index.html" />
  21. <link rel="next" title="Messaging - celery.messaging" href="celery.messaging.html" />
  22. <link rel="prev" title="Django Model Managers - celery.managers" href="celery.managers.html" />
  23. </head>
  24. <body>
  25. <div class="related">
  26. <h3>Navigation</h3>
  27. <ul>
  28. <li class="right" style="margin-right: 10px">
  29. <a href="../genindex.html" title="General Index"
  30. accesskey="I">index</a></li>
  31. <li class="right" >
  32. <a href="../modindex.html" title="Global Module Index"
  33. accesskey="M">modules</a> |</li>
  34. <li class="right" >
  35. <a href="celery.messaging.html" title="Messaging - celery.messaging"
  36. accesskey="N">next</a> |</li>
  37. <li class="right" >
  38. <a href="celery.managers.html" title="Django Model Managers - celery.managers"
  39. accesskey="P">previous</a> |</li>
  40. <li><a href="../index.html">Celery v0.1.14 documentation</a> &raquo;</li>
  41. </ul>
  42. </div>
  43. <div class="document">
  44. <div class="documentwrapper">
  45. <div class="bodywrapper">
  46. <div class="body">
  47. <div class="section" id="django-models-celery-models">
  48. <h1>Django Models - celery.models<a class="headerlink" href="#django-models-celery-models" title="Permalink to this headline">¶</a></h1>
  49. <dl class="data">
  50. <dt id="TASK_STATUS_PENDING">
  51. <tt class="descname">TASK_STATUS_PENDING</tt><a class="headerlink" href="#TASK_STATUS_PENDING" title="Permalink to this definition">¶</a></dt>
  52. <dt>
  53. <tt class="descname">The string status of a pending task.</tt></dt>
  54. <dd></dd></dl>
  55. <dl class="data">
  56. <dt id="TASK_STATUS_RETRY">
  57. <tt class="descname">TASK_STATUS_RETRY</tt><a class="headerlink" href="#TASK_STATUS_RETRY" title="Permalink to this definition">¶</a></dt>
  58. <dt>
  59. <tt class="descname">The string status of a task which is to be retried.</tt></dt>
  60. <dd></dd></dl>
  61. <dl class="data">
  62. <dt id="TASK_STATUS_FAILURE">
  63. <tt class="descname">TASK_STATUS_FAILURE</tt><a class="headerlink" href="#TASK_STATUS_FAILURE" title="Permalink to this definition">¶</a></dt>
  64. <dt>
  65. <tt class="descname">The string status of a failed task.</tt></dt>
  66. <dd></dd></dl>
  67. <dl class="data">
  68. <dt id="TASK_STATUS_DONE">
  69. <tt class="descname">TASK_STATUS_DONE</tt><a class="headerlink" href="#TASK_STATUS_DONE" title="Permalink to this definition">¶</a></dt>
  70. <dt>
  71. <tt class="descname">The string status of a task that was successfully executed.</tt></dt>
  72. <dd></dd></dl>
  73. <dl class="data">
  74. <dt id="TASK_STATUSES">
  75. <tt class="descname">TASK_STATUSES</tt><a class="headerlink" href="#TASK_STATUSES" title="Permalink to this definition">¶</a></dt>
  76. <dt>
  77. <tt class="descname">List of possible task statuses.</tt></dt>
  78. <dd></dd></dl>
  79. <dl class="data">
  80. <dt id="TASK_STATUSES_CHOICES">
  81. <tt class="descname">TASK_STATUSES_CHOICES</tt><a class="headerlink" href="#TASK_STATUSES_CHOICES" title="Permalink to this definition">¶</a></dt>
  82. <dt>
  83. <tt class="descname">Django choice tuple of possible task statuses, for usage in model/form</tt></dt>
  84. <dt>
  85. <tt class="descname">fields ``choices`` argument.</tt></dt>
  86. <dd></dd></dl>
  87. <dl class="class">
  88. <dt id="TaskMeta">
  89. <em class="property">
  90. class </em><tt class="descname">TaskMeta</tt><a class="headerlink" href="#TaskMeta" title="Permalink to this definition">¶</a></dt>
  91. <dt>
  92. <tt class="descname">Model for storing the result and status of a task.</tt></dt>
  93. <dd><p><em>Note</em> Only used if you&#8217;re running the <tt class="docutils literal"><span class="pre">database</span></tt> backend.</p>
  94. <dl class="attribute">
  95. <dt id="TaskMeta.task_id">
  96. <tt class="descname">task_id</tt><a class="headerlink" href="#TaskMeta.task_id" title="Permalink to this definition">¶</a></dt>
  97. <dt>
  98. <tt class="descname">The unique task id.</tt></dt>
  99. <dd></dd></dl>
  100. <dl class="attribute">
  101. <dt id="TaskMeta.status">
  102. <tt class="descname">status</tt><a class="headerlink" href="#TaskMeta.status" title="Permalink to this definition">¶</a></dt>
  103. <dt>
  104. <tt class="descname">The current status for this task.</tt></dt>
  105. <dd></dd></dl>
  106. <dl class="attribute">
  107. <dt id="TaskMeta.result">
  108. <tt class="descname">result</tt><a class="headerlink" href="#TaskMeta.result" title="Permalink to this definition">¶</a></dt>
  109. <dt>
  110. <tt class="descname">The result after successful/failed execution. If the task failed,</tt></dt>
  111. <dt>
  112. <tt class="descname">this contains the execption it raised.</tt></dt>
  113. <dd></dd></dl>
  114. <dl class="attribute">
  115. <dt id="TaskMeta.date_done">
  116. <tt class="descname">date_done</tt><a class="headerlink" href="#TaskMeta.date_done" title="Permalink to this definition">¶</a></dt>
  117. <dt>
  118. <tt class="descname">The date this task changed status.</tt></dt>
  119. <dd></dd></dl>
  120. </dd></dl>
  121. <dl class="class">
  122. <dt id="PeriodicTaskMeta">
  123. <em class="property">
  124. class </em><tt class="descname">PeriodicTaskMeta</tt><a class="headerlink" href="#PeriodicTaskMeta" title="Permalink to this definition">¶</a></dt>
  125. <dt>
  126. <tt class="descname">Metadata model for periodic tasks.</tt></dt>
  127. <dd><dl class="attribute">
  128. <dt id="PeriodicTaskMeta.name">
  129. <tt class="descname">name</tt><a class="headerlink" href="#PeriodicTaskMeta.name" title="Permalink to this definition">¶</a></dt>
  130. <dt>
  131. <tt class="descname">The name of this task, as registered in the task registry.</tt></dt>
  132. <dd></dd></dl>
  133. <dl class="attribute">
  134. <dt id="PeriodicTaskMeta.last_run_at">
  135. <tt class="descname">last_run_at</tt><a class="headerlink" href="#PeriodicTaskMeta.last_run_at" title="Permalink to this definition">¶</a></dt>
  136. <dt>
  137. <tt class="descname">The date this periodic task was last run. Used to find out</tt></dt>
  138. <dt>
  139. <tt class="descname">when it should be run next.</tt></dt>
  140. <dd></dd></dl>
  141. <dl class="attribute">
  142. <dt id="PeriodicTaskMeta.total_run_count">
  143. <tt class="descname">total_run_count</tt><a class="headerlink" href="#PeriodicTaskMeta.total_run_count" title="Permalink to this definition">¶</a></dt>
  144. <dt>
  145. <tt class="descname">The number of times this periodic task has been run.</tt></dt>
  146. <dd></dd></dl>
  147. <dl class="attribute">
  148. <dt id="PeriodicTaskMeta.task">
  149. <tt class="descname">task</tt><a class="headerlink" href="#PeriodicTaskMeta.task" title="Permalink to this definition">¶</a></dt>
  150. <dt>
  151. <tt class="descname">The class/function for this task.</tt></dt>
  152. <dd></dd></dl>
  153. <dl class="method">
  154. <dt id="PeriodicTaskMeta.delay">
  155. <tt class="descname">delay</tt><big>(</big><big>)</big><a class="headerlink" href="#PeriodicTaskMeta.delay" title="Permalink to this definition">¶</a></dt>
  156. <dt>
  157. <tt class="descname">Delay the execution of a periodic task, and increment its total</tt></dt>
  158. <dt>
  159. <tt class="descname">run count.</tt></dt>
  160. <dd></dd></dl>
  161. </dd></dl>
  162. </div>
  163. </div>
  164. </div>
  165. </div>
  166. <div class="sphinxsidebar">
  167. <div class="sphinxsidebarwrapper">
  168. <h4>Previous topic</h4>
  169. <p class="topless"><a href="celery.managers.html"
  170. title="previous chapter">Django Model Managers - celery.managers</a></p>
  171. <h4>Next topic</h4>
  172. <p class="topless"><a href="celery.messaging.html"
  173. title="next chapter">Messaging - celery.messaging</a></p>
  174. <h3>This Page</h3>
  175. <ul class="this-page-menu">
  176. <li><a href="../sources/reference/celery.models.txt"
  177. rel="nofollow">Show Source</a></li>
  178. </ul>
  179. <div id="searchbox" style="display: none">
  180. <h3>Quick search</h3>
  181. <form class="search" action="../search.html" method="get">
  182. <input type="text" name="q" size="18" />
  183. <input type="submit" value="Go" />
  184. <input type="hidden" name="check_keywords" value="yes" />
  185. <input type="hidden" name="area" value="default" />
  186. </form>
  187. <p class="searchtip" style="font-size: 90%">
  188. Enter search terms or a module, class or function name.
  189. </p>
  190. </div>
  191. <script type="text/javascript">$('#searchbox').show(0);</script>
  192. </div>
  193. </div>
  194. <div class="clearer"></div>
  195. </div>
  196. <div class="related">
  197. <h3>Navigation</h3>
  198. <ul>
  199. <li class="right" style="margin-right: 10px">
  200. <a href="../genindex.html" title="General Index"
  201. >index</a></li>
  202. <li class="right" >
  203. <a href="../modindex.html" title="Global Module Index"
  204. >modules</a> |</li>
  205. <li class="right" >
  206. <a href="celery.messaging.html" title="Messaging - celery.messaging"
  207. >next</a> |</li>
  208. <li class="right" >
  209. <a href="celery.managers.html" title="Django Model Managers - celery.managers"
  210. >previous</a> |</li>
  211. <li><a href="../index.html">Celery v0.1.14 documentation</a> &raquo;</li>
  212. </ul>
  213. </div>
  214. <div class="footer">
  215. &copy; Copyright 2009, Ask Solem.
  216. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  217. </div>
  218. </body>
  219. </html>