vassili/seitime-frappe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4
seitime-frappe/docs/_build/html/_modules/webnotes/utils/archive.html
Rushabh Mehta b624972f0d added new docs
2011-06-29 14:41:49 +05:30

204 lines
No EOL
20 KiB
HTML
Raw Blame History

<!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>webnotes.utils.archive &mdash; WNFramework v1.8 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: '1.8',
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="WNFramework v1.8 documentation" href="../../../index.html" />
<link rel="up" title="webnotes.utils" href="../utils.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><a href="../../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Module code</a> &raquo;</li>
<li><a href="../../webnotes.html" >webnotes</a> &raquo;</li>
<li><a href="../utils.html" accesskey="U">webnotes.utils</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for webnotes.utils.archive</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="n">sql</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span>
<span class="c"># main function</span>
<span class="c"># -------------------------</span>
<div class="viewcode-block" id="archive_doc"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.archive.archive_doc">[docs]</a><span class="k">def</span> <span class="nf">archive_doc</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">restore</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="n">archive_record</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">restore</span><span class="p">)</span>
<span class="n">tables</span> <span class="o">=</span> <span class="n">sql</span><span class="p">(</span><span class="s">&quot;select options from tabDocField where parent=</span><span class="si">%s</span><span class="s"> and fieldtype=&#39;Table&#39;&quot;</span><span class="p">,</span> <span class="n">doctype</span><span class="p">)</span>
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">tables</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">rec_list</span> <span class="o">=</span> <span class="n">sql</span><span class="p">(</span><span class="s">&quot;select name from `</span><span class="si">%s%s</span><span class="s">` where parent=</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">((</span><span class="n">restore</span> <span class="ow">and</span> <span class="s">&#39;arc&#39;</span> <span class="ow">or</span> <span class="s">&#39;tab&#39;</span><span class="p">)</span> <span class="p">,</span><span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">),</span> <span class="n">name</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span><span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">==</span><span class="mi">1146</span><span class="p">:</span> <span class="c"># no child table</span>
<span class="n">rec_list</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">rec_list</span><span class="p">:</span>
<span class="n">archive_record</span><span class="p">(</span><span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">r</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">restore</span><span class="p">)</span>
<span class="c"># archive individual record</span>
<span class="c"># -------------------------</span>
</div>
<div class="viewcode-block" id="archive_record"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.archive.archive_record">[docs]</a><span class="k">def</span> <span class="nf">archive_record</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">restore</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
<span class="n">src_tab</span> <span class="o">=</span> <span class="p">(</span><span class="n">restore</span> <span class="ow">and</span> <span class="s">&#39;arc&#39;</span> <span class="ow">or</span> <span class="s">&#39;tab&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="n">doctype</span>
<span class="n">tar_tab</span> <span class="o">=</span> <span class="p">(</span><span class="n">restore</span> <span class="ow">and</span> <span class="s">&#39;tab&#39;</span> <span class="ow">or</span> <span class="s">&#39;arc&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="n">doctype</span>
<span class="c"># get the record</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">rec</span> <span class="o">=</span> <span class="n">sql</span><span class="p">(</span><span class="s">&quot;select * from `</span><span class="si">%s</span><span class="s">` where name=</span><span class="si">%s</span><span class="s"> for update&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">src_tab</span><span class="p">,</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">),</span> <span class="n">name</span><span class="p">,</span> <span class="n">as_dict</span><span class="o">=</span><span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">==</span><span class="mi">1146</span><span class="p">:</span>
<span class="k">return</span> <span class="c"># source table does not exist</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="c"># insert the record</span>
<span class="n">insert_record</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">tar_tab</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="c"># put it field by field (ignore missing columns)</span>
<span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">rec</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
<span class="k">if</span> <span class="n">rec</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">):</span>
<span class="n">update_value</span><span class="p">(</span><span class="n">src_tab</span><span class="p">,</span> <span class="n">tar_tab</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">rec</span><span class="p">,</span> <span class="n">field</span><span class="p">)</span>
<span class="c"># delete from main</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">sql</span><span class="p">(</span><span class="s">&quot;delete from `</span><span class="si">%s</span><span class="s">` where name=</span><span class="si">%s</span><span class="s"> limit 1&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">src_tab</span><span class="p">,</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">),</span> <span class="n">name</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">==</span><span class="mi">1451</span><span class="p">:</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">msgprint</span><span class="p">(</span><span class="s">&quot;Cannot archive </span><span class="si">%s</span><span class="s"> &#39;</span><span class="si">%s</span><span class="s">&#39; as it is referenced in another record. You must delete the referred record first&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
<span class="c"># delete from target, as it will create a double copy!</span>
<span class="n">sql</span><span class="p">(</span><span class="s">&quot;delete from `</span><span class="si">%s</span><span class="s">` where name=</span><span class="si">%s</span><span class="s"> limit 1&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">tar_tab</span><span class="p">,</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">),</span> <span class="n">name</span><span class="p">)</span>
<span class="c"># insert the record</span>
<span class="c"># -------------------------</span>
</div>
<div class="viewcode-block" id="insert_record_name"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.archive.insert_record_name">[docs]</a><span class="k">def</span> <span class="nf">insert_record_name</span><span class="p">(</span><span class="n">tab</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="n">sql</span><span class="p">(</span><span class="s">&quot;insert ignore into `</span><span class="si">%s</span><span class="s">` (name) values (</span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">tab</span><span class="p">,</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">),</span> <span class="n">name</span><span class="p">)</span>
<span class="c"># insert record</span>
<span class="c"># -------------------------</span>
</div>
<div class="viewcode-block" id="insert_record"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.archive.insert_record">[docs]</a><span class="k">def</span> <span class="nf">insert_record</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">tar_tab</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">insert_record_name</span><span class="p">(</span><span class="n">tar_tab</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">==</span><span class="mi">1146</span><span class="p">:</span>
<span class="c"># missing table - create it</span>
<span class="kn">from</span> <span class="nn">webnotes.model.db_schema</span> <span class="kn">import</span> <span class="n">updatedb</span>
<span class="n">updatedb</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="c"># again</span>
<span class="n">insert_record_name</span><span class="p">(</span><span class="n">tar_tab</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="c"># update single value</span>
<span class="c"># -------------------------</span>
</div>
<div class="viewcode-block" id="update_single_value"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.archive.update_single_value">[docs]</a><span class="k">def</span> <span class="nf">update_single_value</span><span class="p">(</span><span class="n">tab</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="n">sql</span><span class="p">(</span><span class="s">&quot;update `</span><span class="si">%s</span><span class="s">` set `</span><span class="si">%s</span><span class="s">`=</span><span class="si">%s</span><span class="s"> where name=</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">tab</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">,</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">),</span> <span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
<span class="c"># update value</span>
<span class="c"># -------------------------</span>
</div>
<div class="viewcode-block" id="update_value"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.archive.update_value">[docs]</a><span class="k">def</span> <span class="nf">update_value</span><span class="p">(</span><span class="n">src_tab</span><span class="p">,</span> <span class="n">tar_tab</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">rec</span><span class="p">,</span> <span class="n">field</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">update_single_value</span><span class="p">(</span><span class="n">tar_tab</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">rec</span><span class="p">[</span><span class="n">field</span><span class="p">],</span> <span class="n">name</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">==</span><span class="mi">1054</span><span class="p">:</span>
<span class="c"># column missing.... add it?</span>
<span class="n">ftype</span> <span class="o">=</span> <span class="n">sql</span><span class="p">(</span><span class="s">&quot;show columns from `</span><span class="si">%s</span><span class="s">` like &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">src_tab</span><span class="p">,</span> <span class="n">field</span><span class="p">))[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span> <span class="c"># causes implict commit</span>
<span class="n">sql</span><span class="p">(</span><span class="s">&quot;alter table `</span><span class="si">%s</span><span class="s">` add column `</span><span class="si">%s</span><span class="s">` </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">tar_tab</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">ftype</span><span class="p">))</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span>
<span class="c"># again</span>
<span class="n">update_single_value</span><span class="p">(</span><span class="n">tar_tab</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">rec</span><span class="p">[</span><span class="n">field</span><span class="p">],</span> <span class="n">name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
</pre></div></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../index.html">
<img class="logo" src="../../../_static/wnflogo200.gif" alt="Logo"/>
</a></p>
<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="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Module code</a> &raquo;</li>
<li><a href="../../webnotes.html" >webnotes</a> &raquo;</li>
<li><a href="../utils.html" >webnotes.utils</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink