shard-crystal-db/api/0.8.0/DB/SessionMethods.html
2019-12-11 17:40:10 -03:00

673 lines
22 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.31.1">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<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>
<meta id="repository-name" content="github.com/crystal-lang/crystal-db">
<title>DB::SessionMethods(Session, Stmt) - github.com/crystal-lang/crystal-db</title>
<script type="text/javascript">
CrystalDoc.base_path = "../";
</script>
</head>
<body>
<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="repository-links">
<a href="../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<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/Field" data-name="db::field">
<a href="../DB/Field.html">Field</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/Stats" data-name="db::pool::stats">
<a href="../DB/Pool/Stats.html">Stats</a>
</li>
<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(stmt)">
<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/Serializable" data-name="db::serializable">
<a href="../DB/Serializable.html">Serializable</a>
<ul>
<li class=" " data-id="github.com/crystal-lang/crystal-db/DB/Serializable/NonStrict" data-name="db::serializable::nonstrict">
<a href="../DB/Serializable/NonStrict.html">NonStrict</a>
</li>
</ul>
</li>
<li class="parent open current" 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=" " 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>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> DB::SessionMethods(Session, Stmt)
</h1>
<h2>
<a id="overview" class="anchor" href="#overview">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Overview
</h2>
<p>Methods that are shared accross session like objects:</p>
<ul><li>Database</li><li>Connection</li></ul></ul>
<p>Classes that includes this module are able to execute
queries and statements in both prepared and unprepared fashion.</p>
<p>This module serves for dsl reuse over session like objects.</p>
<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/QueryMethods.html">DB::QueryMethods(Stmt)</a></li>
</ul>
<h2>
<a id="direct-including-types" class="anchor" href="#direct-including-types">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
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/Database.html">DB::Database</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/7e83f8e26c2f9a5cde0693007b1c1486d00f7685/src/db/session_methods.cr#L10" target="_blank">
db/session_methods.cr
</a>
<br/>
<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="#build(query):Stmt-instance-method" class="signature"><strong>#build</strong>(query) : Stmt</a>
<div class="summary"><p>:nodoc:</p></div>
</li>
<li class="entry-summary">
<a href="#build_unprepared_statement(query):Stmt-instance-method" class="signature"><strong>#build_unprepared_statement</strong>(query) : Stmt</a>
</li>
<li class="entry-summary">
<a href="#fetch_or_build_prepared_statement(query):Stmt-instance-method" class="signature"><strong>#fetch_or_build_prepared_statement</strong>(query) : Stmt</a>
</li>
<li class="entry-summary">
<a href="#prepared(query)-instance-method" class="signature"><strong>#prepared</strong>(query)</a>
<div class="summary"><p>Returns a prepared <code><a href="../DB/Statement.html">Statement</a></code> that has not been executed yet.</p></div>
</li>
<li class="entry-summary">
<a href="#prepared-instance-method" class="signature"><strong>#prepared</strong></a>
<div class="summary"><p>dsl helper to build prepared statements returns a value that includes <code><a href="../DB/QueryMethods.html">QueryMethods</a></code></p></div>
</li>
<li class="entry-summary">
<a href="#prepared_statements?:Bool-instance-method" class="signature"><strong>#prepared_statements?</strong> : Bool</a>
<div class="summary"><p>Returns whether by default the statements should be prepared or not.</p></div>
</li>
<li class="entry-summary">
<a href="#unprepared(query)-instance-method" class="signature"><strong>#unprepared</strong>(query)</a>
<div class="summary"><p>Returns an unprepared <code><a href="../DB/Statement.html">Statement</a></code> that has not been executed yet.</p></div>
</li>
<li class="entry-summary">
<a href="#unprepared-instance-method" class="signature"><strong>#unprepared</strong></a>
<div class="summary"><p>dsl helper to build unprepared statements returns a value that includes <code><a href="../DB/QueryMethods.html">QueryMethods</a></code></p></div>
</li>
</ul>
<div class="methods-inherited">
<h3>Instance methods inherited from module <code><a href="../DB/QueryMethods.html">DB::QueryMethods(Stmt)</a></code></h3>
<a href="../DB/QueryMethods.html#exec(query,*args_,args:Array?=nil)-instance-method" class="tooltip">
<span>exec(query, *args_, args : Array? = <span class="n">nil</span>)</span>
exec</a>,
<a href="../DB/QueryMethods.html#query(query,*args_,args:Array?=nil)-instance-method" class="tooltip">
<span>query(query, *args_, args : Array? = <span class="n">nil</span>)<br/>query(query, *args_, args : Array? = <span class="n">nil</span>, &)</span>
query</a>,
<a href="../DB/QueryMethods.html#query_all(query,*args_,args:Array?=nil,astype:Class)-instance-method" class="tooltip">
<span>query_all(query, *args_, args : Array? = <span class="n">nil</span>, as type : Class)<br/>query_all(query, *args_, args : Array? = <span class="n">nil</span>, as types : NamedTuple)<br/>query_all(query, *args_, args : Array? = <span class="n">nil</span>, &block : ResultSet -> U) : Array(U) forall U<br/>query_all(query, *args_, args : Array? = <span class="n">nil</span>, as types : Tuple)</span>
query_all</a>,
<a href="../DB/QueryMethods.html#query_each(query,*args_,args:Array?=nil,&)-instance-method" class="tooltip">
<span>query_each(query, *args_, args : Array? = <span class="n">nil</span>, &)</span>
query_each</a>,
<a href="../DB/QueryMethods.html#query_one(query,*args_,args:Array?=nil,&block:ResultSet-%3EU):UforallU-instance-method" class="tooltip">
<span>query_one(query, *args_, args : Array? = <span class="n">nil</span>, &block : ResultSet -> U) : U forall U<br/>query_one(query, *args_, args : Array? = <span class="n">nil</span>, as types : Tuple)<br/>query_one(query, *args_, args : Array? = <span class="n">nil</span>, as types : NamedTuple)<br/>query_one(query, *args_, args : Array? = <span class="n">nil</span>, as type : Class)</span>
query_one</a>,
<a href="../DB/QueryMethods.html#query_one?(query,*args_,args:Array?=nil,astype:Class)-instance-method" class="tooltip">
<span>query_one?(query, *args_, args : Array? = <span class="n">nil</span>, as type : Class)<br/>query_one?(query, *args_, args : Array? = <span class="n">nil</span>, as types : NamedTuple)<br/>query_one?(query, *args_, args : Array? = <span class="n">nil</span>, as types : Tuple)<br/>query_one?(query, *args_, args : Array? = <span class="n">nil</span>, &block : ResultSet -> U) : U? forall U</span>
query_one?</a>,
<a href="../DB/QueryMethods.html#scalar(query,*args_,args:Array?=nil)-instance-method" class="tooltip">
<span>scalar(query, *args_, args : Array? = <span class="n">nil</span>)</span>
scalar</a>
</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="build(query):Stmt-instance-method">
<div class="signature">
def <strong>build</strong>(query) : Stmt
<a class="method-permalink" href="#build(query):Stmt-instance-method">#</a>
</div>
<div class="doc">
<div class="doc-inherited">
Description copied from module <a href="../DB/QueryMethods.html">DB::QueryMethods(Stmt)</a>
</div>
<p>:nodoc:</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/7e83f8e26c2f9a5cde0693007b1c1486d00f7685/src/db/session_methods.cr#L21" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="build_unprepared_statement(query):Stmt-instance-method">
<div class="signature">
abstract
def <strong>build_unprepared_statement</strong>(query) : Stmt
<a class="method-permalink" href="#build_unprepared_statement(query):Stmt-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/7e83f8e26c2f9a5cde0693007b1c1486d00f7685/src/db/session_methods.cr#L19" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="fetch_or_build_prepared_statement(query):Stmt-instance-method">
<div class="signature">
abstract
def <strong>fetch_or_build_prepared_statement</strong>(query) : Stmt
<a class="method-permalink" href="#fetch_or_build_prepared_statement(query):Stmt-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/7e83f8e26c2f9a5cde0693007b1c1486d00f7685/src/db/session_methods.cr#L17" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="prepared(query)-instance-method">
<div class="signature">
def <strong>prepared</strong>(query)
<a class="method-permalink" href="#prepared(query)-instance-method">#</a>
</div>
<div class="doc">
<p>Returns a prepared <code><a href="../DB/Statement.html">Statement</a></code> that has not been executed yet.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/7e83f8e26c2f9a5cde0693007b1c1486d00f7685/src/db/session_methods.cr#L36" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="prepared-instance-method">
<div class="signature">
def <strong>prepared</strong>
<a class="method-permalink" href="#prepared-instance-method">#</a>
</div>
<div class="doc">
<p>dsl helper to build prepared statements
returns a value that includes <code><a href="../DB/QueryMethods.html">QueryMethods</a></code></p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/7e83f8e26c2f9a5cde0693007b1c1486d00f7685/src/db/session_methods.cr#L31" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="prepared_statements?:Bool-instance-method">
<div class="signature">
abstract
def <strong>prepared_statements?</strong> : Bool
<a class="method-permalink" href="#prepared_statements?:Bool-instance-method">#</a>
</div>
<div class="doc">
<p>Returns whether by default the statements should
be prepared or not.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/7e83f8e26c2f9a5cde0693007b1c1486d00f7685/src/db/session_methods.cr#L15" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="unprepared(query)-instance-method">
<div class="signature">
def <strong>unprepared</strong>(query)
<a class="method-permalink" href="#unprepared(query)-instance-method">#</a>
</div>
<div class="doc">
<p>Returns an unprepared <code><a href="../DB/Statement.html">Statement</a></code> that has not been executed yet.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/7e83f8e26c2f9a5cde0693007b1c1486d00f7685/src/db/session_methods.cr#L47" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="unprepared-instance-method">
<div class="signature">
def <strong>unprepared</strong>
<a class="method-permalink" href="#unprepared-instance-method">#</a>
</div>
<div class="doc">
<p>dsl helper to build unprepared statements
returns a value that includes <code><a href="../DB/QueryMethods.html">QueryMethods</a></code></p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/7e83f8e26c2f9a5cde0693007b1c1486d00f7685/src/db/session_methods.cr#L42" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>