Files
greptimedb/flow/repr/index.html
2025-12-25 05:03:15 +00:00

5 lines
6.1 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="basically a wrapper around the `datatype` crate for basic Data Representation"><title>flow::repr - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="flow" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module repr</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../flow/index.html">flow</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module repr</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate flow</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">flow</a></div><h1>Module <span>repr</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/flow/repr.rs.html#15-262">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>basically a wrapper around the <code>datatype</code> crate
for basic Data Representation</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="relation/index.html" title="mod flow::repr::relation">relation</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Row.html" title="struct flow::repr::Row">Row</a></dt><dd>A row is a vector of values.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.BATCH_SIZE.html" title="constant flow::repr::BATCH_SIZE">BATCH_<wbr>SIZE</a></dt><dd>Flow worker will try to at least accumulate this many rows before processing them(if one second havent passed)</dd><dt><a class="constant" href="constant.BROADCAST_CAP.html" title="constant flow::repr::BROADCAST_CAP">BROADCAST_<wbr>CAP</a></dt><dd>broadcast channel capacity, can be important to memory consumption, since this influence how many
updates can be buffered in memory in the entire dataflow
TODO(discord9): add config for this, so cpu&amp;mem usage can be balanced and configured by this</dd><dt><a class="constant" href="constant.SEND_BUF_CAP.html" title="constant flow::repr::SEND_BUF_CAP">SEND_<wbr>BUF_<wbr>CAP</a></dt><dd>The maximum capacity of the send buffer, to prevent the buffer from growing too large</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.value_to_internal_ts.html" title="fn flow::repr::value_to_internal_ts">value_<wbr>to_<wbr>internal_<wbr>ts</a></dt><dd>Convert a value that is or can be converted to Datetime to internal timestamp</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.Diff.html" title="type flow::repr::Diff">Diff</a></dt><dd>System-wide Record count difference type. Useful for capture data change</dd><dt><a class="type" href="type.DiffRow.html" title="type flow::repr::DiffRow">DiffRow</a></dt><dd>Default type for a repr of changes to a collection.</dd><dt><a class="type" href="type.Duration.html" title="type flow::repr::Duration">Duration</a></dt><dd>System-wide default duration type, in milliseconds</dd><dt><a class="type" href="type.KeyValDiffRow.html" title="type flow::repr::KeyValDiffRow">KeyVal<wbr>Diff<wbr>Row</a></dt><dd>Row with key-value pair, timestamp and diff</dd><dt><a class="type" href="type.Timestamp.html" title="type flow::repr::Timestamp">Timestamp</a></dt><dd>System-wide default timestamp type, in milliseconds</dd></dl></section></div></main></body></html>