adam/metasploit-gs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
c3f5bd3de2d1affa01e2f6c2066c6bb0fc6413bc
metasploit-gs/api/Msf/DBManager/Adapter.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

401 lines
11 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Msf::DBManager::Adapter
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Msf::DBManager::Adapter";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Msf.html" title="Msf (module)">Msf</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DBManager.html" title="Msf::DBManager (class)">DBManager</a></span></span>
&raquo;
<span class="title">Adapter</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Msf::DBManager::Adapter
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../DBManager.html" title="Msf::DBManager (class)">Msf::DBManager</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/db_manager/adapter.rb</dd>
</dl>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="ADAPTER-constant" class="">ADAPTER =
<div class="docstring">
<div class="discussion">
<p>The adapter to use to establish database connection.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>postgresql</span><span class='tstring_end'>&#39;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#driver-instance_method" title="#driver (instance method)">#<strong>driver</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the active driver.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#drivers-instance_method" title="#drivers (instance method)">#<strong>drivers</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the list of usable database drivers.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize_adapter-instance_method" title="#initialize_adapter (instance method)">#<strong>initialize_adapter</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Scan through available drivers.</p>
</div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="driver=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="driver-instance_method">
#<strong>driver</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the active driver</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/db_manager/adapter.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_driver'>driver</span>
<span class='ivar'>@driver</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="drivers=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="drivers-instance_method">
#<strong>drivers</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the list of usable database drivers</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/db_manager/adapter.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_drivers'>drivers</span>
<span class='ivar'>@drivers</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize_adapter-instance_method">
#<strong>initialize_adapter</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Scan through available drivers</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/db_manager/adapter.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize_adapter'>initialize_adapter</span>
<span class='const'>ActiveRecord</span><span class='period'>.</span><span class='id identifier rubyid_default_timezone'>default_timezone</span> <span class='op'>=</span> <span class='symbol'>:utc</span>
<span class='kw'>if</span> <span class='id identifier rubyid_connection_established?'>connection_established?</span> <span class='op'>&amp;&amp;</span> <span class='const'><span class='object_link'><a href="../../ApplicationRecord.html" title="ApplicationRecord (class)">ApplicationRecord</a></span></span><span class='period'>.</span><span class='id identifier rubyid_connection_db_config'>connection_db_config</span><span class='period'>.</span><span class='id identifier rubyid_configuration_hash'>configuration_hash</span><span class='lbracket'>[</span><span class='symbol'>:adapter</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#ADAPTER-constant" title="Msf::DBManager::Adapter::ADAPTER (constant)">ADAPTER</a></span></span>
<span class='id identifier rubyid_dlog'><span class='object_link'><a href="../../top-level-namespace.html#dlog-instance_method" title="#dlog (method)">dlog</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Already established connection to </span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#ADAPTER-constant" title="Msf::DBManager::Adapter::ADAPTER (constant)">ADAPTER</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>, so reusing active connection.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_drivers'>drivers</span> <span class='op'>&lt;&lt;</span> <span class='const'><span class='object_link'><a href="#ADAPTER-constant" title="Msf::DBManager::Adapter::ADAPTER (constant)">ADAPTER</a></span></span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_driver'>driver</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#ADAPTER-constant" title="Msf::DBManager::Adapter::ADAPTER (constant)">ADAPTER</a></span></span>
<span class='kw'>else</span>
<span class='kw'>begin</span>
<span class='const'><span class='object_link'><a href="../../ApplicationRecord.html" title="ApplicationRecord (class)">ApplicationRecord</a></span></span><span class='period'>.</span><span class='id identifier rubyid_establish_connection'>establish_connection</span><span class='lparen'>(</span><span class='label'>adapter:</span> <span class='const'><span class='object_link'><a href="#ADAPTER-constant" title="Msf::DBManager::Adapter::ADAPTER (constant)">ADAPTER</a></span></span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../ApplicationRecord.html" title="ApplicationRecord (class)">ApplicationRecord</a></span></span><span class='period'>.</span><span class='id identifier rubyid_remove_connection'>remove_connection</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../Exception.html" title="Msf::Exception (module)">Exception</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_error'>error</span>
<span class='ivar'>@adapter_error</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span>
<span class='kw'>else</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_drivers'>drivers</span> <span class='op'>&lt;&lt;</span> <span class='const'><span class='object_link'><a href="#ADAPTER-constant" title="Msf::DBManager::Adapter::ADAPTER (constant)">ADAPTER</a></span></span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_driver'>driver</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#ADAPTER-constant" title="Msf::DBManager::Adapter::ADAPTER (constant)">ADAPTER</a></span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:01:20 2026 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.1.5).
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink