mirror of
https://gitea.invidious.io/iv-org/shard-crystal-db.git
synced 2024-08-15 00:53:32 +00:00
550 lines
17 KiB
HTML
550 lines
17 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::ResultSet - 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=" " 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=" current" 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::ResultSet
|
|
|
|
</h1>
|
|
|
|
|
|
<ul class="superclass-hierarchy"><li class="superclass"><a href="../DB/ResultSet.html">DB::ResultSet</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
|
|
|
|
|
|
|
|
|
|
<h2>Overview</h2>
|
|
|
|
<p>The response of a query performed on a <code><a href="../DB/Database.html">Database</a></code>.</p>
|
|
|
|
<p>See <code><a href="../DB.html">DB</a></code> for a complete sample.</p>
|
|
|
|
<p>Each <code><a href="../DB/ResultSet.html#read-instance-method">#read</a></code> call consumes the result and moves to the next column.
|
|
Each column must be read in order.
|
|
At any moment a <code><a href="../DB/ResultSet.html#move_next%3ABool-instance-method">#move_next</a></code> can be invoked, meaning to skip the
|
|
remaining, or even all the columns, in the current row.
|
|
Also it is not mandatory to consume the whole <code><a href="../DB/ResultSet.html">ResultSet</a></code>, hence an iteration
|
|
through <code><a href="../DB/ResultSet.html#each%28%26block%29-instance-method">#each</a></code> or <code><a href="../DB/ResultSet.html#move_next%3ABool-instance-method">#move_next</a></code> can be stopped.</p>
|
|
|
|
<p><strong>Note:</strong> depending on how the <code><a href="../DB/ResultSet.html">ResultSet</a></code> was obtained it might be mandatory an
|
|
explicit call to <code>#close</code>. Check <code><a href="../DB/QueryMethods.html#query%28query%2C%2Aargs%29-instance-method">QueryMethods#query</a></code>.</p>
|
|
|
|
<h3>Note to implementors</h3>
|
|
|
|
<ol><li>Override <code><a href="../DB/ResultSet.html#move_next%3ABool-instance-method">#move_next</a></code> to move to the next row.</li><li>Override <code><a href="../DB/ResultSet.html#read-instance-method">#read</a></code> returning the next value in the row.</li><li>(Optional) Override <code><a href="../DB/ResultSet.html#read%28type%3ADB%3A%3AMappable.class%29-instance-method">#read(t)</a></code> for some types <code>t</code> for which custom logic other than a simple cast is needed.</li><li>Override <code><a href="../DB/ResultSet.html#column_count%3AInt32-instance-method">#column_count</a></code>, <code><a href="../DB/ResultSet.html#column_name%28index%3AInt32%29%3AString-instance-method">#column_name</a></code>.</li></ol>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Included Modules</h2>
|
|
<ul class="other-types-list">
|
|
|
|
<li class="other-type"><a href="../DB/Disposable.html">DB::Disposable</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Defined in:</h2>
|
|
|
|
|
|
<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L22" target="_blank">db/result_set.cr</a>
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Class Method Summary</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#new%28statement%3ADB%3A%3AStatement%29-class-method" class="signature"><strong>.new</strong>(statement : DB::Statement)</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#column_count%3AInt32-instance-method" class="signature"><strong>#column_count</strong> : Int32</a>
|
|
|
|
<div class="summary"><p>Returns the number of columns in the result</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#column_name%28index%3AInt32%29%3AString-instance-method" class="signature"><strong>#column_name</strong>(index : Int32) : String</a>
|
|
|
|
<div class="summary"><p>Returns the name of the column in <code>index</code> 0-based position.</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#column_names-instance-method" class="signature"><strong>#column_names</strong></a>
|
|
|
|
<div class="summary"><p>Returns the name of the columns.</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#each%28%26block%29-instance-method" class="signature"><strong>#each</strong>(&block)</a>
|
|
|
|
<div class="summary"><p>Iterates over all the rows</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#each_column%28%26block%29-instance-method" class="signature"><strong>#each_column</strong>(&block)</a>
|
|
|
|
<div class="summary"><p>Iterates over all the columns</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#move_next%3ABool-instance-method" class="signature"><strong>#move_next</strong> : Bool</a>
|
|
|
|
<div class="summary"><p>Move the next row in the result.</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#read%28type%3ADB%3A%3AMappable.class%29-instance-method" class="signature"><strong>#read</strong>(type : DB::Mappable.class)</a>
|
|
|
|
<div class="summary"><p>Reads the next columns and maps them to a class</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#read%28type%3AT.class%29%3ATforallT-instance-method" class="signature"><strong>#read</strong>(type : T.class) : T forall T</a>
|
|
|
|
<div class="summary"><p>Reads the next column value as a <strong>type</strong></p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#read-instance-method" class="signature"><strong>#read</strong></a>
|
|
|
|
<div class="summary"><p>Reads the next column value</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#read%28%2Atypes%3AClass%29-instance-method" class="signature"><strong>#read</strong>(*types : Class)</a>
|
|
|
|
<div class="summary"><p>Reads the next columns and returns a tuple of the values.</p></div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="methods-inherited">
|
|
|
|
|
|
|
|
<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(statement:DB::Statement)-class-method">
|
|
<div class="signature">
|
|
|
|
def self.<strong>new</strong>(statement : <a href="../DB/Statement.html">DB::Statement</a>)
|
|
|
|
<a class="method-permalink" href="#new%28statement%3ADB%3A%3AStatement%29-class-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L28" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h2>Instance Method Detail</h2>
|
|
|
|
<div class="entry-detail" id="column_count:Int32-instance-method">
|
|
<div class="signature">
|
|
abstract
|
|
def <strong>column_count</strong> : Int32
|
|
|
|
<a class="method-permalink" href="#column_count%3AInt32-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Returns the number of columns in the result</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L59" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="column_name(index:Int32):String-instance-method">
|
|
<div class="signature">
|
|
abstract
|
|
def <strong>column_name</strong>(index : Int32) : String
|
|
|
|
<a class="method-permalink" href="#column_name%28index%3AInt32%29%3AString-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Returns the name of the column in <code>index</code> 0-based position.</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L62" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="column_names-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>column_names</strong>
|
|
|
|
<a class="method-permalink" href="#column_names-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Returns the name of the columns.</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L65" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="each(&block)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>each</strong>(&block)
|
|
|
|
<a class="method-permalink" href="#each%28%26block%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Iterates over all the rows</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L38" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="each_column(&block)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>each_column</strong>(&block)
|
|
|
|
<a class="method-permalink" href="#each_column%28%26block%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Iterates over all the columns</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L45" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="move_next:Bool-instance-method">
|
|
<div class="signature">
|
|
abstract
|
|
def <strong>move_next</strong> : Bool
|
|
|
|
<a class="method-permalink" href="#move_next%3ABool-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Move the next row in the result.
|
|
Return <code>false</code> if no more rows are available.
|
|
See <code><a href="../DB/ResultSet.html#each%28%26block%29-instance-method">#each</a></code></p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L54" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="read(type:DB::Mappable.class)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>read</strong>(type : DB::Mappable.class)
|
|
|
|
<a class="method-permalink" href="#read%28type%3ADB%3A%3AMappable.class%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Reads the next columns and maps them to a class</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L73" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="read(type:T.class):TforallT-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>read</strong>(type : T.class) : T forall T
|
|
|
|
<a class="method-permalink" href="#read%28type%3AT.class%29%3ATforallT-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Reads the next column value as a <strong>type</strong></p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L78" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="read-instance-method">
|
|
<div class="signature">
|
|
abstract
|
|
def <strong>read</strong>
|
|
|
|
<a class="method-permalink" href="#read-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Reads the next column value</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L70" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="read(*types:Class)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>read</strong>(*types : Class)
|
|
|
|
<a class="method-permalink" href="#read%28%2Atypes%3AClass%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>Reads the next columns and returns a tuple of the values.</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/73108c169ec87d229c7b92d793748d9796d20802/src/db/result_set.cr#L83" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|