mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-17 21:40:37 +00:00
6 lines
8.3 KiB
HTML
6 lines
8.3 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 `adapter` mod in crate `common_recordbatch`."><title>common_recordbatch::adapter - 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="common_recordbatch" 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 adapter</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_recordbatch/index.html">common_<wbr>recordbatch</a><span class="version">1.0.0-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module adapter</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</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 common_<wbr>recordbatch</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">common_recordbatch</a></div><h1>Module <span>adapter</span> <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/common_recordbatch/adapter.rs.html#15-882">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.AsyncRecordBatchStreamAdapter.html" title="struct common_recordbatch::adapter::AsyncRecordBatchStreamAdapter">Async<wbr>Record<wbr>Batch<wbr>Stream<wbr>Adapter</a></dt><dt><a class="struct" href="struct.DfRecordBatchStreamAdapter.html" title="struct common_recordbatch::adapter::DfRecordBatchStreamAdapter">DfRecord<wbr>Batch<wbr>Stream<wbr>Adapter</a></dt><dd>Greptime SendableRecordBatchStream -> DataFusion RecordBatchStream.
|
|
The reverse one is <a href="struct.RecordBatchStreamAdapter.html" title="struct common_recordbatch::adapter::RecordBatchStreamAdapter">RecordBatchStreamAdapter</a>.</dd><dt><a class="struct" href="struct.MetricCollector.html" title="struct common_recordbatch::adapter::MetricCollector">Metric<wbr>Collector</a></dt><dd>An [ExecutionPlanVisitor] to collect metrics from a [ExecutionPlan].</dd><dt><a class="struct" href="struct.PlanMetrics.html" title="struct common_recordbatch::adapter::PlanMetrics">Plan<wbr>Metrics</a></dt><dt><a class="struct" href="struct.RecordBatchMetrics.html" title="struct common_recordbatch::adapter::RecordBatchMetrics">Record<wbr>Batch<wbr>Metrics</a></dt><dd><a href="struct.RecordBatchMetrics.html" title="struct common_recordbatch::adapter::RecordBatchMetrics"><code>RecordBatchMetrics</code></a> carrys metrics value
|
|
from datanode to frontend through gRPC</dd><dt><a class="struct" href="struct.RecordBatchStreamAdapter.html" title="struct common_recordbatch::adapter::RecordBatchStreamAdapter">Record<wbr>Batch<wbr>Stream<wbr>Adapter</a></dt><dd>DataFusion <a href="../type.DfSendableRecordBatchStream.html" title="type common_recordbatch::DfSendableRecordBatchStream">SendableRecordBatchStream</a> -> Greptime <a href="../trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a>.
|
|
The reverse one is <a href="struct.DfRecordBatchStreamAdapter.html" title="struct common_recordbatch::adapter::DfRecordBatchStreamAdapter">DfRecordBatchStreamAdapter</a>.
|
|
It can collect metrics from DataFusion execution plan.</dd><dt><a class="struct" href="struct.RecordBatchStreamTypeAdapter.html" title="struct common_recordbatch::adapter::RecordBatchStreamTypeAdapter">Record<wbr>Batch<wbr>Stream<wbr>Type<wbr>Adapter</a></dt><dd>Casts the <code>RecordBatch</code>es of <code>stream</code> against the <code>output_schema</code>.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.AsyncRecordBatchStreamAdapterState.html" title="enum common_recordbatch::adapter::AsyncRecordBatchStreamAdapterState">Async<wbr>Record<wbr>Batch<wbr>Stream<wbr>Adapter<wbr>State</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="enum" href="enum.Metrics.html" title="enum common_recordbatch::adapter::Metrics">Metrics</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Json encoded metrics. Contains metric from a whole plan tree.</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.convert_map_to_json_binary.html" title="fn common_recordbatch::adapter::convert_map_to_json_binary">convert_<wbr>map_<wbr>to_<wbr>json_<wbr>binary</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Convert a Map array to a Binary array containing JSON data</dd><dt><a class="fn" href="fn.custom_cast.html" title="fn common_recordbatch::adapter::custom_cast">custom_<wbr>cast</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Custom cast function that handles Map -> Binary (JSON) conversion</dd><dt><a class="fn" href="fn.format_bytes_human_readable.html" title="fn common_recordbatch::adapter::format_bytes_human_readable">format_<wbr>bytes_<wbr>human_<wbr>readable</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.is_bytes_metric.html" title="fn common_recordbatch::adapter::is_bytes_metric">is_<wbr>bytes_<wbr>metric</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Determines if a metric name represents a bytes measurement that should be formatted.</dd><dt><a class="fn" href="fn.is_time_metric.html" title="fn common_recordbatch::adapter::is_time_metric">is_<wbr>time_<wbr>metric</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Determines if a metric name represents a time measurement that should be formatted.</dd><dt><a class="fn" href="fn.one_line.html" title="fn common_recordbatch::adapter::one_line">one_<wbr>line</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Returns a single-line summary of the root of the plan.
|
|
If the <code>verbose</code> flag is set, it will display detailed information about the plan.</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.FutureStream.html" title="type common_recordbatch::adapter::FutureStream">Future<wbr>Stream</a><span title="Restricted Visibility"> 🔒</span> </dt></dl></section></div></main></body></html> |