greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity
mentat/docs/apis/rust/mentat_query_projector/struct.CombinedProjection.html

179 lines
12 KiB
HTML
Raw Normal View History

Add docs to documentation site
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 `CombinedProjection` struct in crate `mentat_query_projector`.">
<meta name="keywords" content="rust, rustlang, rust-lang, CombinedProjection">
<title>mentat_query_projector::CombinedProjection - 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 struct">
<!--[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>
<p class='location'>Struct CombinedProjection</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.sql_projection">sql_projection</a><a href="#structfield.pre_aggregate_projection">pre_aggregate_projection</a><a href="#structfield.datalog_projector">datalog_projector</a><a href="#structfield.distinct">distinct</a><a href="#structfield.group_by_cols">group_by_cols</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='index.html'>mentat_query_projector</a></p><script>window.sidebarCurrent = {name: 'CombinedProjection', ty: 'struct', 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'>Struct <a href='index.html'>mentat_query_projector</a>::<wbr><a class="struct" href=''>CombinedProjection</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>
Remove docs for rust dependencies
2018-06-22 17:25:54 +00:00
</span><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#383-407' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct CombinedProjection {
Add docs to documentation site
2018-06-21 14:44:35 +00:00
pub sql_projection: <a class="enum" href="../mentat_query_sql/enum.Projection.html" title="enum mentat_query_sql::Projection">Projection</a>,
pub pre_aggregate_projection: <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="enum" href="../mentat_query_sql/enum.Projection.html" title="enum mentat_query_sql::Projection">Projection</a>&gt;,
pub datalog_projector: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../mentat_query_projector/trait.Projector.html" title="trait mentat_query_projector::Projector">Projector</a>&gt;,
pub distinct: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
pub group_by_cols: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../mentat_query_sql/enum.GroupBy.html" title="enum mentat_query_sql::GroupBy">GroupBy</a>&gt;,
}</pre></div><div class='docblock'><p>Combines the things you need to turn a query into SQL and turn its results into
<code>QueryResults</code>: SQL-related projection information (<code>DISTINCT</code>, columns, etc.) and
a Datalog projector that turns SQL into structures.</p>
</div><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.sql_projection" class="structfield small-section-header">
<a href="#structfield.sql_projection" class="anchor field"></a>
<span id="sql_projection.v" class='invisible'>
<code>sql_projection: <a class="enum" href="../mentat_query_sql/enum.Projection.html" title="enum mentat_query_sql::Projection">Projection</a></code>
</span></span><div class='docblock'><p>A SQL projection, mapping columns mentioned in the body of the query to columns in the
output.</p>
</div><span id="structfield.pre_aggregate_projection" class="structfield small-section-header">
<a href="#structfield.pre_aggregate_projection" class="anchor field"></a>
<span id="pre_aggregate_projection.v" class='invisible'>
<code>pre_aggregate_projection: <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="enum" href="../mentat_query_sql/enum.Projection.html" title="enum mentat_query_sql::Projection">Projection</a>&gt;</code>
</span></span><div class='docblock'><p>If a query contains aggregates, we need to generate a nested subquery: an inner query
that returns our distinct variable bindings (and any <code>:with</code> vars), and an outer query
that applies aggregation. That's so we can put <code>DISTINCT</code> in the inner query and apply
aggregation afterwards -- <code>SELECT DISTINCT count(foo)</code> counts <em>then</em> uniques, and we need
the opposite to implement Datalog distinct semantics.
If this is the case, <code>sql_projection</code> will be the outer query's projection list, and
<code>pre_aggregate_projection</code> will be the inner.
If the query doesn't use aggregation, this field will be <code>None</code>.</p>
</div><span id="structfield.datalog_projector" class="structfield small-section-header">
<a href="#structfield.datalog_projector" class="anchor field"></a>
<span id="datalog_projector.v" class='invisible'>
<code>datalog_projector: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../mentat_query_projector/trait.Projector.html" title="trait mentat_query_projector::Projector">Projector</a>&gt;</code>
</span></span><div class='docblock'><p>A Datalog projection. This consumes rows of the appropriate shape (as defined by
the SQL projection) to yield one of the four kinds of Datalog query result.</p>
</div><span id="structfield.distinct" class="structfield small-section-header">
<a href="#structfield.distinct" class="anchor field"></a>
<span id="distinct.v" class='invisible'>
<code>distinct: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code>
</span></span><div class='docblock'><p>True if this query requires the SQL query to include DISTINCT.</p>
</div><span id="structfield.group_by_cols" class="structfield small-section-header">
<a href="#structfield.group_by_cols" class="anchor field"></a>
<span id="group_by_cols.v" class='invisible'>
<code>group_by_cols: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../mentat_query_sql/enum.GroupBy.html" title="enum mentat_query_sql::GroupBy">GroupBy</a>&gt;</code>
</span></span>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'>
</div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
</h2>
<div id='synthetic-implementations-list'>
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../mentat_query_projector/struct.CombinedProjection.html" title="struct mentat_query_projector::CombinedProjection">CombinedProjection</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../mentat_query_projector/struct.CombinedProjection.html" title="struct mentat_query_projector::CombinedProjection">CombinedProjection</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></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_query_projector";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>
Reference in a new issue Copy permalink