2018-06-25 10:20:36 +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 `db` mod in crate `mentat_db`.">
|
|
|
|
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, db">
|
|
|
|
|
|
|
|
|
|
|
|
<title>mentat_db::db - 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 mod">
|
|
|
|
|
|
<!--[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">☰</div>
|
|
|
|
|
|
|
|
|
|
|
|
<p class='location'>Module db</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>mentat_db</a></p><script>window.sidebarCurrent = {name: 'db', ty: 'mod', 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'>Module <a href='../index.html'>mentat_db</a>::<wbr><a class="mod" href=''>db</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'>−</span>]
|
|
|
|
|
|
</a>
|
2018-06-29 17:28:44 +00:00
|
|
|
|
</span><a class='srclink' href='../../src/mentat_db/db.rs.html#11-2779' title='goto source code'>[src]</a></span></h1><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
2018-06-25 10:20:36 +00:00
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="enum" href="enum.SearchType.html"
|
|
|
|
|
|
title='enum mentat_db::db::SearchType'>SearchType</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="constant" href="constant.CURRENT_VERSION.html"
|
|
|
|
|
|
title='constant mentat_db::db::CURRENT_VERSION'>CURRENT_VERSION</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Version history:</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="trait" href="trait.MentatStoring.html"
|
|
|
|
|
|
title='trait mentat_db::db::MentatStoring'>MentatStoring</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p><code>MentatStoring</code> will be the trait that encapsulates the storage layer. It is consumed by the
|
|
|
|
|
|
transaction processing layer.</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="trait" href="trait.PartitionMapping.html"
|
|
|
|
|
|
title='trait mentat_db::db::PartitionMapping'>PartitionMapping</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="trait" href="trait.TypedSQLValue.html"
|
|
|
|
|
|
title='trait mentat_db::db::TypedSQLValue'>TypedSQLValue</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="fn" href="fn.create_current_version.html"
|
|
|
|
|
|
title='fn mentat_db::db::create_current_version'>create_current_version</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="fn" href="fn.create_empty_current_version.html"
|
|
|
|
|
|
title='fn mentat_db::db::create_empty_current_version'>create_empty_current_version</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Do just enough work that either <code>create_current_version</code> or sync can populate the DB.</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="fn" href="fn.ensure_current_version.html"
|
|
|
|
|
|
title='fn mentat_db::db::ensure_current_version'>ensure_current_version</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="fn" href="fn.new_connection.html"
|
|
|
|
|
|
title='fn mentat_db::db::new_connection'>new_connection</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="fn" href="fn.read_db.html"
|
|
|
|
|
|
title='fn mentat_db::db::read_db'>read_db</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Read the materialized views from the given SQL store and return a Mentat <code>DB</code> for querying and
|
|
|
|
|
|
applying transactions.</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="fn" href="fn.update_metadata.html"
|
|
|
|
|
|
title='fn mentat_db::db::update_metadata'>update_metadata</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Update the metadata materialized views based on the given metadata report.</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="fn" href="fn.update_partition_map.html"
|
|
|
|
|
|
title='fn mentat_db::db::update_partition_map'>update_partition_map</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Update the current partition map materialized view.</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="type" href="type.ReducedEntity.html"
|
|
|
|
|
|
title='type mentat_db::db::ReducedEntity'>ReducedEntity</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Internal representation of an [e a v added] datom, ready to be transacted against the store.</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table></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>⏎</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>
|
