91 lines
19 KiB
HTML
91 lines
19 KiB
HTML
<!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.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>remwharead: include/sqlite.hpp Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.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">remwharead
|
|
 <span id="projectnumber">0.9.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">sqlite.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* This file is part of remwharead.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright © 2019 tastytea <tastytea@tastytea.de></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the Free Software Foundation, version 3.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * GNU General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef REMWHAREAD_SQLITE_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define REMWHAREAD_SQLITE_HPP</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <Poco/Data/Session.h></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <chrono></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <experimental/filesystem></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <list></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>remwharead</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span>fs = std::experimental::filesystem;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">using</span> std::vector;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">using</span> std::chrono::system_clock;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">using</span> time_point = system_clock::time_point;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">using</span> std::list;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">using</span> Poco::Data::Session;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classremwharead_1_1Database.html"> 45</a></span> <span class="keyword">class </span><a class="code" href="classremwharead_1_1Database.html">Database</a></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structremwharead_1_1Database_1_1entry.html"> 55</a></span>  <span class="keyword">struct </span><a class="code" href="structremwharead_1_1Database_1_1entry.html">entry</a></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">string</span> uri;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">string</span> archive_uri;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  time_point datetime;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  vector<string> tags;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">string</span> title;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">string</span> description;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">string</span> fulltext;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">friend</span> <span class="keywordtype">bool</span> <a class="code" href="structremwharead_1_1Database_1_1entry.html#a67f257a407ec46c00d205fd4c9215846">operator ==</a>(<span class="keyword">const</span> <a class="code" href="structremwharead_1_1Database_1_1entry.html">Database::entry</a> &a,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> <a class="code" href="structremwharead_1_1Database_1_1entry.html">Database::entry</a> &b);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  [[nodiscard]]</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">string</span> <a class="code" href="structremwharead_1_1Database_1_1entry.html#ae74916f391ce95d3a4d554fd6c401006">fulltext_oneline</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  };</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classremwharead_1_1Database.html#a8576436b2cc1e3d8ecfdeabfc0ff88ca">Database</a>();</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool() <span class="keyword">const</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span> <a class="code" href="classremwharead_1_1Database.html#ab3ea9062c5c0ef5d9f2b7eea6f0fd1bd">store</a>(<span class="keyword">const</span> <a class="code" href="structremwharead_1_1Database_1_1entry.html">entry</a> &data) <span class="keyword">const</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  [[nodiscard]]</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  list<entry> <a class="code" href="classremwharead_1_1Database.html#a98a37f6bdd99516c9c92fc62a63544df">retrieve</a>(<span class="keyword">const</span> time_point &start = time_point(),</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">const</span> time_point &end = system_clock::now()) <span class="keyword">const</span>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">size_t</span> <a class="code" href="classremwharead_1_1Database.html#ac1d6d013686cffe1749b52feb6fdce67">remove</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &uri);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  [[nodiscard]]</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1Database.html#a61f526a9e56544fd7343e8bf35748a3b">tags_to_string</a>(<span class="keyword">const</span> vector<string> &tags);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  fs::path _dbpath;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  std::unique_ptr<Session> _session;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">bool</span> _connected;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  [[nodiscard]]</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  fs::path get_data_home() <span class="keyword">const</span>;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> };</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> } <span class="comment">// namespace remwharead</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#endif // REMWHAREAD_SQLITE_HPP</span></div><div class="ttc" id="classremwharead_1_1Database_html_a98a37f6bdd99516c9c92fc62a63544df"><div class="ttname"><a href="classremwharead_1_1Database.html#a98a37f6bdd99516c9c92fc62a63544df">remwharead::Database::retrieve</a></div><div class="ttdeci">list< entry > retrieve(const time_point &start=time_point(), const time_point &end=system_clock::now()) const</div><div class="ttdoc">Retrieve a list of Database::entry from the database.</div><div class="ttdef"><b>Definition:</b> sqlite.cpp:104</div></div>
