mirror of
https://gitea.invidious.io/iv-org/shard-crystal-db.git
synced 2024-08-15 00:53:32 +00:00
452 lines
13 KiB
HTML
452 lines
13 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::Transaction - 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=" " 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=" " 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=" current" 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::Transaction
|
|
|
|
</h1>
|
|
|
|
|
|
<ul class="superclass-hierarchy"><li class="superclass"><a href="../DB/Transaction.html">DB::Transaction</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
|
|
|
|
|
|
|
|
|
|
<h2>Overview</h2>
|
|
|
|
<p>Transactions should be started from <code>DB#transaction</code>, <code>Connection#transaction</code>
|
|
or <code><a href="../DB/Connection.html#begin_transaction-instance-method">Connection#begin_transaction</a></code>.</p>
|
|
|
|
<p>Use <code><a href="../DB/Transaction.html#connection%3AConnection-instance-method">Transaction#connection</a></code> to submit statements to the database.</p>
|
|
|
|
<p>Use <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> to close the ongoing transaction
|
|
explicitly. Or refer to <code><a href="../DB/BeginTransaction.html#transaction%28%26block%29-instance-method">BeginTransaction#transaction</a></code> for documentation on how to
|
|
use <code>#transaction(&block)</code> methods in <code><a href="../DB.html">DB</a></code> and <code><a href="../DB/Connection.html">Connection</a></code>.</p>
|
|
|
|
<p>Nested transactions are supported by using sql <code>SAVEPOINT</code>. To start a nested
|
|
transaction use <code>Transaction#transaction</code> or <code>Transaction#begin_transaction</code>.</p>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>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>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Direct Known Subclasses</h2>
|
|
<ul class="other-types-list">
|
|
|
|
<li class="other-type"><a href="../DB/SavePointTransaction.html">DB::SavePointTransaction</a></li>
|
|
|
|
<li class="other-type"><a href="../DB/TopLevelTransaction.html">DB::TopLevelTransaction</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Defined in:</h2>
|
|
|
|
|
|
<a href="https://github.com/crystal-lang/crystal-db/blob/545d758ae0e8ff107c3fcb62445cda7b38c0fd72/src/db/transaction.cr#L14" target="_blank">db/transaction.cr</a>
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#commit-instance-method" class="signature"><strong>#commit</strong></a>
|
|
|
|
<div class="summary"><p>commits the current transaction</p></div>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#connection%3AConnection-instance-method" class="signature"><strong>#connection</strong> : Connection</a>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#release_from_nested_transaction-instance-method" class="signature"><strong>#release_from_nested_transaction</strong></a>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#rollback-instance-method" class="signature"><strong>#rollback</strong></a>
|
|
|
|
<div class="summary"><p>rollbacks the current transaction</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%3ATransaction-instance-method" class="tooltip">
|
|
<span>begin_transaction : Transaction</span>
|
|
begin_transaction</a>,
|
|
|
|
|
|
<a href="../DB/BeginTransaction.html#transaction%28%26block%29-instance-method" class="tooltip">
|
|
<span>transaction(&block)</span>
|
|
transaction</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>Instance Method Detail</h2>
|
|
|
|
<div class="entry-detail" id="commit-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>commit</strong>
|
|
|
|
<a class="method-permalink" href="#commit-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>commits the current transaction</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/545d758ae0e8ff107c3fcb62445cda7b38c0fd72/src/db/transaction.cr#L21" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="connection:Connection-instance-method">
|
|
<div class="signature">
|
|
abstract
|
|
def <strong>connection</strong> : <a href="../DB/Connection.html">Connection</a>
|
|
|
|
<a class="method-permalink" href="#connection%3AConnection-instance-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/545d758ae0e8ff107c3fcb62445cda7b38c0fd72/src/db/transaction.cr#L18" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="release_from_nested_transaction-instance-method">
|
|
<div class="signature">
|
|
abstract
|
|
def <strong>release_from_nested_transaction</strong>
|
|
|
|
<a class="method-permalink" href="#release_from_nested_transaction-instance-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/545d758ae0e8ff107c3fcb62445cda7b38c0fd72/src/db/transaction.cr#L35" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="rollback-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>rollback</strong>
|
|
|
|
<a class="method-permalink" href="#rollback-instance-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc"><p>rollbacks the current transaction</p></div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/545d758ae0e8ff107c3fcb62445cda7b38c0fd72/src/db/transaction.cr#L26" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|