29 lines
6.1 KiB
HTML
29 lines
6.1 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 `mercator_db` crate."><meta name="keywords" content="rust, rustlang, rust-lang, mercator_db"><title>mercator_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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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><a href='../mercator_db/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate mercator_db</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all mercator_db's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'mercator_db', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/mercator_db/lib.rs.html#1-43' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>mercator_db</a></span></h1><div class='docblock'><h1 id="mercator-db" class="section-header"><a href="#mercator-db">Mercator DB</a></h1>
|
||
<p>Database model for the Mercator spatial index.</p>
|
||
<h2 id="mercator-spatial-index" class="section-header"><a href="#mercator-spatial-index">Mercator: Spatial Index</a></h2>
|
||
<p><strong>Mercator</strong> is a spatial <em>volumetric</em> index for the
|
||
<a href="http://www.humanbrainproject.eu">Human Brain Project</a>. It is a component of the <a href="http://www.humanbrainproject.eu/en/explore-the-brain/search/">Knowledge Graph</a>
|
||
service, which provides the spatial anchoring for the metadata
|
||
registered as well as processes the volumetric queries.</p>
|
||
<p>It is build on top of the Iron Sea database toolkit.</p>
|
||
<h2 id="iron-sea-database-toolkit" class="section-header"><a href="#iron-sea-database-toolkit">Iron Sea: Database Toolkit</a></h2>
|
||
<p><strong>Iron Sea</strong> provides a set of database engine bricks, which can be
|
||
combined and applied on arbitrary data structures.</p>
|
||
<p>Unlike a traditional database, it does not assume a specific
|
||
physical structure for the tables nor the records, but relies on the
|
||
developer to provide a set of extractor functions which are used by
|
||
the specific indices provided.</p>
|
||
<p>This enables the index implementations to be agnostic from the
|
||
underlying data structure, and re-used.</p>
|
||
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table><tr class='module-item'><td><a class="mod" href="space/index.html" title='mercator_db::space mod'>space</a></td><td class='docblock-short'><p>Reference space definitions.</p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="storage/index.html" title='mercator_db::storage mod'>storage</a></td><td class='docblock-short'><p>Persistent data functions and types.</p>
|
||
</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.Core.html" title='mercator_db::Core struct'>Core</a></td><td class='docblock-short'><p>Index over a single dataset</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CoreQueryParameters.html" title='mercator_db::CoreQueryParameters struct'>CoreQueryParameters</a></td><td class='docblock-short'><p>Query Parameters.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DataBase.html" title='mercator_db::DataBase struct'>DataBase</a></td><td class='docblock-short'><p>Collection of datasets and their reference spaces.</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.Properties.html" title='mercator_db::Properties enum'>Properties</a></td><td class='docblock-short'><p>Definition of the volumetric objects identifiers.</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.ResultSet.html" title='mercator_db::ResultSet type'>ResultSet</a></td><td class='docblock-short'><p>Selected tuples matching a query.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "mercator_db";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |