iv-org-mirror/shard-crystal-db
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-crystal-db.git synced 2024-08-15 00:53:32 +00:00
Code Issues Projects Releases Packages Wiki Activity
shard-crystal-db/api/0.13.1/DB/TopLevelTransaction.html

688 lines
18 KiB
HTML
Raw Permalink Normal View History

publishing docs for 0.13.1
2023-12-21 12:54:13 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Crystal Docs 1.5.1">
<meta name="crystal_docs.project_version" content="0.13.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::TopLevelTransaction - db 0.13.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="currentColor" 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>
<input type="checkbox" id="sidebar-btn">
<label for="sidebar-btn" id="sidebar-btn-label">
<svg class="open" xmlns="http://www.w3.org/2000/svg" height="2em" width="2em" viewBox="0 0 512 512"><title>Open Sidebar</title><path fill="currentColor" d="M80 96v64h352V96H80zm0 112v64h352v-64H80zm0 112v64h352v-64H80z"></path></svg>
<svg class="close" xmlns="http://www.w3.org/2000/svg" width="2em" height="2em" viewBox="0 0 512 512"><title>Close Sidebar</title><path fill="currentColor" d="m118.6 73.4-45.2 45.2L210.7 256 73.4 393.4l45.2 45.2L256 301.3l137.4 137.3 45.2-45.2L301.3 256l137.3-137.4-45.2-45.2L256 210.7Z"></path></svg>
</label>
<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.13.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/ColumnTypeMismatchError" data-name="db::columntypemismatcherror">
<a href="../DB/ColumnTypeMismatchError.html">ColumnTypeMismatchError</a>
</li>
<li class="parent " data-id="db/DB/Connection" data-name="db::connection">
<a href="../DB/Connection.html">Connection</a>
<ul>
<li class=" " data-id="db/DB/Connection/Options" data-name="db::connection::options">
<a href="../DB/Connection/Options.html">Options</a>
</li>
</ul>
</li>
<li class=" " data-id="db/DB/ConnectionBuilder" data-name="db::connectionbuilder">
<a href="../DB/ConnectionBuilder.html">ConnectionBuilder</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/Options" data-name="db::pool::options">
<a href="../DB/Pool/Options.html">Options</a>
</li>
<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=" " 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=" current" 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>
<li class=" " data-id="db/Enum" data-name="enum">
<a href="../Enum.html">Enum</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> DB::<wbr>TopLevelTransaction
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../DB/TopLevelTransaction.html">DB::TopLevelTransaction</a></li><li class="superclass"><a href="../DB/Transaction.html">DB::Transaction</a></li><li class="superclass">Reference</li><li class="superclass">Object</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.13.1/src/db/transaction.cr#L38" target="_blank">
db/transaction.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%28connection%3AConnection%29-class-method" class="signature"><strong>.new</strong>(connection : Connection)</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%3ATransaction-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="#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="#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 class <code><a href="../DB/Transaction.html">DB::Transaction</a></code></h3>
<a href="../DB/Transaction.html#commit-instance-method" class="tooltip">
<span>commit</span>
commit</a>,
<a href="../DB/Transaction.html#connection%3AConnection-instance-method" class="tooltip">
<span>connection : Connection</span>
connection</a>,
<a href="../DB/Transaction.html#release_from_nested_transaction-instance-method" class="tooltip">
<span>release_from_nested_transaction</span>
release_from_nested_transaction</a>,
<a href="../DB/Transaction.html#rollback-instance-method" class="tooltip">
<span>rollback</span>
rollback</a>
<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%26%3ATransaction-%3ET%29%3AT%7CNilforallT-instance-method" class="tooltip">
<span>transaction(& : Transaction -> T) : T | Nil forall T</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>
<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(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/v0.13.1/src/db/transaction.cr#L43" 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="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%3ATransaction-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>
[<a href="https://github.com/crystal-lang/crystal-db/blob/v0.13.1/src/db/transaction.cr#L62" target="_blank">View source</a>]
</div>
</div>
<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">
<div class="doc-inherited">
Description copied from class <a href="../DB/Transaction.html">DB::Transaction</a>
</div>
<p>commits the current transaction</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/v0.13.1/src/db/transaction.cr#L48" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="connection:Connection-instance-method">
<div class="signature">
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/v0.13.1/src/db/transaction.cr#L39" 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">
<div class="doc-inherited">
Description copied from class <a href="../DB/Transaction.html">DB::Transaction</a>
</div>
<p>rollbacks the current transaction</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-lang/crystal-db/blob/v0.13.1/src/db/transaction.cr#L53" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>
Reference in a new issue Copy permalink