Document only backend

2026-04-28 01:59:35 -04:00 · 2019-12-15 12:58:59 -05:00
parent 7eb1cb330b
commit d82f247d83
91 changed files with 7782 additions and 2 deletions
--- a/docs/html/d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html
+++ b/docs/html/d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html
@@ -0,0 +1,214 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.16"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.storage.Storage Class Reference</title>
+<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="../../jquery.js"></script>
+<script type="text/javascript" src="../../dynsections.js"></script>
+<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">pyShelf Open Source Ebook Server
+   &#160;<span id="projectnumber">0.3.0</span>
+   </div>
+   <div id="projectbrief">Open source, console based E-book server</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.16 -->
+<script type="text/javascript" src="../../menudata.js"></script>
+<script type="text/javascript" src="../../menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('../../',false,false,'search.php','Search');
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+<div id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><b>pyShelf</b></li><li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>lib</b></li><li class="navelem"><b>storage</b></li><li class="navelem"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">Storage</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> &#124;
+<a href="#pub-attribs">Public Attributes</a> &#124;
+<a href="../../dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html">List of all members</a>  </div>
+  <div class="headertitle">
+<div class="title">pyShelf.src.backend.lib.storage.Storage Class Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:a91cd4a032d59e27f251602767663ba8c"><td class="memItemLeft" align="right" valign="top"><a id="a91cd4a032d59e27f251602767663ba8c"></a>
+def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, db_pointer, config)</td></tr>
+<tr class="separator:a91cd4a032d59e27f251602767663ba8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7532f4b2a2af0f7100253642f8af4597"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a7532f4b2a2af0f7100253642f8af4597">create_tables</a> (self)</td></tr>
+<tr class="separator:a7532f4b2a2af0f7100253642f8af4597"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad08ae5682a3e3e66658eee723084fe2a"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#ad08ae5682a3e3e66658eee723084fe2a">insert_book</a> (self, book)</td></tr>
+<tr class="separator:ad08ae5682a3e3e66658eee723084fe2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a27348bc85856956bade10ec39d51b77e"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a27348bc85856956bade10ec39d51b77e">book_paths_list</a> (self)</td></tr>
+<tr class="separator:a27348bc85856956bade10ec39d51b77e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a92c651d41e130c97e73703eb608c82c4"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a92c651d41e130c97e73703eb608c82c4">commit</a> (self)</td></tr>
+<tr class="separator:a92c651d41e130c97e73703eb608c82c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aea7868ca9c943e107e2454871c730555"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#aea7868ca9c943e107e2454871c730555">close</a> (self)</td></tr>
+<tr class="separator:aea7868ca9c943e107e2454871c730555"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
+Public Attributes</h2></td></tr>
+<tr class="memitem:a75fe7e19d117f581ab9c64e8c8222117"><td class="memItemLeft" align="right" valign="top"><a id="a75fe7e19d117f581ab9c64e8c8222117"></a>
+&#160;</td><td class="memItemRight" valign="bottom"><b>sql</b></td></tr>
+<tr class="separator:a75fe7e19d117f581ab9c64e8c8222117"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0d5ef3dbb0c2098218ef827c1f802d95"><td class="memItemLeft" align="right" valign="top"><a id="a0d5ef3dbb0c2098218ef827c1f802d95"></a>
+&#160;</td><td class="memItemRight" valign="bottom"><b>user</b></td></tr>
+<tr class="separator:a0d5ef3dbb0c2098218ef827c1f802d95"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8b6ec6036bc242c1071bf5a7e5bb9a2f"><td class="memItemLeft" align="right" valign="top"><a id="a8b6ec6036bc242c1071bf5a7e5bb9a2f"></a>
+&#160;</td><td class="memItemRight" valign="bottom"><b>password</b></td></tr>
+<tr class="separator:a8b6ec6036bc242c1071bf5a7e5bb9a2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7ec30ede190deb5ac506353296ee1688"><td class="memItemLeft" align="right" valign="top"><a id="a7ec30ede190deb5ac506353296ee1688"></a>
+&#160;</td><td class="memItemRight" valign="bottom"><b>db_host</b></td></tr>
+<tr class="separator:a7ec30ede190deb5ac506353296ee1688"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5ebe78f76f168a704bfc1db557498dbc"><td class="memItemLeft" align="right" valign="top"><a id="a5ebe78f76f168a704bfc1db557498dbc"></a>
+&#160;</td><td class="memItemRight" valign="bottom"><b>db_port</b></td></tr>
+<tr class="separator:a5ebe78f76f168a704bfc1db557498dbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae09691f51c6080036606130d45e342e8"><td class="memItemLeft" align="right" valign="top"><a id="ae09691f51c6080036606130d45e342e8"></a>
+&#160;</td><td class="memItemRight" valign="bottom"><b>db</b></td></tr>
+<tr class="separator:ae09691f51c6080036606130d45e342e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1c6f8923f7accceb114495cb783a3216"><td class="memItemLeft" align="right" valign="top"><a id="a1c6f8923f7accceb114495cb783a3216"></a>
+&#160;</td><td class="memItemRight" valign="bottom"><b>cursor</b></td></tr>
+<tr class="separator:a1c6f8923f7accceb114495cb783a3216"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><pre class="fragment">Contains all methods for system storage</pre> </div><h2 class="groupheader">Member Function Documentation</h2>
+<a id="a27348bc85856956bade10ec39d51b77e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a27348bc85856956bade10ec39d51b77e">&#9670;&nbsp;</a></span>book_paths_list()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">def pyShelf.src.backend.lib.storage.Storage.book_paths_list </td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>self</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<pre class="fragment">Get file paths from database for comparison to system files
+</pre>
+</div>
+</div>
+<a id="aea7868ca9c943e107e2454871c730555"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aea7868ca9c943e107e2454871c730555">&#9670;&nbsp;</a></span>close()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">def pyShelf.src.backend.lib.storage.Storage.close </td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>self</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<pre class="fragment">Close database connection
+</pre>
+</div>
+</div>
+<a id="a92c651d41e130c97e73703eb608c82c4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a92c651d41e130c97e73703eb608c82c4">&#9670;&nbsp;</a></span>commit()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">def pyShelf.src.backend.lib.storage.Storage.commit </td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>self</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<pre class="fragment">Commit database transactions
+</pre>
+</div>
+</div>
+<a id="a7532f4b2a2af0f7100253642f8af4597"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7532f4b2a2af0f7100253642f8af4597">&#9670;&nbsp;</a></span>create_tables()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">def pyShelf.src.backend.lib.storage.Storage.create_tables </td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>self</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<pre class="fragment">Create table structure</pre>
+</div>
+</div>
+<a id="ad08ae5682a3e3e66658eee723084fe2a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad08ae5682a3e3e66658eee723084fe2a">&#9670;&nbsp;</a></span>insert_book()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">def pyShelf.src.backend.lib.storage.Storage.insert_book </td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>self</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>book</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<pre class="fragment">Insert book in database
+:returns: True if succeeds False if not
+</pre>
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>src/backend/lib/<a class="el" href="../../">storage.py</a></li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="../../doxygen.png" alt="doxygen"/>
+</a> 1.8.16
+</small></address>
+</body>
+</html>