You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Scuba (infer.IBase.Scuba)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">infer</a> » <a href="../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><dt class="spec type" id="type-table"><a href="#type-table" class="anchor"></a><code><span class="keyword">type</span> table</code><code> = </code><table class="variant"><tr id="type-table.InferEvents" class="anchored"><td class="def constructor"><a href="#type-table.InferEvents" class="anchor"></a><code>| </code><code><span class="constructor">InferEvents</span></code></td></tr></table></dt><dd><p>A scuba table</p></dd></dl><dl><dt class="spec type" id="type-sample"><a href="#type-sample" class="anchor"></a><code><span class="keyword">type</span> sample</code></dt><dd><p>A sample to be added to Scuba</p></dd></dl><dl><dt class="spec value" id="val-new_sample"><a href="#val-new_sample" class="anchor"></a><code><span class="keyword">val</span> new_sample : <span>time:<span>int option</span></span> <span>-></span> <a href="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><dt class="spec value" id="val-add_int"><a href="#val-add_int" class="anchor"></a><code><span class="keyword">val</span> add_int : <span>name:string</span> <span>-></span> <span>value:int</span> <span>-></span> <a href="index.html#type-sample">sample</a> <span>-></span> <a href="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><dt class="spec value" id="val-add_normal"><a href="#val-add_normal" class="anchor"></a><code><span class="keyword">val</span> add_normal : <span>name:string</span> <span>-></span> <span>value:string</span> <span>-></span> <a href="index.html#type-sample">sample</a> <span>-></span> <a href="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><dt class="spec value" id="val-add_tagset"><a href="#val-add_tagset" class="anchor"></a><code><span class="keyword">val</span> add_tagset : <span>name:string</span> <span>-></span> <span>value:<span>string list</span></span> <span>-></span> <a href="index.html#type-sample">sample</a> <span>-></span> <a href="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><dt class="spec value" id="val-log"><a href="#val-log" class="anchor"></a><code><span class="keyword">val</span> log : <a href="index.html#type-table">table</a> <span>-></span> <span><a href="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>
|
