ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-01-30 11:35:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/RelationalDatabase_8cpp_source.html
bthomee 9368c0d563 deploy: 5f638f5553
2026-01-28 10:13:01 -08:00

144 lines
14 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: RelationalDatabase.cpp 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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_9ce43f199f7837b2bc54444bf73b9bab.html">rdb</a></li><li class="navelem"><a class="el" href="dir_2e610841efb4e959cb432e522736434e.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">RelationalDatabase.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;xrpld/app/main/Application.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;xrpld/app/rdb/RelationalDatabase.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpld/core/ConfigSections.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">extern</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr&lt;RelationalDatabase&gt;</a></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><a class="code hl_function" href="namespacexrpl.html#aa5f3ef4d43229fdd0ad568c0660fef07">getSQLiteDatabase</a>(Application&amp; app, Config <span class="keyword">const</span>&amp; config, JobQueue&amp; jobQueue);</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr&lt;RelationalDatabase&gt;</a></div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="}">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classxrpl_1_1RelationalDatabase.html#a3c901750a932fd04993f7d18dfd5e248"> 11</a></span><a class="code hl_function" href="classxrpl_1_1RelationalDatabase.html#a3c901750a932fd04993f7d18dfd5e248">RelationalDatabase::init</a>(<a class="code hl_class" href="classxrpl_1_1Application.html">Application</a>&amp; app, <a class="code hl_class" href="classxrpl_1_1Config.html">Config</a> <span class="keyword">const</span>&amp; config, <a class="code hl_class" href="classxrpl_1_1JobQueue.html">JobQueue</a>&amp; jobQueue)</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>{</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keywordtype">bool</span> use_sqlite = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <a class="code hl_class" href="classxrpl_1_1Section.html">Section</a> <span class="keyword">const</span>&amp; rdb_section{config.<a class="code hl_function" href="classxrpl_1_1BasicConfig.html#af4adcb2a916d5c27cf360f0cbb0dc991">section</a>(SECTION_RELATIONAL_DB)};</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keywordflow">if</span> (!rdb_section.empty())</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keywordflow">if</span> (boost::iequals(<a class="code hl_function" href="namespacexrpl.html#a35eb8e7a63de05fb4478c7faa7bdc70b">get</a>(rdb_section, <span class="stringliteral">&quot;backend&quot;</span>), <span class="stringliteral">&quot;sqlite&quot;</span>))</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> use_sqlite = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> }</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> Throw&lt;std::runtime_error&gt;(<span class="stringliteral">&quot;Invalid rdb_section backend value: &quot;</span> + <a class="code hl_function" href="namespacexrpl.html#a35eb8e7a63de05fb4478c7faa7bdc70b">get</a>(rdb_section, <span class="stringliteral">&quot;backend&quot;</span>));</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> }</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> use_sqlite = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> }</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">if</span> (use_sqlite)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespacexrpl.html#aa5f3ef4d43229fdd0ad568c0660fef07">getSQLiteDatabase</a>(app, config, jobQueue);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> }</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">return</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::unique_ptr&lt;RelationalDatabase&gt;</a>();</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>}</div>
</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>} <span class="comment">// namespace xrpl</span></div>
<div class="ttc" id="aclassxrpl_1_1Application_html"><div class="ttname"><a href="classxrpl_1_1Application.html">xrpl::Application</a></div><div class="ttdef"><b>Definition</b> <a href="Application_8h_source.html#l00094">Application.h:95</a></div></div>
<div class="ttc" id="aclassxrpl_1_1BasicConfig_html_af4adcb2a916d5c27cf360f0cbb0dc991"><div class="ttname"><a href="classxrpl_1_1BasicConfig.html#af4adcb2a916d5c27cf360f0cbb0dc991">xrpl::BasicConfig::section</a></div><div class="ttdeci">Section &amp; section(std::string const &amp;name)</div><div class="ttdoc">Returns the section with the given name.</div><div class="ttdef"><b>Definition</b> <a href="BasicConfig_8cpp_source.html#l00117">BasicConfig.cpp:117</a></div></div>
<div class="ttc" id="aclassxrpl_1_1Config_html"><div class="ttname"><a href="classxrpl_1_1Config.html">xrpl::Config</a></div><div class="ttdef"><b>Definition</b> <a href="Config_8h_source.html#l00066">Config.h:67</a></div></div>
<div class="ttc" id="aclassxrpl_1_1JobQueue_html"><div class="ttname"><a href="classxrpl_1_1JobQueue.html">xrpl::JobQueue</a></div><div class="ttdoc">A pool of threads to perform work.</div><div class="ttdef"><b>Definition</b> <a href="JobQueue_8h_source.html#l00037">JobQueue.h:38</a></div></div>
<div class="ttc" id="aclassxrpl_1_1RelationalDatabase_html_a3c901750a932fd04993f7d18dfd5e248"><div class="ttname"><a href="classxrpl_1_1RelationalDatabase.html#a3c901750a932fd04993f7d18dfd5e248">xrpl::RelationalDatabase::init</a></div><div class="ttdeci">static std::unique_ptr&lt; RelationalDatabase &gt; init(Application &amp;app, Config const &amp;config, JobQueue &amp;jobQueue)</div><div class="ttdoc">init Creates and returns an appropriate RelationalDatabase instance based on configuration.</div><div class="ttdef"><b>Definition</b> <a href="RelationalDatabase_8cpp_source.html#l00011">RelationalDatabase.cpp:11</a></div></div>
<div class="ttc" id="aclassxrpl_1_1Section_html"><div class="ttname"><a href="classxrpl_1_1Section.html">xrpl::Section</a></div><div class="ttdoc">Holds a collection of configuration values.</div><div class="ttdef"><b>Definition</b> <a href="BasicConfig_8h_source.html#l00024">BasicConfig.h:25</a></div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a35eb8e7a63de05fb4478c7faa7bdc70b"><div class="ttname"><a href="namespacexrpl.html#a35eb8e7a63de05fb4478c7faa7bdc70b">xrpl::get</a></div><div class="ttdeci">T get(Section const &amp;section, std::string const &amp;name, T const &amp;defaultValue=T{})</div><div class="ttdoc">Retrieve a key/value pair from a section.</div><div class="ttdef"><b>Definition</b> <a href="BasicConfig_8h_source.html#l00326">BasicConfig.h:326</a></div></div>
<div class="ttc" id="anamespacexrpl_html_aa5f3ef4d43229fdd0ad568c0660fef07"><div class="ttname"><a href="namespacexrpl.html#aa5f3ef4d43229fdd0ad568c0660fef07">xrpl::getSQLiteDatabase</a></div><div class="ttdeci">std::unique_ptr&lt; RelationalDatabase &gt; getSQLiteDatabase(Application &amp;app, Config const &amp;config, JobQueue &amp;jobQueue)</div><div class="ttdef"><b>Definition</b> <a href="SQLiteDatabase_8cpp_source.html#l00772">SQLiteDatabase.cpp:772</a></div></div>
<div class="ttc" id="aunique_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink