Files @ 3378805b80ee
Branch filter:

Location: NPO-Accounting/experimental-accounting-api/doc/build/html/api/accounting.storage.sql.html

Joar Wandborg
[doc] Added REST API, using sphinxcontrib-httpdomain
<!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>accounting.storage.sql package &mdash; Accounting API 0.1-beta documentation</title>
    
    <link rel="stylesheet" href="../_static/pydoctheme.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.1-beta',
        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="Accounting API 0.1-beta documentation" href="../index.html" />
    <link rel="up" title="accounting.storage package" href="accounting.storage.html" />
    <link rel="prev" title="accounting.storage package" href="accounting.storage.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="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../http-routingtable.html" title="HTTP Routing Table"
             >routing table</a> |</li>
        <li class="right" >
          <a href="accounting.storage.html" title="accounting.storage package"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">Accounting API 0.1-beta documentation</a> &raquo;</li>
          <li><a href="accounting.html" >accounting package</a> &raquo;</li>
          <li><a href="accounting.storage.html" accesskey="U">accounting.storage package</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="accounting-storage-sql-package">
<h1>accounting.storage.sql package<a class="headerlink" href="#accounting-storage-sql-package" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-accounting.storage.sql.models">
<span id="accounting-storage-sql-models-module"></span><h2>accounting.storage.sql.models module<a class="headerlink" href="#module-accounting.storage.sql.models" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="accounting.storage.sql.models.Amount">
<em class="property">class </em><tt class="descclassname">accounting.storage.sql.models.</tt><tt class="descname">Amount</tt><big>(</big><em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql/models.html#Amount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.models.Amount" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">flask_sqlalchemy.Model</span></tt></p>
<dl class="attribute">
<dt id="accounting.storage.sql.models.Amount.amount">
<tt class="descname">amount</tt><a class="headerlink" href="#accounting.storage.sql.models.Amount.amount" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="accounting.storage.sql.models.Amount.as_dict">
<tt class="descname">as_dict</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql/models.html#Amount.as_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.models.Amount.as_dict" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Amount.id">
<tt class="descname">id</tt><a class="headerlink" href="#accounting.storage.sql.models.Amount.id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Amount.symbol">
<tt class="descname">symbol</tt><a class="headerlink" href="#accounting.storage.sql.models.Amount.symbol" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="accounting.storage.sql.models.Posting">
<em class="property">class </em><tt class="descclassname">accounting.storage.sql.models.</tt><tt class="descname">Posting</tt><big>(</big><em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql/models.html#Posting"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.models.Posting" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">flask_sqlalchemy.Model</span></tt></p>
<dl class="attribute">
<dt id="accounting.storage.sql.models.Posting.account">
<tt class="descname">account</tt><a class="headerlink" href="#accounting.storage.sql.models.Posting.account" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Posting.amount">
<tt class="descname">amount</tt><a class="headerlink" href="#accounting.storage.sql.models.Posting.amount" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Posting.amount_id">
<tt class="descname">amount_id</tt><a class="headerlink" href="#accounting.storage.sql.models.Posting.amount_id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="accounting.storage.sql.models.Posting.as_dict">
<tt class="descname">as_dict</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql/models.html#Posting.as_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.models.Posting.as_dict" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Posting.id">
<tt class="descname">id</tt><a class="headerlink" href="#accounting.storage.sql.models.Posting.id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Posting.meta">
<tt class="descname">meta</tt><a class="headerlink" href="#accounting.storage.sql.models.Posting.meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Posting.transaction">
<tt class="descname">transaction</tt><a class="headerlink" href="#accounting.storage.sql.models.Posting.transaction" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Posting.transaction_uuid">
<tt class="descname">transaction_uuid</tt><a class="headerlink" href="#accounting.storage.sql.models.Posting.transaction_uuid" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="accounting.storage.sql.models.Transaction">
<em class="property">class </em><tt class="descclassname">accounting.storage.sql.models.</tt><tt class="descname">Transaction</tt><big>(</big><em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql/models.html#Transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.models.Transaction" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">flask_sqlalchemy.Model</span></tt></p>
<dl class="method">
<dt id="accounting.storage.sql.models.Transaction.as_dict">
<tt class="descname">as_dict</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql/models.html#Transaction.as_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.models.Transaction.as_dict" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Transaction.date">
<tt class="descname">date</tt><a class="headerlink" href="#accounting.storage.sql.models.Transaction.date" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Transaction.id">
<tt class="descname">id</tt><a class="headerlink" href="#accounting.storage.sql.models.Transaction.id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Transaction.meta">
<tt class="descname">meta</tt><a class="headerlink" href="#accounting.storage.sql.models.Transaction.meta" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Transaction.payee">
<tt class="descname">payee</tt><a class="headerlink" href="#accounting.storage.sql.models.Transaction.payee" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="accounting.storage.sql.models.Transaction.uuid">
<tt class="descname">uuid</tt><a class="headerlink" href="#accounting.storage.sql.models.Transaction.uuid" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-accounting.storage.sql">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-accounting.storage.sql" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="accounting.storage.sql.SQLStorage">
<em class="property">class </em><tt class="descclassname">accounting.storage.sql.</tt><tt class="descname">SQLStorage</tt><big>(</big><em>app=None</em><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql.html#SQLStorage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.SQLStorage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="accounting.storage.html#accounting.storage.Storage" title="accounting.storage.Storage"><tt class="xref py py-class docutils literal"><span class="pre">accounting.storage.Storage</span></tt></a></p>
<dl class="method">
<dt id="accounting.storage.sql.SQLStorage.add_transaction">
<tt class="descname">add_transaction</tt><big>(</big><em>transaction</em><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql.html#SQLStorage.add_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.SQLStorage.add_transaction" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="accounting.storage.sql.SQLStorage.get_transactions">
<tt class="descname">get_transactions</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql.html#SQLStorage.get_transactions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.SQLStorage.get_transactions" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="accounting.storage.sql.SQLStorage.update_transaction">
<tt class="descname">update_transaction</tt><big>(</big><em>transaction</em><big>)</big><a class="reference internal" href="../_modules/accounting/storage/sql.html#SQLStorage.update_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.sql.SQLStorage.update_transaction" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">accounting.storage.sql package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-accounting.storage.sql.models">accounting.storage.sql.models module</a></li>
<li><a class="reference internal" href="#module-accounting.storage.sql">Module contents</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="accounting.storage.html"
                        title="previous chapter">accounting.storage package</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/api/accounting.storage.sql.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="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="../http-routingtable.html" title="HTTP Routing Table"
             >routing table</a> |</li>
        <li class="right" >
          <a href="accounting.storage.html" title="accounting.storage package"
             >previous</a> |</li>
        <li><a href="../index.html">Accounting API 0.1-beta documentation</a> &raquo;</li>
          <li><a href="accounting.html" >accounting package</a> &raquo;</li>
          <li><a href="accounting.storage.html" >accounting.storage package</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2013, Joar Wandborg.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.
    </div>
  </body>
</html>