mentat/docs/apis/rust/mentat_db/fn.transact.html

130 lines
7 KiB
HTML
Raw Normal View History

2018-06-21 14:44:35 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `transact` fn in crate `mentat_db`.">
<meta name="keywords" content="rust, rustlang, rust-lang, transact">
<title>mentat_db::transact - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css"
id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../dark.css">
<link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc fn">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<div class="sidebar-elems"><p class='location'><a href='index.html'>mentat_db</a></p><script>window.sidebarCurrent = {name: 'transact', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Function <a href='index.html'>mentat_db</a>::<wbr><a class="fn" href=''>transact</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
2018-06-22 17:25:54 +00:00
</span><a class='srclink' href='../src/mentat_db/tx.rs.html#860-873' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn transact&lt;'conn, 'a, I, V, W&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;conn: &amp;'conn Connection, <br>&nbsp;&nbsp;&nbsp;&nbsp;partition_map: <a class="type" href="../mentat_db/types/type.PartitionMap.html" title="type mentat_db::types::PartitionMap">PartitionMap</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;schema_for_mutation: &amp;'a <a class="struct" href="../mentat_db/types/struct.Schema.html" title="struct mentat_db::types::Schema">Schema</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;schema: &amp;'a <a class="struct" href="../mentat_db/types/struct.Schema.html" title="struct mentat_db::types::Schema">Schema</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;watcher: W, <br>&nbsp;&nbsp;&nbsp;&nbsp;entities: I<br>) -&gt; <a class="type" href="../mentat_db/errors/type.Result.html" title="type mentat_db::errors::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../mentat_db/types/struct.TxReport.html" title="struct mentat_db::types::TxReport">TxReport</a>, <a class="type" href="../mentat_db/types/type.PartitionMap.html" title="type mentat_db::types::PartitionMap">PartitionMap</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../mentat_db/types/struct.Schema.html" title="struct mentat_db::types::Schema">Schema</a>&gt;, W<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>&lt;Item = <a class="enum" href="../edn/entities/enum.Entity.html" title="enum edn::entities::Entity">Entity</a>&lt;V&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="../mentat_db/types/trait.TransactableValue.html" title="trait mentat_db::types::TransactableValue">TransactableValue</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;W: <a class="trait" href="../mentat_db/trait.TransactWatcher.html" title="trait mentat_db::TransactWatcher">TransactWatcher</a>,&nbsp;</span></pre><div class='docblock'><p>Transact the given <code>entities</code> against the given SQLite <code>conn</code>, using the given metadata.
2018-06-21 14:44:35 +00:00
If you want this work to occur inside a SQLite transaction, establish one on the connection
prior to calling this function.</p>
<p>This approach is explained in https://github.com/mozilla/mentat/wiki/Transacting.</p>
</div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "mentat_db";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>