320 lines
16 KiB
HTML
320 lines
16 KiB
HTML
|
<!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 `query` mod in crate `mentat_transaction`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, query">
|
|||
|
|
|
|||
|
|
<title>mentat_transaction::query - 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="../../main.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 query</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</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_transaction</a></p><script>window.sidebarCurrent = {name: 'query', 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_transaction</a>::<wbr><a class="mod" href=''>query</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>
|
|||
|
|
</span><a class='srclink' href='../../src/mentat_transaction/query.rs.html#11-466' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Keyword.html"
|
|||
|
|
title='struct mentat_transaction::query::Keyword'>Keyword</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A keyword is a symbol, optionally with a namespace, that prints with a leading colon.
|
|||
|
|
This concept is imported from Clojure, as it features in EDN and the query
|
|||
|
|
syntax that we use.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Known.html"
|
|||
|
|
title='struct mentat_transaction::query::Known'>Known</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A convenience wrapper around things known in memory: the schema and caches.
|
|||
|
|
We use a trait object here to avoid making dozens of functions generic over the type
|
|||
|
|
of the cache. If performance becomes a concern, we should hard-code specific kinds of
|
|||
|
|
cache right here, and/or eliminate the Option.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.PlainSymbol.html"
|
|||
|
|
title='struct mentat_transaction::query::PlainSymbol'>PlainSymbol</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A simplification of Clojure's Symbol.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.QueryInputs.html"
|
|||
|
|
title='struct mentat_transaction::query::QueryInputs'>QueryInputs</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Define the inputs to a query. This is in two parts: a set of values known now, and a set of
|
|||
|
|
types known now.
|
|||
|
|
The separate map of types is to allow queries to be algebrized without full knowledge of
|
|||
|
|
the bindings that will be used at execution time.
|
|||
|
|
When built correctly, <code>types</code> is guaranteed to contain the types of <code>values</code> -- use
|
|||
|
|
<code>QueryInputs::new</code> or <code>QueryInputs::with_values</code> to construct an instance.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.QueryOutput.html"
|
|||
|
|
title='struct mentat_transaction::query::QueryOutput'>QueryOutput</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.QueryPlanStep.html"
|
|||
|
|
title='struct mentat_transaction::query::QueryPlanStep'>QueryPlanStep</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A single row in the output of SQLite's <code>EXPLAIN QUERY PLAN</code>.
|
|||
|
|
See https://www.sqlite.org/eqp.html for an explanation of each field.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.RelResult.html"
|
|||
|
|
title='struct mentat_transaction::query::RelResult'>RelResult</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>The result you get from a 'rel' query, like:</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Variable.html"
|
|||
|
|
title='struct mentat_transaction::query::Variable'>Variable</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.PreparedQuery.html"
|
|||
|
|
title='enum mentat_transaction::query::PreparedQuery'>PreparedQuery</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.QueryExplanation.html"
|
|||
|
|
title='enum mentat_transaction::query::QueryExplanation'>QueryExplanation</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A struct describing information about how Mentat would execute a query.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.QueryResults.html"
|
|||
|
|
title='enum mentat_transaction::query::QueryResults'>QueryResults</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</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.IntoResult.html"
|
|||
|
|
title='trait mentat_transaction::query::IntoResult'>IntoResult</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.lookup_value.html"
|
|||
|
|
title='fn mentat_transaction::query::lookup_value'>lookup_value</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Return a single value for the provided entity and attribute.
|
|||
|
|
If the attribute is multi-valued, an arbitrary value is returned.
|
|||
|
|
If no value is present for that entity, <code>None</code> is returned.
|
|||
|
|
If <code>attribute</code> isn't an attribute, <code>None</code> is returned.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.lookup_value_for_attribute.html"
|
|||
|
|
title='fn mentat_transaction::query::lookup_value_for_attribute'>lookup_value_for_attribute</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Return a single value for the provided entity and attribute.
|
|||
|
|
If the attribute is multi-valued, an arbitrary value is returned.
|
|||
|
|
If no value is present for that entity, <code>None</code> is returned.
|
|||
|
|
If <code>attribute</code> doesn't name an attribute, an error is returned.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.lookup_values.html"
|
|||
|
|
title='fn mentat_transaction::query::lookup_values'>lookup_values</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.lookup_values_for_attribute.html"
|
|||
|
|
title='fn mentat_transaction::query::lookup_values_for_attribute'>lookup_values_for_attribute</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.q_explain.html"
|
|||
|
|
title='fn mentat_transaction::query::q_explain'>q_explain</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.q_once.html"
|
|||
|
|
title='fn mentat_transaction::query::q_once'>q_once</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Take an EDN query string, a reference to an open SQLite connection, a Mentat schema, and an
|
|||
|
|
optional collection of input bindings (which should be keyed by <code>"?varname"</code>), and execute the
|
|||
|
|
query immediately, blocking the current thread.
|
|||
|
|
Returns a structure that corresponds to the kind of input query, populated with <code>TypedValue</code>
|
|||
|
|
instances.
|
|||
|
|
The caller is responsible for ensuring that the SQLite connection has an open transaction if
|
|||
|
|
isolation is required.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.q_prepare.html"
|
|||
|
|
title='fn mentat_transaction::query::q_prepare'>q_prepare</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.q_uncached.html"
|
|||
|
|
title='fn mentat_transaction::query::q_uncached'>q_uncached</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Just like <code>q_once</code>, but doesn't use any cached values.</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.PreparedResult.html"
|
|||
|
|
title='type mentat_transaction::query::PreparedResult'>PreparedResult</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="type" href="type.QueryExecutionResult.html"
|
|||
|
|
title='type mentat_transaction::query::QueryExecutionResult'>QueryExecutionResult</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</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_transaction";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|