mirror of
https://gitea.invidious.io/iv-org/shard-crystal-db.git
synced 2024-08-15 00:53:32 +00:00
363 lines
10 KiB
HTML
363 lines
10 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::Connection - 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=" current" 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=" " 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">abstract class</span> DB::Connection
|
||
|
|
|
||
|
|
</h1>
|
||
|
|
|
||
|
|
|
||
|
|
<ul class="superclass-hierarchy"><li class="superclass"><a href="../DB/Connection.html">DB::Connection</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Overview</h2>
|
||
|
|
|
||
|
|
<p>Database driver implementors must subclass <code><a href="../DB/Connection.html">Connection</a></code>.</p>
|
||
|
|
|
||
|
|
<p>Represents one active connection to a database.</p>
|
||
|
|
|
||
|
|
<p>Users should never instantiate a <code><a href="../DB/Connection.html">Connection</a></code> manually. Use <code><a href="../DB.html#open%28uri%3AURI%7CString%29-class-method">DB#open</a></code> or <code>Database#connection</code>.</p>
|
||
|
|
|
||
|
|
<p>Refer to <code><a href="../DB/QueryMethods.html">QueryMethods</a></code> for documentation about querying the database through this connection.</p>
|
||
|
|
|
||
|
|
<h3>Note to implementors</h3>
|
||
|
|
|
||
|
|
<p>The connection must be initialized in <code>#initialize</code> and closed in <code>#do_close</code>.</p>
|
||
|
|
|
||
|
|
<p>Override <code><a href="../DB/Connection.html#build_statement%28query%29%3AStatement-instance-method">#build_statement</a></code> method in order to return a prepared <code><a href="../DB/Statement.html">Statement</a></code> to allow querying.
|
||
|
|
See also <code><a href="../DB/Statement.html">Statement</a></code> to define how the statements are executed.</p>
|
||
|
|
|
||
|
|
<p>If at any give moment the connection is lost a DB::ConnectionLost should be raised. This will
|
||
|
|
allow the connection pool to try to reconnect or use another connection if available.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Included Modules</h2>
|
||
|
|
<ul class="other-types-list">
|
||
|
|
|
||
|
|
<li class="other-type"><a href="../DB/Disposable.html">DB::Disposable</a></li>
|
||
|
|
|
||
|
|
<li class="other-type"><a href="../DB/QueryMethods.html">DB::QueryMethods</a></li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Defined in:</h2>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/connection.cr#L20" target="_blank">db/connection.cr</a>
|
||
|
|
|
||
|
|
<br/>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Class Method Summary</h2>
|
||
|
|
<ul class="list-summary">
|
||
|
|
|
||
|
|
<li class="entry-summary">
|
||
|
|
<a href="#new%28database%3ADatabase%29-class-method" class="signature"><strong>.new</strong>(database : Database)</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Instance Method Summary</h2>
|
||
|
|
<ul class="list-summary">
|
||
|
|
|
||
|
|
<li class="entry-summary">
|
||
|
|
<a href="#build_statement%28query%29%3AStatement-instance-method" class="signature"><strong>#build_statement</strong>(query) : Statement</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="methods-inherited">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Instance methods inherited from module <code><a href="../DB/QueryMethods.html">DB::QueryMethods</a></code></h3>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="../DB/QueryMethods.html#exec%28query%2C%2Aargs%29-instance-method" class="tooltip">
|
||
|
|
<span>exec(query, *args)</span>
|
||
|
|
exec</a>,
|
||
|
|
|
||
|
|
|
||
|
|
<a href="../DB/QueryMethods.html#query%28query%2C%2Aargs%29-instance-method" class="tooltip">
|
||
|
|
<span>query(query, *args)<br/>query(query, *args, &block)</span>
|
||
|
|
query</a>,
|
||
|
|
|
||
|
|
|
||
|
|
<a href="../DB/QueryMethods.html#query_all%28query%2C%2Aargs%2C%26block%3AResultSet-%3EU%29%3AArray%28U%29-instance-method" class="tooltip">
|
||
|
|
<span>query_all(query, *args, &block : ResultSet -> U) : Array(U)<br/>query_all(query, *args, as types : Tuple)<br/>query_all(query, *args, as type : Class)</span>
|
||
|
|
query_all</a>,
|
||
|
|
|
||
|
|
|
||
|
|
<a href="../DB/QueryMethods.html#query_one%28query%2C%2Aargs%2C%26block%3AResultSet-%3EU%29%3AU-instance-method" class="tooltip">
|
||
|
|
<span>query_one(query, *args, &block : ResultSet -> U) : U<br/>query_one(query, *args, as types : Tuple)<br/>query_one(query, *args, as type : Class)</span>
|
||
|
|
query_one</a>,
|
||
|
|
|
||
|
|
|
||
|
|
<a href="../DB/QueryMethods.html#query_one%3F%28query%2C%2Aargs%2C%26block%3AResultSet-%3EU%29%3AU%3F-instance-method" class="tooltip">
|
||
|
|
<span>query_one?(query, *args, &block : ResultSet -> U) : U?<br/>query_one?(query, *args, as types : Tuple)<br/>query_one?(query, *args, as type : Class)</span>
|
||
|
|
query_one?</a>,
|
||
|
|
|
||
|
|
|
||
|
|
<a href="../DB/QueryMethods.html#scalar%28query%2C%2Aargs%29-instance-method" class="tooltip">
|
||
|
|
<span>scalar(query, *args)</span>
|
||
|
|
scalar</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Instance methods inherited from module <code><a href="../DB/Disposable.html">DB::Disposable</a></code></h3>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="../DB/Disposable.html#close-instance-method" class="tooltip">
|
||
|
|
<span>close</span>
|
||
|
|
close</a>,
|
||
|
|
|
||
|
|
|
||
|
|
<a href="../DB/Disposable.html#closed%3F-instance-method" class="tooltip">
|
||
|
|
<span>closed?</span>
|
||
|
|
closed?</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Class Method Detail</h2>
|
||
|
|
|
||
|
|
<div class="entry-detail" id="new(database:Database)-class-method">
|
||
|
|
<div class="signature">
|
||
|
|
|
||
|
|
def self.<strong>new</strong>(database : <a href="../DB/Database.html">Database</a>)
|
||
|
|
|
||
|
|
<a class="method-permalink" href="#new%28database%3ADatabase%29-class-method">#</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<br/>
|
||
|
|
<div>
|
||
|
|
|
||
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/connection.cr#L28" target="_blank">View source</a>]
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Instance Method Detail</h2>
|
||
|
|
|
||
|
|
<div class="entry-detail" id="build_statement(query):Statement-instance-method">
|
||
|
|
<div class="signature">
|
||
|
|
abstract
|
||
|
|
def <strong>build_statement</strong>(query) : <a href="../DB/Statement.html">Statement</a>
|
||
|
|
|
||
|
|
<a class="method-permalink" href="#build_statement%28query%29%3AStatement-instance-method">#</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<br/>
|
||
|
|
<div>
|
||
|
|
|
||
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/connection.cr#L36" target="_blank">View source</a>]
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|