mirror of
https://gitea.invidious.io/iv-org/shard-crystal-db.git
synced 2024-08-15 00:53:32 +00:00
713 lines
20 KiB
HTML
713 lines
20 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.34.0">
|
|
<meta name="crystal_docs.project_version" content="0.9.0">
|
|
<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>
|
|
|
|
<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="db">
|
|
<title>DB::Connection - db 0.9.0</title>
|
|
<script type="text/javascript">
|
|
CrystalDocs.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="project-summary">
|
|
<h1 class="project-name">
|
|
<a href="../index.html">
|
|
db
|
|
</a>
|
|
</h1>
|
|
|
|
<span class="project-version">
|
|
0.9.0
|
|
</span>
|
|
</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="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=" current" 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/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>
|
|
|
|
<li class=" " data-id="db/DB/Pool/TimeoutHelper" data-name="db::pool::timeouthelper">
|
|
<a href="../DB/Pool/TimeoutHelper.html">TimeoutHelper</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/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=" " 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::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>
|
|
<a id="overview" class="anchor" href="#overview">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
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(uri:URI%7CString)-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><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>
|
|
|
|
<p>The connection must be initialized in <code>#initialize</code> and closed in <code>#do_close</code>.</p>
|
|
|
|
<p>Override <code>#build_prepared_statement</code> method in order to return a prepared <code><a href="../DB/Statement.html">Statement</a></code> to allow querying.
|
|
Override <code>#build_unprepared_statement</code> method in order to return a unprepared <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>
|
|
<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/BeginTransaction.html">DB::BeginTransaction</a></li>
|
|
|
|
<li class="other-type"><a href="../DB/Disposable.html">DB::Disposable</a></li>
|
|
|
|
<li class="other-type"><a href="../DB/SessionMethods.html">DB::SessionMethods</a>(<a href="../DB/Connection.html">DB::Connection</a>, <a href="../DB/Statement.html">DB::Statement</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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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(context:ConnectionContext)-class-method" class="signature"><strong>.new</strong>(context : ConnectionContext)</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="#begin_transaction:Transaction-instance-method" class="signature"><strong>#begin_transaction</strong> : Transaction</a>
|
|
|
|
<div class="summary"><p>Creates a transaction from the current context.</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="#release-instance-method" class="signature"><strong>#release</strong></a>
|
|
|
|
<div class="summary"><p>return this connection to the pool managed by the database.</p></div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="methods-inherited">
|
|
|
|
|
|
|
|
<h3>Instance methods inherited from module <code><a href="../DB/BeginTransaction.html">DB::BeginTransaction</a></code></h3>
|
|
|
|
|
|
<a href="../DB/BeginTransaction.html#begin_transaction:Transaction-instance-method" class="tooltip">
|
|
<span>begin_transaction : Transaction</span>
|
|
begin_transaction</a>,
|
|
|
|
|
|
<a href="../DB/BeginTransaction.html#transaction(&)-instance-method" class="tooltip">
|
|
<span>transaction(&)</span>
|
|
transaction</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Instance methods inherited from module <code><a href="../DB/SessionMethods.html">DB::SessionMethods</a>(<a href="../DB/Connection.html">DB::Connection</a>, <a href="../DB/Statement.html">DB::Statement</a>)</code></h3>
|
|
|
|
|
|
<a href="../DB/SessionMethods.html#build(query):Stmt-instance-method" class="tooltip">
|
|
<span>build(query) : Stmt</span>
|
|
build</a>,
|
|
|
|
|
|
<a href="../DB/SessionMethods.html#build_unprepared_statement(query):Stmt-instance-method" class="tooltip">
|
|
<span>build_unprepared_statement(query) : Stmt</span>
|
|
build_unprepared_statement</a>,
|
|
|
|
|
|
<a href="../DB/SessionMethods.html#fetch_or_build_prepared_statement(query):Stmt-instance-method" class="tooltip">
|
|
<span>fetch_or_build_prepared_statement(query) : Stmt</span>
|
|
fetch_or_build_prepared_statement</a>,
|
|
|
|
|
|
<a href="../DB/SessionMethods.html#prepared(query)-instance-method" class="tooltip">
|
|
<span>prepared(query)<br/>prepared</span>
|
|
prepared</a>,
|
|
|
|
|
|
<a href="../DB/SessionMethods.html#prepared_statements?:Bool-instance-method" class="tooltip">
|
|
<span>prepared_statements? : Bool</span>
|
|
prepared_statements?</a>,
|
|
|
|
|
|
<a href="../DB/SessionMethods.html#unprepared(query)-instance-method" class="tooltip">
|
|
<span>unprepared(query)<br/>unprepared</span>
|
|
unprepared</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Instance methods inherited from module <code><a href="../DB/QueryMethods.html">DB::QueryMethods</a>(<a href="../DB/Statement.html">DB::Statement</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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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(context:ConnectionContext)-class-method">
|
|
<div class="signature">
|
|
|
|
def self.<strong>new</strong>(context : <a href="../DB/ConnectionContext.html">ConnectionContext</a>)
|
|
|
|
<a class="method-permalink" href="#new(context:ConnectionContext)-class-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</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="begin_transaction:Transaction-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>begin_transaction</strong> : <a href="../DB/Transaction.html">Transaction</a>
|
|
|
|
<a class="method-permalink" href="#begin_transaction:Transaction-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc">
|
|
|
|
<div class="doc-inherited">
|
|
Description copied from module <a href="../DB/BeginTransaction.html">DB::BeginTransaction</a>
|
|
</div>
|
|
|
|
<p>Creates a transaction from the current context.
|
|
If is expected that either <code><a href="../DB/Transaction.html#commit-instance-method">Transaction#commit</a></code> or <code><a href="../DB/Transaction.html#rollback-instance-method">Transaction#rollback</a></code>
|
|
are called explicitly to release the context.</p>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="prepared_statements?:Bool-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>prepared_statements?</strong> : Bool
|
|
|
|
<a class="method-permalink" href="#prepared_statements?:Bool-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc">
|
|
|
|
<div class="doc-inherited">
|
|
Description copied from module <a href="../DB/SessionMethods.html">DB::SessionMethods</a>(<a href="../DB/Connection.html">DB::Connection</a>, <a href="../DB/Statement.html">DB::Statement</a>)
|
|
</div>
|
|
|
|
<p>Returns whether by default the statements should
|
|
be prepared or not.</p>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="release-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>release</strong>
|
|
|
|
<a class="method-permalink" href="#release-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc">
|
|
|
|
<p>return this connection to the pool
|
|
managed by the database. Should be used
|
|
only if the connection was obtained by <code><a href="../DB/Database.html#checkout-instance-method">Database#checkout</a></code>.</p>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|