144 lines
8 KiB
HTML
144 lines
8 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 `QueryExplanation` enum in crate `mentat_transaction`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, QueryExplanation">
|
|||
|
|
|
|||
|
|
<title>mentat_transaction::query::QueryExplanation - 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 enum">
|
|||
|
|
<!--[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'>Enum QueryExplanation</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.KnownEmpty">KnownEmpty</a><a href="#variant.KnownConstant">KnownConstant</a><a href="#variant.ExecutionPlan">ExecutionPlan</a></div></div><p class='location'><a href='../index.html'>mentat_transaction</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'QueryExplanation', ty: 'enum', 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'>Enum <a href='../index.html'>mentat_transaction</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="enum" href=''>QueryExplanation</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#147-161' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust enum'>pub enum QueryExplanation {
|
|||
|
|
KnownEmpty(<a class="enum" href="../../mentat_query_algebrizer/types/enum.EmptyBecause.html" title="enum mentat_query_algebrizer::types::EmptyBecause">EmptyBecause</a>),
|
|||
|
|
KnownConstant,
|
|||
|
|
ExecutionPlan {
|
|||
|
|
query: <a class="struct" href="../../mentat_sql/struct.SQLQuery.html" title="struct mentat_sql::SQLQuery">SQLQuery</a>,
|
|||
|
|
steps: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../mentat_transaction/query/struct.QueryPlanStep.html" title="struct mentat_transaction::query::QueryPlanStep">QueryPlanStep</a>>,
|
|||
|
|
},
|
|||
|
|
}</pre><div class='docblock'><p>A struct describing information about how Mentat would execute a query.</p>
|
|||
|
|
</div><h2 id='variants' class='variants small-section-header'>
|
|||
|
|
Variants<a href='#variants' class='anchor'></a></h2>
|
|||
|
|
<span id="variant.KnownEmpty" class="variant small-section-header"><a href="#variant.KnownEmpty" class="anchor field"></a><span id='KnownEmpty.v' class='invisible'><code>KnownEmpty(<a class="enum" href="../../mentat_query_algebrizer/types/enum.EmptyBecause.html" title="enum mentat_query_algebrizer::types::EmptyBecause">EmptyBecause</a>)</code></span></span><div class='docblock'><p>A query known in advance to be empty, and why we believe that.</p>
|
|||
|
|
</div><span id="variant.KnownConstant" class="variant small-section-header"><a href="#variant.KnownConstant" class="anchor field"></a><span id='KnownConstant.v' class='invisible'><code>KnownConstant</code></span></span><div class='docblock'><p>A query known in advance to return a constant value.</p>
|
|||
|
|
</div><span id="variant.ExecutionPlan" class="variant small-section-header"><a href="#variant.ExecutionPlan" class="anchor field"></a><span id='ExecutionPlan.v' class='invisible'><code>ExecutionPlan</code></span></span><div class='docblock'><p>A query that takes actual work to execute.</p>
|
|||
|
|
</div><span class='docblock autohide sub-variant' id='variant.ExecutionPlan.fields'><h3 class='fields'>Fields of <code>ExecutionPlan</code></h3>
|
|||
|
|
|
|||
|
|
<table><tr><td id='variant.ExecutionPlan.field.query'><span id='ExecutionPlan.v.query.v' class='invisible'><code>query: <a class="struct" href="../../mentat_sql/struct.SQLQuery.html" title="struct mentat_sql::SQLQuery">SQLQuery</a></code></span></td><td><div class='docblock'><p>The translated query and any bindings.</p>
|
|||
|
|
</div></td></tr><tr><td id='variant.ExecutionPlan.field.steps'><span id='ExecutionPlan.v.steps.v' class='invisible'><code>steps: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../mentat_transaction/query/struct.QueryPlanStep.html" title="struct mentat_transaction::query::QueryPlanStep">QueryPlanStep</a>></code></span></td><td><div class='docblock'><p>The output of SQLite's <code>EXPLAIN QUERY PLAN</code>.</p>
|
|||
|
|
</div></td></tr></table></span></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>
|