271 lines
6.8 KiB
HTML
271 lines
6.8 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8" />
|
||
|
|
<meta id="repository-name" content="github.com/crystal-lang/crystal-db">
|
||
|
|
<link href="../css/style.css" rel="stylesheet" type="text/css" />
|
||
|
|
<script type="text/javascript" src="../js/doc.js"></script>
|
||
|
|
<title>DB::Disposable - github.com/crystal-lang/crystal-db</title>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<div id="types-list">
|
||
|
|
<div id="search-box">
|
||
|
|
<input type="search" id="search-input" placeholder="Search...">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="../index.html">README</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
|
||
|
|
<li class="parent open current" data-id="github.com/crystal-lang/crystal-db/DB" data-name="db">
|
||
|
|
<a href="../DB.html">DB</a>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Any" data-name="db::any">
|
||
|
|
<a href="../DB/Any.html">Any</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Connection" data-name="db::connection">
|
||
|
|
<a href="../DB/Connection.html">Connection</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/ConnectionLost" data-name="db::connectionlost">
|
||
|
|
<a href="../DB/ConnectionLost.html">ConnectionLost</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Database" data-name="db::database">
|
||
|
|
<a href="../DB/Database.html">Database</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" current" data-id="github.com/crystal-lang/crystal-db/DB/Disposable" data-name="db::disposable">
|
||
|
|
<a href="../DB/Disposable.html">Disposable</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Driver" data-name="db::driver">
|
||
|
|
<a href="../DB/Driver.html">Driver</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Error" data-name="db::error">
|
||
|
|
<a href="../DB/Error.html">Error</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/ExecResult" data-name="db::execresult">
|
||
|
|
<a href="../DB/ExecResult.html">ExecResult</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Mappable" data-name="db::mappable">
|
||
|
|
<a href="../DB/Mappable.html">Mappable</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/MappingException" data-name="db::mappingexception">
|
||
|
|
<a href="../DB/MappingException.html">MappingException</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class="parent " data-id="github.com/crystal-lang/crystal-db/DB/Pool" data-name="db::pool(t)">
|
||
|
|
<a href="../DB/Pool.html">Pool</a>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Pool/TimeoutHelper" data-name="db::pool::timeouthelper">
|
||
|
|
<a href="../DB/Pool/TimeoutHelper.html">TimeoutHelper</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/PoolRetryAttemptsExceeded" data-name="db::poolretryattemptsexceeded">
|
||
|
|
<a href="../DB/PoolRetryAttemptsExceeded.html">PoolRetryAttemptsExceeded</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/PoolStatement" data-name="db::poolstatement">
|
||
|
|
<a href="../DB/PoolStatement.html">PoolStatement</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/PoolTimeout" data-name="db::pooltimeout">
|
||
|
|
<a href="../DB/PoolTimeout.html">PoolTimeout</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/QueryMethods" data-name="db::querymethods">
|
||
|
|
<a href="../DB/QueryMethods.html">QueryMethods</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/ResultSet" data-name="db::resultset">
|
||
|
|
<a href="../DB/ResultSet.html">ResultSet</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Statement" data-name="db::statement">
|
||
|
|
<a href="../DB/Statement.html">Statement</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/StatementMethods" data-name="db::statementmethods">
|
||
|
|
<a href="../DB/StatementMethods.html">StatementMethods</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/StringKeyCache" data-name="db::stringkeycache(t)">
|
||
|
|
<a href="../DB/StringKeyCache.html">StringKeyCache</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="main-content">
|
||
|
|
<h1 class="type-name">
|
||
|
|
|
||
|
|
<span class="kind">module</span> DB::Disposable
|
||
|
|
|
||
|
|
</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Overview</h2>
|
||
|
|
|
||
|
|
<p>Generic module to encapsulate disposable db resources.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Direct including types</h2>
|
||
|
|
<ul class="other-types-list">
|
||
|
|
|
||
|
|
<li class="other-type"><a href="../DB/Connection.html">DB::Connection</a></li>
|
||
|
|
|
||
|
|
<li class="other-type"><a href="../DB/ResultSet.html">DB::ResultSet</a></li>
|
||
|
|
|
||
|
|
<li class="other-type"><a href="../DB/StatementMethods.html">DB::StatementMethods</a></li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Defined in:</h2>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/disposable.cr#L3" target="_blank">db/disposable.cr</a>
|
||
|
|
|
||
|
|
<br/>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Instance Method Summary</h2>
|
||
|
|
<ul class="list-summary">
|
||
|
|
|
||
|
|
<li class="entry-summary">
|
||
|
|
<a href="#close-instance-method" class="signature"><strong>#close</strong></a>
|
||
|
|
|
||
|
|
<div class="summary"><p>Closes this object.</p></div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class="entry-summary">
|
||
|
|
<a href="#closed%3F-instance-method" class="signature"><strong>#closed?</strong></a>
|
||
|
|
|
||
|
|
<div class="summary"><p>Returns <code>true</code> if this object is closed.</p></div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="methods-inherited">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Instance Method Detail</h2>
|
||
|
|
|
||
|
|
<div class="entry-detail" id="close-instance-method">
|
||
|
|
<div class="signature">
|
||
|
|
|
||
|
|
def <strong>close</strong>
|
||
|
|
|
||
|
|
<a class="method-permalink" href="#close-instance-method">#</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="doc"><p>Closes this object.</p></div>
|
||
|
|
|
||
|
|
<br/>
|
||
|
|
<div>
|
||
|
|
|
||
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/disposable.cr#L9" target="_blank">View source</a>]
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="entry-detail" id="closed?-instance-method">
|
||
|
|
<div class="signature">
|
||
|
|
|
||
|
|
def <strong>closed?</strong>
|
||
|
|
|
||
|
|
<a class="method-permalink" href="#closed%3F-instance-method">#</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="doc"><p>Returns <code>true</code> if this object is closed. See <code><a href="../DB/Disposable.html#close-instance-method">#close</a></code>.</p></div>
|
||
|
|
|
||
|
|
<br/>
|
||
|
|
<div>
|
||
|
|
|
||
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/disposable.cr#L16" target="_blank">View source</a>]
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|