<htmlxmlns="http://www.w3.org/1999/xhtml"><head><title>Scuba (infer.IBase.Scuba)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc 1.5.1"/><metaname="viewport"content="width=device-width,initial-scale=1.0"/><scriptsrc="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divclass="content"><header><nav><ahref="../index.html">Up</a>–<ahref="../../index.html">infer</a>»<ahref="../index.html">IBase</a>» Scuba</nav><h1>Module <code>IBase.Scuba</code></h1></header><aside><p>Low-level Scuba logging functionality. Provides functionality to log anything to any scuba table. (Note that Scuba is a schema-free storage, so it won't require any changes). Don't use this module directly for logging to tables with known structure. Use high-level functions that are aware of the table structure.</p></aside><dl><dtclass="spec type"id="type-table"><ahref="#type-table"class="anchor"></a><code><spanclass="keyword">type</span> table</code><code> = </code><tableclass="variant"><trid="type-table.InferEvents"class="anchored"><tdclass="def constructor"><ahref="#type-table.InferEvents"class="anchor"></a><code>| </code><code><spanclass="constructor">InferEvents</span></code></td></tr></table></dt><dd><p>A scuba table</p></dd></dl><dl><dtclass="spec type"id="type-sample"><ahref="#type-sample"class="anchor"></a><code><spanclass="keyword">type</span> sample</code></dt><dd><p>A sample to be added to Scuba</p></dd></dl><dl><dtclass="spec value"id="val-new_sample"><ahref="#val-new_sample"class="anchor"></a><code><spanclass="keyword">val</span> new_sample : <span>time:<span>int option</span></span><span>-></span><ahref="index.html#type-sample">sample</a></code></dt><dd><p>Create an empty sample with given creation timestamp. If time is not specified, corresponds to current timestamp.</p></dd></dl><dl><dtclass="spec value"id="val-add_int"><ahref="#val-add_int"class="anchor"></a><code><spanclass="keyword">val</span> add_int : <span>name:string</span><span>-></span><span>value:int</span><span>-></span><ahref="index.html#type-sample">sample</a><span>-></span><ahref="index.html#type-sample">sample</a></code></dt><dd><p>Set a new integer field and its value to the sample. Overwrites if a field with this name was already set.</p></dd></dl><dl><dtclass="spec value"id="val-add_normal"><ahref="#val-add_normal"class="anchor"></a><code><spanclass="keyword">val</span> add_normal : <span>name:string</span><span>-></span><span>value:string</span><span>-></span><ahref="index.html#type-sample">sample</a><span>-></span><ahref="index.html#type-sample">sample</a></code></dt><dd><p>Set a new string (normal in Scuba terminology) field and its value to the sample. Overwrites if a field with this name was already set.</p></dd></dl><dl><dtclass="spec value"id="val-add_tagset"><ahref="#val-add_tagset"class="anchor"></a><code><spanclass="keyword">val</span> add_tagset : <span>name:string</span><span>-></span><span>value:<span>string list</span></span><span>-></span><ahref="index.html#type-sample">sample</a><span>-></span><ahref="index.html#type-sample">sample</a></code></dt><dd><p>Set a new set of strings (tagset in Scuba terminology) field and its value to the sample. Overwrites if a field with this name was already set.</p></dd></dl><dl><dtclass="spec value"id="val-log"><ahref="#val-log"class="anchor"></a><code><spanclass="keyword">val</span> log : <ahref="index.html#type-table">table</a><span>-></span><span><ahref="index.html#type-sample">sample</a> list</span><span>-></span> unit</code></dt><dd><p>The main function. Log a collection of samples to the given table.</p></dd></dl></div></body></html>
