mirror of
https://gitea.invidious.io/iv-org/shard-crystal-db.git
synced 2024-08-15 00:53:32 +00:00
829 lines
23 KiB
HTML
829 lines
23 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="generator" content="Crystal Docs 0.36.1">
|
|
<meta name="crystal_docs.project_version" content="0.10.1">
|
|
<meta name="crystal_docs.project_name" content="db">
|
|
|
|
|
|
|
|
<link href="../css/style.css" rel="stylesheet" type="text/css" />
|
|
<script type="text/javascript" src="../js/doc.js"></script>
|
|
|
|
<meta name="repository-name" content="db">
|
|
<title>DB::ResultSet - db 0.10.1</title>
|
|
<script type="text/javascript">
|
|
CrystalDocs.base_path = "../";
|
|
</script>
|
|
</head>
|
|
<body>
|
|
|
|
<svg class="hidden">
|
|
<symbol id="octicon-link" viewBox="0 0 16 16">
|
|
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
|
|
</symbol>
|
|
</svg>
|
|
<div class="sidebar">
|
|
<div class="sidebar-header">
|
|
<div class="search-box">
|
|
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
|
|
</div>
|
|
|
|
<div class="project-summary">
|
|
<h1 class="project-name">
|
|
<a href="../index.html">
|
|
db
|
|
</a>
|
|
</h1>
|
|
|
|
<span class="project-version">
|
|
0.10.1
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="search-results hidden">
|
|
<ul class="search-list"></ul>
|
|
</div>
|
|
|
|
<div class="types-list">
|
|
<ul>
|
|
|
|
<li class="parent open current" data-id="db/DB" data-name="db">
|
|
<a href="../DB.html">DB</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/Any" data-name="db::any">
|
|
<a href="../DB/Any.html">Any</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/BeginTransaction" data-name="db::begintransaction">
|
|
<a href="../DB/BeginTransaction.html">BeginTransaction</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Connection" data-name="db::connection">
|
|
<a href="../DB/Connection.html">Connection</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ConnectionContext" data-name="db::connectioncontext">
|
|
<a href="../DB/ConnectionContext.html">ConnectionContext</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ConnectionLost" data-name="db::connectionlost">
|
|
<a href="../DB/ConnectionLost.html">ConnectionLost</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ConnectionRefused" data-name="db::connectionrefused">
|
|
<a href="../DB/ConnectionRefused.html">ConnectionRefused</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Database" data-name="db::database">
|
|
<a href="../DB/Database.html">Database</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Disposable" data-name="db::disposable">
|
|
<a href="../DB/Disposable.html">Disposable</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Driver" data-name="db::driver">
|
|
<a href="../DB/Driver.html">Driver</a>
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="db/DB/DriverSpecs" data-name="db::driverspecs(dbanytype)">
|
|
<a href="../DB/DriverSpecs.html">DriverSpecs</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/DriverSpecs/ColumnDef" data-name="db::driverspecs::columndef">
|
|
<a href="../DB/DriverSpecs/ColumnDef.html">ColumnDef</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Error" data-name="db::error">
|
|
<a href="../DB/Error.html">Error</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ExecResult" data-name="db::execresult">
|
|
<a href="../DB/ExecResult.html">ExecResult</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Field" data-name="db::field">
|
|
<a href="../DB/Field.html">Field</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Mappable" data-name="db::mappable">
|
|
<a href="../DB/Mappable.html">Mappable</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/MappingException" data-name="db::mappingexception">
|
|
<a href="../DB/MappingException.html">MappingException</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/MetadataValueConverter" data-name="db::metadatavalueconverter">
|
|
<a href="../DB/MetadataValueConverter.html">MetadataValueConverter</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/NoResultsError" data-name="db::noresultserror">
|
|
<a href="../DB/NoResultsError.html">NoResultsError</a>
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="db/DB/Pool" data-name="db::pool(t)">
|
|
<a href="../DB/Pool.html">Pool</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/Pool/Stats" data-name="db::pool::stats">
|
|
<a href="../DB/Pool/Stats.html">Stats</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolPreparedStatement" data-name="db::poolpreparedstatement">
|
|
<a href="../DB/PoolPreparedStatement.html">PoolPreparedStatement</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolResourceLost" data-name="db::poolresourcelost(t)">
|
|
<a href="../DB/PoolResourceLost.html">PoolResourceLost</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolResourceRefused" data-name="db::poolresourcerefused">
|
|
<a href="../DB/PoolResourceRefused.html">PoolResourceRefused</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolRetryAttemptsExceeded" data-name="db::poolretryattemptsexceeded">
|
|
<a href="../DB/PoolRetryAttemptsExceeded.html">PoolRetryAttemptsExceeded</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolStatement" data-name="db::poolstatement">
|
|
<a href="../DB/PoolStatement.html">PoolStatement</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolTimeout" data-name="db::pooltimeout">
|
|
<a href="../DB/PoolTimeout.html">PoolTimeout</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolUnpreparedStatement" data-name="db::poolunpreparedstatement">
|
|
<a href="../DB/PoolUnpreparedStatement.html">PoolUnpreparedStatement</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/QueryMethods" data-name="db::querymethods(stmt)">
|
|
<a href="../DB/QueryMethods.html">QueryMethods</a>
|
|
|
|
</li>
|
|
|
|
<li class=" current" data-id="db/DB/ResultSet" data-name="db::resultset">
|
|
<a href="../DB/ResultSet.html">ResultSet</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Rollback" data-name="db::rollback">
|
|
<a href="../DB/Rollback.html">Rollback</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/SavePointTransaction" data-name="db::savepointtransaction">
|
|
<a href="../DB/SavePointTransaction.html">SavePointTransaction</a>
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="db/DB/Serializable" data-name="db::serializable">
|
|
<a href="../DB/Serializable.html">Serializable</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/Serializable/NonStrict" data-name="db::serializable::nonstrict">
|
|
<a href="../DB/Serializable/NonStrict.html">NonStrict</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="db/DB/SessionMethods" data-name="db::sessionmethods(session, stmt)">
|
|
<a href="../DB/SessionMethods.html">SessionMethods</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/SessionMethods/PreparedQuery" data-name="db::sessionmethods::preparedquery(session, stmt)">
|
|
<a href="../DB/SessionMethods/PreparedQuery.html">PreparedQuery</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/SessionMethods/UnpreparedQuery" data-name="db::sessionmethods::unpreparedquery(session, stmt)">
|
|
<a href="../DB/SessionMethods/UnpreparedQuery.html">UnpreparedQuery</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Statement" data-name="db::statement">
|
|
<a href="../DB/Statement.html">Statement</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/StatementMethods" data-name="db::statementmethods">
|
|
<a href="../DB/StatementMethods.html">StatementMethods</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/StringKeyCache" data-name="db::stringkeycache(t)">
|
|
<a href="../DB/StringKeyCache.html">StringKeyCache</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/TopLevelTransaction" data-name="db::topleveltransaction">
|
|
<a href="../DB/TopLevelTransaction.html">TopLevelTransaction</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Transaction" data-name="db::transaction">
|
|
<a href="../DB/Transaction.html">Transaction</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="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>
|
|
<a id="overview" class="anchor" href="#overview">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
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:Bool-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(&)-instance-method">#each</a></code> or <code><a href="../DB/ResultSet.html#move_next:Bool-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(query,*args_,args:Array?=nil)-instance-method">QueryMethods#query</a></code>.</p>
|
|
|
|
<h3><a id="note-to-implementors" class="anchor" href="#note-to-implementors">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>Note to implementors</h3>
|
|
|
|
<ol><li>Override <code><a href="../DB/ResultSet.html#move_next:Bool-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(type:DB::Mappable.class)-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:Int32-instance-method">#column_count</a></code>, <code><a href="../DB/ResultSet.html#column_name(index:Int32):String-instance-method">#column_name</a></code>.</li></ol>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="included-modules" class="anchor" href="#included-modules">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Included Modules
|
|
</h2>
|
|
<ul class="other-types-list">
|
|
|
|
<li class="other-type"><a href="../DB/Disposable.html">DB::Disposable</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="defined-in" class="anchor" href="#defined-in">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Defined in:
|
|
</h2>
|
|
|
|
|
|
<a href="https://github.com/crystal-lang/crystal-db/blob/v0.10.1/src/db/result_set.cr#L22" target="_blank">
|
|
db/result_set.cr
|
|
</a>
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="constructors" class="anchor" href="#constructors">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Constructors
|
|
</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#new(statement:DB::Statement)-class-method" class="signature"><strong>.new</strong>(statement : DB::Statement)</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="instance-method-summary" class="anchor" href="#instance-method-summary">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Instance Method Summary
|
|
</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#column_count:Int32-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(index:Int32):String-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(&)-instance-method" class="signature"><strong>#each</strong>(&)</a>
|
|
|
|
<div class="summary"><p>Iterates over all the rows</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#each_column(&)-instance-method" class="signature"><strong>#each_column</strong>(&)</a>
|
|
|
|
<div class="summary"><p>Iterates over all the columns</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#move_next:Bool-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(type:DB::Mappable.class)-instance-method" class="signature"><strong>#read</strong>(type : <span class="t">DB</span><span class="t">::</span><span class="t">Mappable</span>.<span class="k">class</span>)</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(type:T.class):TforallT-instance-method" class="signature"><strong>#read</strong>(type : <span class="t">T</span>.<span class="k">class</span>) : 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(*types:Class)-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>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#read(**types:Class)-instance-method" class="signature"><strong>#read</strong>(**types : Class)</a>
|
|
|
|
<div class="summary"><p>Reads the next columns and returns a named 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?-instance-method" class="tooltip">
|
|
<span>closed?</span>
|
|
closed?</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2>
|
|
<a id="constructor-detail" class="anchor" href="#constructor-detail">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Constructor 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(statement:DB::Statement)-class-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/v0.10.1/src/db/result_set.cr#L28" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="instance-method-detail" class="anchor" href="#instance-method-detail">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
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:Int32-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/v0.10.1/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(index:Int32):String-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/v0.10.1/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/v0.10.1/src/db/result_set.cr#L65" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="each(&)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>each</strong>(&)
|
|
|
|
<a class="method-permalink" href="#each(&)-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/v0.10.1/src/db/result_set.cr#L38" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="each_column(&)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>each_column</strong>(&)
|
|
|
|
<a class="method-permalink" href="#each_column(&)-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/v0.10.1/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:Bool-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(&)-instance-method">#each</a></code></p>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/v0.10.1/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 : <span class="t">DB</span><span class="t">::</span><span class="t">Mappable</span>.<span class="k">class</span>)
|
|
|
|
<a class="method-permalink" href="#read(type:DB::Mappable.class)-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/v0.10.1/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 : <span class="t">T</span>.<span class="k">class</span>) : T forall T
|
|
|
|
<a class="method-permalink" href="#read(type:T.class):TforallT-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/v0.10.1/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/v0.10.1/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(*types:Class)-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/v0.10.1/src/db/result_set.cr#L88" 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(**types:Class)-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc">
|
|
|
|
<p>Reads the next columns and returns a named tuple of the values.</p>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/v0.10.1/src/db/result_set.cr#L93" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|