<!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>Module: parallel.controller.sqlitedb — IPython 2.3.0 documentation</title> <link rel="stylesheet" href="../../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '2.3.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../../_static/jquery.js"></script> <script type="text/javascript" src="../../_static/underscore.js"></script> <script type="text/javascript" src="../../_static/doctools.js"></script> <link rel="top" title="IPython 2.3.0 documentation" href="../../index.html" /> <link rel="up" title="The IPython API" href="../index.html" /> <link rel="next" title="Module: parallel.engine.engine" href="IPython.parallel.engine.engine.html" /> <link rel="prev" title="Module: parallel.controller.scheduler" href="IPython.parallel.controller.scheduler.html" /> </head> <body> <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px"> <a href="http://ipython.org/"><img src="../../_static/logo.png" border="0" alt="IPython Documentation"/></a> </div> <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="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="IPython.parallel.engine.engine.html" title="Module: parallel.engine.engine" accesskey="N">next</a> |</li> <li class="right" > <a href="IPython.parallel.controller.scheduler.html" title="Module: parallel.controller.scheduler" accesskey="P">previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" accesskey="U">The IPython API</a> »</li> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../../index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Module: <tt class="docutils literal"><span class="pre">parallel.controller.sqlitedb</span></tt></a><ul> <li><a class="reference internal" href="#class">1 Class</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="IPython.parallel.controller.scheduler.html" title="previous chapter">Module: <tt class="docutils literal"><span class="pre">parallel.controller.scheduler</span></tt></a></p> <h4>Next topic</h4> <p class="topless"><a href="IPython.parallel.engine.engine.html" title="next chapter">Module: <tt class="docutils literal"><span class="pre">parallel.engine.engine</span></tt></a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/generated/IPython.parallel.controller.sqlitedb.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" /> <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="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-IPython.parallel.controller.sqlitedb"> <span id="module-parallel-controller-sqlitedb"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">parallel.controller.sqlitedb</span></tt><a class="headerlink" href="#module-IPython.parallel.controller.sqlitedb" title="Permalink to this headline">¶</a></h1> <p>A TaskRecord backend using sqlite3</p> <p>Authors:</p> <ul class="simple"> <li>Min RK</li> </ul> <div class="section" id="class"> <h2>1 Class<a class="headerlink" href="#class" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="IPython.parallel.controller.sqlitedb.SQLiteDB"> <em class="property">class </em><tt class="descclassname">IPython.parallel.controller.sqlitedb.</tt><tt class="descname">SQLiteDB</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.sqlitedb.SQLiteDB" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="IPython.parallel.controller.dictdb.html#IPython.parallel.controller.dictdb.BaseDB" title="IPython.parallel.controller.dictdb.BaseDB"><tt class="xref py py-class docutils literal"><span class="pre">IPython.parallel.controller.dictdb.BaseDB</span></tt></a></p> <p>SQLite3 TaskRecord backend.</p> <dl class="method"> <dt id="IPython.parallel.controller.sqlitedb.SQLiteDB.__init__"> <tt class="descname">__init__</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.sqlitedb.SQLiteDB.__init__" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.sqlitedb.SQLiteDB.add_record"> <tt class="descname">add_record</tt><big>(</big><em>msg_id</em>, <em>rec</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.sqlitedb.SQLiteDB.add_record" title="Permalink to this definition">¶</a></dt> <dd><p>Add a new Task Record, by msg_id.</p> </dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.sqlitedb.SQLiteDB.drop_matching_records"> <tt class="descname">drop_matching_records</tt><big>(</big><em>check</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.sqlitedb.SQLiteDB.drop_matching_records" title="Permalink to this definition">¶</a></dt> <dd><p>Remove a record from the DB.</p> </dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.sqlitedb.SQLiteDB.drop_record"> <tt class="descname">drop_record</tt><big>(</big><em>msg_id</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.sqlitedb.SQLiteDB.drop_record" title="Permalink to this definition">¶</a></dt> <dd><p>Remove a record from the DB.</p> </dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.sqlitedb.SQLiteDB.find_records"> <tt class="descname">find_records</tt><big>(</big><em>check</em>, <em>keys=None</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.sqlitedb.SQLiteDB.find_records" title="Permalink to this definition">¶</a></dt> <dd><p>Find records matching a query dict, optionally extracting subset of keys.</p> <p>Returns list of matching records.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>check: dict</strong></p> <blockquote> <div><p>mongodb-style query argument</p> </div></blockquote> <p><strong>keys: list of strs [optional]</strong></p> <blockquote class="last"> <div><p>if specified, the subset of keys to extract. msg_id will <em>always</em> be included.</p> </div></blockquote> </td> </tr> </tbody> </table> </dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.sqlitedb.SQLiteDB.get_history"> <tt class="descname">get_history</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.parallel.controller.sqlitedb.SQLiteDB.get_history" title="Permalink to this definition">¶</a></dt> <dd><p>get all msg_ids, ordered by time submitted.</p> </dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.sqlitedb.SQLiteDB.get_record"> <tt class="descname">get_record</tt><big>(</big><em>msg_id</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.sqlitedb.SQLiteDB.get_record" title="Permalink to this definition">¶</a></dt> <dd><p>Get a specific Task Record, by msg_id.</p> </dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.sqlitedb.SQLiteDB.update_record"> <tt class="descname">update_record</tt><big>(</big><em>msg_id</em>, <em>rec</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.sqlitedb.SQLiteDB.update_record" title="Permalink to this definition">¶</a></dt> <dd><p>Update the data in an existing record.</p> </dd></dl> </dd></dl> </div> </div> </div> </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="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="IPython.parallel.engine.engine.html" title="Module: parallel.engine.engine" >next</a> |</li> <li class="right" > <a href="IPython.parallel.controller.scheduler.html" title="Module: parallel.controller.scheduler" >previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" >The IPython API</a> »</li> </ul> </div> <div class="footer"> © Copyright The IPython Development Team. Last updated on Sep 02, 2015. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. </div> </body> </html>