|
|
<div class="ttc" id="structremwharead_1_1Database_1_1entry_html_ae74916f391ce95d3a4d554fd6c401006"><div class="ttname"><a href="structremwharead_1_1Database_1_1entry.html#ae74916f391ce95d3a4d554fd6c401006">remwharead::Database::entry::fulltext_oneline</a></div><div class="ttdeci">string fulltext_oneline() const</div><div class="ttdoc">The full text in one line.</div><div class="ttdef"><b>Definition:</b> sqlite.cpp:71</div></div>
|
|
<div class="ttc" id="classremwharead_1_1Database_html"><div class="ttname"><a href="classremwharead_1_1Database.html">remwharead::Database</a></div><div class="ttdoc">Store and retrieve files from/to SQLite.</div><div class="ttdef"><b>Definition:</b> sqlite.hpp:45</div></div>
|
|
<div class="ttc" id="classremwharead_1_1Database_html_ab3ea9062c5c0ef5d9f2b7eea6f0fd1bd"><div class="ttname"><a href="classremwharead_1_1Database.html#ab3ea9062c5c0ef5d9f2b7eea6f0fd1bd">remwharead::Database::store</a></div><div class="ttdeci">void store(const entry &data) const</div><div class="ttdoc">Store a Database::entry in the database.</div><div class="ttdef"><b>Definition:</b> sqlite.cpp:82</div></div>
|
|
<div class="ttc" id="structremwharead_1_1Database_1_1entry_html"><div class="ttname"><a href="structremwharead_1_1Database_1_1entry.html">remwharead::Database::entry</a></div><div class="ttdoc">Describes a database entry.</div><div class="ttdef"><b>Definition:</b> sqlite.hpp:55</div></div>
|
|
<div class="ttc" id="structremwharead_1_1Database_1_1entry_html_a67f257a407ec46c00d205fd4c9215846"><div class="ttname"><a href="structremwharead_1_1Database_1_1entry.html#a67f257a407ec46c00d205fd4c9215846">remwharead::Database::entry::operator==</a></div><div class="ttdeci">friend bool operator==(const Database::entry &a, const Database::entry &b)</div><div class="ttdoc">Returns true if date and time are equal.</div><div class="ttdef"><b>Definition:</b> sqlite.cpp:66</div></div>
|
|
<div class="ttc" id="classremwharead_1_1Database_html_a8576436b2cc1e3d8ecfdeabfc0ff88ca"><div class="ttname"><a href="classremwharead_1_1Database.html#a8576436b2cc1e3d8ecfdeabfc0ff88ca">remwharead::Database::Database</a></div><div class="ttdeci">Database()</div><div class="ttdoc">Connects to the database and creates it if necessary.</div><div class="ttdef"><b>Definition:</b> sqlite.cpp:35</div></div>
|
|
<div class="ttc" id="classremwharead_1_1Database_html_a61f526a9e56544fd7343e8bf35748a3b"><div class="ttname"><a href="classremwharead_1_1Database.html#a61f526a9e56544fd7343e8bf35748a3b">remwharead::Database::tags_to_string</a></div><div class="ttdeci">static string tags_to_string(const vector< string > &tags)</div><div class="ttdoc">Returns tags as comma separated string.</div><div class="ttdef"><b>Definition:</b> sqlite.cpp:169</div></div>
|
|
<div class="ttc" id="classremwharead_1_1Database_html_ac1d6d013686cffe1749b52feb6fdce67"><div class="ttname"><a href="classremwharead_1_1Database.html#ac1d6d013686cffe1749b52feb6fdce67">remwharead::Database::remove</a></div><div class="ttdeci">size_t remove(const string &uri)</div><div class="ttdoc">Remove all entries with this URI from database.</div><div class="ttdef"><b>Definition:</b> sqlite.cpp:160</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.15
|
|
</small></address>
|
|
</body>
|
|
</html>
|