greptimedb/mito2/request/index.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="Worker requests."><title>mito2::request - 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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mito2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.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"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[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 request</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../mito2/index.html">mito2</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module request</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="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate mito2</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" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">mito2</a></div><h1>Module <span>request</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/mito2/request.rs.html#15-2095">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Worker requests.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.BuildIndexRequest.html" title="struct mito2::request::BuildIndexRequest">Build<wbr>Index<wbr>Request</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.BulkColumn.html" title="struct mito2::request::BulkColumn">Bulk<wbr>Column</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A column of the batch of a bulk insert.</dd><dt><a class="struct" href="struct.BulkInsertRequest.html" title="struct mito2::request::BulkInsertRequest">Bulk<wbr>Insert<wbr>Request</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.CompactionFailed.html" title="struct mito2::request::CompactionFailed">Compaction<wbr>Failed</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A failing compaction result.</dd><dt><a class="struct" href="struct.CompactionFinished.html" title="struct mito2::request::CompactionFinished">Compaction<wbr>Finished</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies a compaction job has finished.</dd><dt><a class="struct" href="struct.CopyRegionFromFinished.html" title="struct mito2::request::CopyRegionFromFinished">Copy<wbr>Region<wbr>From<wbr>Finished</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.CopyRegionFromRequest.html" title="struct mito2::request::CopyRegionFromRequest">Copy<wbr>Region<wbr>From<wbr>Request</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.DiscardUnflushedResult.html" title="struct mito2::request::DiscardUnflushedResult">Discard<wbr>Unflushed<wbr>Result</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies the result of discarding unflushed data from a region.</dd><dt><a class="struct" href="struct.EnterStagingResult.html" title="struct mito2::request::EnterStagingResult">Enter<wbr>Staging<wbr>Result</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies the region the result of entering staging.</dd><dt><a class="struct" href="struct.FlushFailed.html" title="struct mito2::request::FlushFailed">Flush<wbr>Failed</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies a flush job is failed.</dd><dt><a class="struct" href="struct.FlushFinished.html" title="struct mito2::request::FlushFinished">Flush<wbr>Finished</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies a flush job is finished.</dd><dt><a class="struct" href="struct.IndexBuildFailed.html" title="struct mito2::request::IndexBuildFailed">Index<wbr>Build<wbr>Failed</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies an index build job has failed.</dd><dt><a class="struct" href="struct.IndexBuildFinished.html" title="struct mito2::request::IndexBuildFinished">Index<wbr>Build<wbr>Finished</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.IndexBuildStopped.html" title="struct mito2::request::IndexBuildStopped">Index<wbr>Build<wbr>Stopped</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies an index build job has been stopped.</dd><dt><a class="struct" href="struct.OptionOutputTx.html" title="struct mito2::request::OptionOutputTx">Option<wbr>Output<wbr>Tx</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Optional output result sender.</dd><dt><a class="struct" href="struct.OutputTx.html" title="struct mito2::request::OutputTx">Output<wbr>Tx</a></dt><dd>Oneshot output result sender.</dd><dt><a class="struct" href="struct.RegionChangeResult.html" title="struct mito2::request::RegionChangeResult">Region<wbr>Change<wbr>Result</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies the region the result of writing region change action.</dd><dt><a class="struct" href="struct.RegionEditRequest.html" title="struct mito2::request::RegionEditRequest">Region<wbr>Edit<wbr>Request</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Request to edit a region directly.</dd><dt><a class="struct" href="struct.RegionEditResult.html" title="struct mito2::request::RegionEditResult">Region<wbr>Edit<wbr>Result</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies the regin the result of editing region.</dd><dt><a class="struct" href="struct.RegionSyncRequest.html" title="struct mito2::request::RegionSyncRequest">Region<wbr>Sync<wbr>Request</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.RemapManifestsRequest.html" title="struct mito2::request::RemapManifestsRequest">Remap<wbr>Manifests<wbr>Request</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.RowColumn.html" title="struct mito2::request::RowColumn">RowColumn</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A column of the rows of a <a href="struct.WriteRequest.html" title="struct mito2::request::WriteRequest">WriteRequest</a>.</dd><dt><a class="struct" href="struct.SenderBulkRequest.html" title="struct mito2::request::SenderBulkRequest">Sender<wbr>Bulk<wbr>Request</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.SenderDdlRequest.html" title="struct mito2::request::SenderDdlRequest">Sender<wbr>DdlRequest</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Sender and Ddl request.</dd><dt><a class="struct" href="struct.SenderWriteRequest.html" title="struct mito2::request::SenderWriteRequest">Sender<wbr>Write<wbr>Request</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Sender and write request.</dd><dt><a class="struct" href="struct.TruncateResult.html" title="struct mito2::request::TruncateResult">Truncate<wbr>Result</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notifies the truncate result of a region.</dd><dt><a class="struct" href="struct.Waiters.html" title="struct mito2::request::Waiters">Waiters</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.WorkerRequestWithTime.html" title="struct mito2::request::WorkerRequestWithTime">Worker<wbr>Request<wbr>With<wbr>Time</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Request sent to a worker with timestamp</dd><dt><a class="struct" href="struct.WriteRequest.html" title="struct mito2::request::WriteRequest">Write<wbr>Request</a></dt><dd>Request to write a region.</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.BackgroundNotify.html" title="enum mito2::request::BackgroundNotify">Background<wbr>Notify</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Notification from a background job.</dd><dt><a class="enum" href="enum.CompactionUnitNotification.html" title="enum mito2::request::CompactionUnitNotification">Compaction<wbr>Unit<wbr>Notification</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A local unit event carries only identity, never an input reservation lease.</dd><dt><a class="enum" href="enum.DdlRequest.html" title="enum mito2::request::DdlRequest">DdlRequest</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>DDL request to a region.</dd><dt><a class="enum" href="enum.WorkerRequest.html" title="enum mito2::request::WorkerRequest">Worker<wbr>Request</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Request sent to a worker</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.OnFailure.html" title="trait mito2::request::OnFailure">OnFailure</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Callback on failure.</dd><dt><a class="trait" href="trait.RequestColumn.html" title="trait mito2::request::RequestColumn">Request<wbr>Column</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A column of a write request, as <a href="fn.check_request_columns.html" title="fn mito2::request::check_request_columns">check_request_columns</a> sees it.</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.check_bulk_insert_batch.html" title="fn mito2::request::check_bulk_insert_batch">check_<wbr>bulk_<wbr>insert_<wbr>batch</a></dt><dd>Checks the batch of a bulk insert against the region schema with the rules
<a href="struct.WriteRequest.html#method.check_schema" title="method mito2::request::WriteRequest::check_schema">WriteRequest::check_schema</a> applies to rows: column names are unique, every
column is a column of the region with its Arrow type and contains nulls only
if the region column is nullable, and a missing column is nullable or has a
default value. Tags may use any string encoding. Sparse batches carry the
tags in one encoded primary key column instead. Returns whether the batch
misses columns that the writer fills.</dd><dt><a class="fn" href="fn.check_column_can_be_filled.html" title="fn mito2::request::check_column_can_be_filled">check_<wbr>column_<wbr>can_<wbr>be_<wbr>filled</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Checks that a write may leave out <code>column</code>, which is then filled with its
default value or null.</dd><dt><a class="fn" href="fn.check_request_columns.html" title="fn mito2::request::check_request_columns">check_<wbr>request_<wbr>columns</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Checks the columns of a write request against the region schema. Each column
must be a column of the region, have its data type and, if the request carries
one, its semantic type, and contain nulls only if the region column is
nullable. <code>check_missing</code> checks the region columns that the request doesn’t
have. Returns whether there are such columns.</dd><dt><a class="fn" href="fn.validate_proto_value.html" title="fn mito2::request::validate_proto_value">validate_<wbr>proto_<wbr>value</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Validate proto value schema.</dd></dl></section></div></main></body></html>