yangck
/
celery


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Backend: Database - celery.backends.database &mdash; Celery v0.6.0 (stable) documentation</title>
    <link rel="stylesheet" href="../static/nature.css" type="text/css" />
    <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '0.6.0 (stable)',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../static/jquery.js"></script>
    <script type="text/javascript" src="../static/doctools.js"></script>
    <link rel="top" title="Celery v0.6.0 (stable) documentation" href="../index.html" />
    <link rel="up" title="Module API Reference" href="index.html" />
    <link rel="next" title="Backend: Cache - celery.backends.cache" href="celery.backends.cache.html" />
    <link rel="prev" title="Backend: Base - celery.backends.base" href="celery.backends.base.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="celery.backends.cache.html" title="Backend: Cache - celery.backends.cache"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="celery.backends.base.html" title="Backend: Base - celery.backends.base"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">Celery v0.6.0 (stable) documentation</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">Module API Reference</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-celery.backends.database">
<h1>Backend: Database - celery.backends.database<a class="headerlink" href="#module-celery.backends.database" title="Permalink to this headline">¶</a></h1>
<p>celery.backends.database</p>
<dl class="class">
<dt id="celery.backends.database.Backend">
<em class="property">
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>
<dd><p>The database backends. Using Django models to store task metadata.</p>
<dl class="method">
<dt id="celery.backends.database.Backend.cleanup">
<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>
<dd>Delete expired metadata.</dd></dl>

<dl class="method">
<dt id="celery.backends.database.Backend.get_result">
<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>
<dd>Get the result for a task.</dd></dl>

<dl class="method">
<dt id="celery.backends.database.Backend.get_status">
<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>
<dd>Get the status of a task.</dd></dl>

<dl class="method">
<dt id="celery.backends.database.Backend.init_periodic_tasks">
<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>
<dd>Create entries for all periodic tasks in the database.</dd></dl>

<dl class="method">
<dt id="celery.backends.database.Backend.is_done">
<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>
<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>

<dl class="method">
<dt id="celery.backends.database.Backend.run_periodic_tasks">
<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>
<dd><p>Run all waiting periodic tasks.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<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
the task class and id for the resulting tasks applied.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="celery.backends.database.Backend.store_result">
<tt class="descname">store_result</tt><big>(</big><em>task_id</em>, <em>result</em>, <em>status</em><big>)</big><a class="headerlink" href="#celery.backends.database.Backend.store_result" title="Permalink to this definition">¶</a></dt>
<dd>Mark task as done (executed).</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h4>Previous topic</h4>
            <p class="topless"><a href="celery.backends.base.html"
                                  title="previous chapter">Backend: Base - celery.backends.base</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="celery.backends.cache.html"
                                  title="next chapter">Backend: Cache - celery.backends.cache</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="../sources/reference/celery.backends.database.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="../search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="celery.backends.cache.html" title="Backend: Cache - celery.backends.cache"
             >next</a> |</li>
        <li class="right" >
          <a href="celery.backends.base.html" title="Backend: Base - celery.backends.base"
             >previous</a> |</li>
        <li><a href="../index.html">Celery v0.6.0 (stable) documentation</a> &raquo;</li>
          <li><a href="index.html" >Module API Reference</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2009, Ask Solem.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
    </div>
  </body>
</html>