565 lines
17 KiB
HTML
565 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<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::Statement - 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/BeginTransaction" data-name="db::begintransaction">
|
|
<a href="../DB/BeginTransaction.html">BeginTransaction</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/ConnectionContext" data-name="db::connectioncontext">
|
|
<a href="../DB/ConnectionContext.html">ConnectionContext</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/ConnectionRefused" data-name="db::connectionrefused">
|
|
<a href="../DB/ConnectionRefused.html">ConnectionRefused</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="parent " data-id="github.com/crystal-lang/crystal-db/DB/DriverSpecs" data-name="db::driverspecs(dbanytype)">
|
|
<a href="../DB/DriverSpecs.html">DriverSpecs</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/DriverSpecs/ColumnDef" data-name="db::driverspecs::columndef">
|
|
<a href="../DB/DriverSpecs/ColumnDef.html">ColumnDef</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</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/PoolPreparedStatement" data-name="db::poolpreparedstatement">
|
|
<a href="../DB/PoolPreparedStatement.html">PoolPreparedStatement</a>
|
|
|
|
</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/PoolUnpreparedStatement" data-name="db::poolunpreparedstatement">
|
|
<a href="../DB/PoolUnpreparedStatement.html">PoolUnpreparedStatement</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/Rollback" data-name="db::rollback">
|
|
<a href="../DB/Rollback.html">Rollback</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/SavePointTransaction" data-name="db::savepointtransaction">
|
|
<a href="../DB/SavePointTransaction.html">SavePointTransaction</a>
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="github.com/crystal-lang/crystal-db/DB/SessionMethods" data-name="db::sessionmethods(session, stmt)">
|
|
<a href="../DB/SessionMethods.html">SessionMethods</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/SessionMethods/PreparedQuery" data-name="db::sessionmethods::preparedquery(session, stmt)">
|
|
<a href="../DB/SessionMethods/PreparedQuery.html">PreparedQuery</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/SessionMethods/UnpreparedQuery" data-name="db::sessionmethods::unpreparedquery(session, stmt)">
|
|
<a href="../DB/SessionMethods/UnpreparedQuery.html">UnpreparedQuery</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class=" current" 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>
|
|
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/TopLevelTransaction" data-name="db::topleveltransaction">
|
|
<a href="../DB/TopLevelTransaction.html">TopLevelTransaction</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Transaction" data-name="db::transaction">
|
|
<a href="../DB/Transaction.html">Transaction</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="main-content">
|
|
<h1 class="type-name">
|
|
|
|
<span class="kind">abstract class</span> DB::Statement
|
|
|
|
</h1>
|
|
|
|
|
|
<ul class="superclass-hierarchy"><li class="superclass"><a href="../DB/Statement.html">DB::Statement</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
|
|
|
|
|
|
|
|
|
|
<h2>Overview</h2>
|
|
|
|
<p>Represents a query in a <code><a href="../DB/Connection.html">Connection</a></code>.
|
|
It should be created by <code><a href="../DB/QueryMethods.html">QueryMethods</a></code>.</p>
|
|
|
|
<h3>Note to implementors</h3>
|
|
|
|
<ol><li>Subclass <code>Statements</code></li><li><code>Statements</code> are created from a custom driver <code>Connection#prepare</code> method.</li><li><code>#perform_query</code> executes a query that is expected to return a <code><a href="../DB/ResultSet.html">ResultSet</a></code></li><li><code>#perform_exec</code> executes a query that is expected to return an <code><a href="../DB/ExecResult.html">ExecResult</a></code></li><li><code>#do_close</code> is called to release the statement resources.</li></ol>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Included Modules</h2>
|
|
<ul class="other-types-list">
|
|
|
|
<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/28c6f3b715f0c82d2a37106fd5a55882a238cc1f/src/db/statement.cr#L52" target="_blank">db/statement.cr</a>
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Class Method Summary</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#new%28connection%3AConnection%29-class-method" class="signature"><strong>.new</strong>(connection : Connection)</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#exec%28args%3AArray%29-instance-method" class="signature"><strong>#exec</strong>(args : Array)</a>
|
|
|
|
<div class="summary"><p>See <code><a href="../DB/QueryMethods.html#exec%28query%2C%2Aargs%29-instance-method">QueryMethods#exec</a></code></p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#exec-instance-method" class="signature"><strong>#exec</strong></a>
|
|
|
|
<div class="summary"><p>See <code><a href="../DB/QueryMethods.html#exec%28query%2C%2Aargs%29-instance-method">QueryMethods#exec</a></code></p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#exec%28%2Aargs%29-instance-method" class="signature"><strong>#exec</strong>(*args)</a>
|
|
|
|
<div class="summary"><p>See <code><a href="../DB/QueryMethods.html#exec%28query%2C%2Aargs%29-instance-method">QueryMethods#exec</a></code></p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#query%28args%3AArray%29-instance-method" class="signature"><strong>#query</strong>(args : Array)</a>
|
|
|
|
<div class="summary"><p>See <code><a href="../DB/QueryMethods.html#query%28query%2C%2Aargs%29-instance-method">QueryMethods#query</a></code></p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#query-instance-method" class="signature"><strong>#query</strong></a>
|
|
|
|
<div class="summary"><p>See <code><a href="../DB/QueryMethods.html#query%28query%2C%2Aargs%29-instance-method">QueryMethods#query</a></code></p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#query%28%2Aargs%29-instance-method" class="signature"><strong>#query</strong>(*args)</a>
|
|
|
|
<div class="summary"><p>See <code><a href="../DB/QueryMethods.html#query%28query%2C%2Aargs%29-instance-method">QueryMethods#query</a></code></p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#release_connection-instance-method" class="signature"><strong>#release_connection</strong></a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="methods-inherited">
|
|
|
|
|
|
|
|
<h3>Instance methods inherited from module <code><a href="../DB/StatementMethods.html">DB::StatementMethods</a></code></h3>
|
|
|
|
|
|
<a href="../DB/StatementMethods.html#exec%28args%3AArray%29%3AExecResult-instance-method" class="tooltip">
|
|
<span>exec(args : Array) : ExecResult<br/>exec : ExecResult<br/>exec(*args) : ExecResult</span>
|
|
exec</a>,
|
|
|
|
|
|
<a href="../DB/StatementMethods.html#query%28%2Aargs%2C%26block%29-instance-method" class="tooltip">
|
|
<span>query(*args, &block)<br/>query(args : Array) : ResultSet<br/>query : ResultSet<br/>query(*args) : ResultSet</span>
|
|
query</a>,
|
|
|
|
|
|
<a href="../DB/StatementMethods.html#scalar%28%2Aargs%29-instance-method" class="tooltip">
|
|
<span>scalar(*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(connection:Connection)-class-method">
|
|
<div class="signature">
|
|
|
|
def self.<strong>new</strong>(connection : <a href="../DB/Connection.html">Connection</a>)
|
|
|
|
<a class="method-permalink" href="#new%28connection%3AConnection%29-class-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/28c6f3b715f0c82d2a37106fd5a55882a238cc1f/src/db/statement.cr#L58" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h2>Instance Method Detail</h2>
|
|
|
|
<div class="entry-detail" id="exec(args:Array)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>exec</strong>(args : Array)
|
|
|
|
<a class="method-permalink" href="#exec%28args%3AArray%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>See <code><a href="../DB/QueryMethods.html#exec%28query%2C%2Aargs%29-instance-method">QueryMethods#exec</a></code></p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/28c6f3b715f0c82d2a37106fd5a55882a238cc1f/src/db/statement.cr#L71" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="exec-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>exec</strong>
|
|
|
|
<a class="method-permalink" href="#exec-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>See <code><a href="../DB/QueryMethods.html#exec%28query%2C%2Aargs%29-instance-method">QueryMethods#exec</a></code></p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/28c6f3b715f0c82d2a37106fd5a55882a238cc1f/src/db/statement.cr#L66" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="exec(*args)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>exec</strong>(*args)
|
|
|
|
<a class="method-permalink" href="#exec%28%2Aargs%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>See <code><a href="../DB/QueryMethods.html#exec%28query%2C%2Aargs%29-instance-method">QueryMethods#exec</a></code></p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/28c6f3b715f0c82d2a37106fd5a55882a238cc1f/src/db/statement.cr#L76" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="query(args:Array)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>query</strong>(args : Array)
|
|
|
|
<a class="method-permalink" href="#query%28args%3AArray%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>See <code><a href="../DB/QueryMethods.html#query%28query%2C%2Aargs%29-instance-method">QueryMethods#query</a></code></p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/28c6f3b715f0c82d2a37106fd5a55882a238cc1f/src/db/statement.cr#L87" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="query-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>query</strong>
|
|
|
|
<a class="method-permalink" href="#query-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>See <code><a href="../DB/QueryMethods.html#query%28query%2C%2Aargs%29-instance-method">QueryMethods#query</a></code></p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/28c6f3b715f0c82d2a37106fd5a55882a238cc1f/src/db/statement.cr#L82" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="query(*args)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>query</strong>(*args)
|
|
|
|
<a class="method-permalink" href="#query%28%2Aargs%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>See <code><a href="../DB/QueryMethods.html#query%28query%2C%2Aargs%29-instance-method">QueryMethods#query</a></code></p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/28c6f3b715f0c82d2a37106fd5a55882a238cc1f/src/db/statement.cr#L92" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="release_connection-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>release_connection</strong>
|
|
|
|
<a class="method-permalink" href="#release_connection-instance-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/28c6f3b715f0c82d2a37106fd5a55882a238cc1f/src/db/statement.cr#L61" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|