mentat/docs/apis/rust/0.7.0/mentat_query_algebrizer/index.html
Emily Toop c5180656cc
Mentat documentation website using Jekyll (#754)
Steps to building docs locally:

    1. Install Jekyll
    2. cd docs
    3. bundle exec jekyll serve --incremental
    4. open local docs site at http://127.0.0.1:4000/


* basic Jekyll site

* Add docs to documentation site

* Update javadoc to allow for error free builds

* Remove docs for rust dependencies

* Better display examples, about and contributing documentation for Mentat

* Version docs
2018-06-25 11:20:36 +01:00

383 lines
No EOL
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `mentat_query_algebrizer` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, mentat_query_algebrizer">
<title>mentat_query_algebrizer - 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">&#9776;</div>
<p class='location'>Crate mentat_query_algebrizer</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#macros">Macros</a></li><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'></p><script>window.sidebarCurrent = {name: 'mentat_query_algebrizer', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>mentat_query_algebrizer</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>
</span><a class='srclink' href='../src/mentat_query_algebrizer/lib.rs.html#11-403' title='goto source code'>[src]</a></span></h1><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
<table>
<tr class=' module-item'>
<td><a class="macro" href="macro.bail.html"
title='macro mentat_query_algebrizer::bail'>bail</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.AlgebraicQuery.html"
title='struct mentat_query_algebrizer::AlgebraicQuery'>AlgebraicQuery</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ColumnAlternation.html"
title='struct mentat_query_algebrizer::ColumnAlternation'>ColumnAlternation</a></td>
<td class='docblock-short'>
<p>A <code>ColumnAlternation</code> constraint is satisfied if at least one of its inner constraints is
satisfied. An empty <code>ColumnAlternation</code> is never satisfied.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ColumnIntersection.html"
title='struct mentat_query_algebrizer::ColumnIntersection'>ColumnIntersection</a></td>
<td class='docblock-short'>
<p>A <code>ColumnIntersection</code> constraint is satisfied if all of its inner constraints are satisfied.
An empty intersection is always satisfied.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ConjoiningClauses.html"
title='struct mentat_query_algebrizer::ConjoiningClauses'>ConjoiningClauses</a></td>
<td class='docblock-short'>
<p>A <code>ConjoiningClauses</code> (CC) is a collection of clauses that are combined with <code>JOIN</code>.
The topmost form in a query is a <code>ConjoiningClauses</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.FindQuery.html"
title='struct mentat_query_algebrizer::FindQuery'>FindQuery</a></td>
<td class='docblock-short'>
<p>A <code>FindQuery</code> represents a valid query to the query algebrizer.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.InvalidBinding.html"
title='struct mentat_query_algebrizer::InvalidBinding'>InvalidBinding</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Known.html"
title='struct mentat_query_algebrizer::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.OrderBy.html"
title='struct mentat_query_algebrizer::OrderBy'>OrderBy</a></td>
<td class='docblock-short'>
<p>Represents an entry in the ORDER BY list: a variable or a variable's type tag.
(We require order vars to be projected, so we can simply use a variable here.)</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.QualifiedAlias.html"
title='struct mentat_query_algebrizer::QualifiedAlias'>QualifiedAlias</a></td>
<td class='docblock-short'>
<p>A particular column of a particular aliased table. E.g., &quot;datoms123&quot;, Attribute.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.QueryInputs.html"
title='struct mentat_query_algebrizer::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.SourceAlias.html"
title='struct mentat_query_algebrizer::SourceAlias'>SourceAlias</a></td>
<td class='docblock-short'>
<p>The association between a table and its alias. E.g., AllDatoms, &quot;all_datoms123&quot;.</p>
</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.AlgebrizerError.html"
title='enum mentat_query_algebrizer::AlgebrizerError'>AlgebrizerError</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.BindingError.html"
title='enum mentat_query_algebrizer::BindingError'>BindingError</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Column.html"
title='enum mentat_query_algebrizer::Column'>Column</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ColumnConstraint.html"
title='enum mentat_query_algebrizer::ColumnConstraint'>ColumnConstraint</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ColumnConstraintOrAlternation.html"
title='enum mentat_query_algebrizer::ColumnConstraintOrAlternation'>ColumnConstraintOrAlternation</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ComputedTable.html"
title='enum mentat_query_algebrizer::ComputedTable'>ComputedTable</a></td>
<td class='docblock-short'>
<p>A source of rows that isn't a named table -- typically a subquery or union.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DatomsColumn.html"
title='enum mentat_query_algebrizer::DatomsColumn'>DatomsColumn</a></td>
<td class='docblock-short'>
<p>One of the named columns of our tables.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DatomsTable.html"
title='enum mentat_query_algebrizer::DatomsTable'>DatomsTable</a></td>
<td class='docblock-short'>
<p>This enum models the fixed set of default tables we have -- two
tables and two views -- and computed tables defined in the enclosing CC.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.EmptyBecause.html"
title='enum mentat_query_algebrizer::EmptyBecause'>EmptyBecause</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.FulltextColumn.html"
title='enum mentat_query_algebrizer::FulltextColumn'>FulltextColumn</a></td>
<td class='docblock-short'>
<p>One of the named columns of our fulltext values table.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.QueryValue.html"
title='enum mentat_query_algebrizer::QueryValue'>QueryValue</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.VariableColumn.html"
title='enum mentat_query_algebrizer::VariableColumn'>VariableColumn</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.ColumnName.html"
title='trait mentat_query_algebrizer::ColumnName'>ColumnName</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.algebrize.html"
title='fn mentat_query_algebrizer::algebrize'>algebrize</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.algebrize_with_counter.html"
title='fn mentat_query_algebrizer::algebrize_with_counter'>algebrize_with_counter</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.algebrize_with_inputs.html"
title='fn mentat_query_algebrizer::algebrize_with_inputs'>algebrize_with_inputs</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.parse_find_string.html"
title='fn mentat_query_algebrizer::parse_find_string'>parse_find_string</a></td>
<td class='docblock-short'>
</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.Result.html"
title='type mentat_query_algebrizer::Result'>Result</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.TableAlias.html"
title='type mentat_query_algebrizer::TableAlias'>TableAlias</a></td>
<td class='docblock-short'>
<p>A specific instance of a table within a query. E.g., &quot;datoms123&quot;.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.VariableBindings.html"
title='type mentat_query_algebrizer::VariableBindings'>VariableBindings</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>&#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_algebrizer";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>