mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-14 12:00:40 +00:00
1 line
13 KiB
HTML
1 line
13 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 `region_request` mod in crate `store_api`."><title>store_api::region_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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="store_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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 region_request</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module region_<wbr>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="#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 store_<wbr>api</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">store_api</a></div><h1>Module <span>region_<wbr>request</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/store_api/region_request.rs.html#15-2160">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.AddColumn.html" title="struct store_api::region_request::AddColumn">AddColumn</a></dt><dd>Adds a column.</dd><dt><a class="struct" href="struct.ApplyStagingManifestRequest.html" title="struct store_api::region_request::ApplyStagingManifestRequest">Apply<wbr>Staging<wbr>Manifest<wbr>Request</a></dt><dd>This request is used as part of the region repartition.</dd><dt><a class="struct" href="struct.EnterStagingRequest.html" title="struct store_api::region_request::EnterStagingRequest">Enter<wbr>Staging<wbr>Request</a></dt><dt><a class="struct" href="struct.ModifyColumnType.html" title="struct store_api::region_request::ModifyColumnType">Modify<wbr>Column<wbr>Type</a></dt><dd>Change a column’s datatype.</dd><dt><a class="struct" href="struct.RegionAlterRequest.html" title="struct store_api::region_request::RegionAlterRequest">Region<wbr>Alter<wbr>Request</a></dt><dd>Alter metadata of a region.</dd><dt><a class="struct" href="struct.RegionBuildIndexRequest.html" title="struct store_api::region_request::RegionBuildIndexRequest">Region<wbr>Build<wbr>Index<wbr>Request</a></dt><dt><a class="struct" href="struct.RegionBulkInsertsRequest.html" title="struct store_api::region_request::RegionBulkInsertsRequest">Region<wbr>Bulk<wbr>Inserts<wbr>Request</a></dt><dt><a class="struct" href="struct.RegionCatchupRequest.html" title="struct store_api::region_request::RegionCatchupRequest">Region<wbr>Catchup<wbr>Request</a></dt><dd>Catchup region request.</dd><dt><a class="struct" href="struct.RegionCloseRequest.html" title="struct store_api::region_request::RegionCloseRequest">Region<wbr>Close<wbr>Request</a></dt><dd>Close region request.</dd><dt><a class="struct" href="struct.RegionCompactRequest.html" title="struct store_api::region_request::RegionCompactRequest">Region<wbr>Compact<wbr>Request</a></dt><dt><a class="struct" href="struct.RegionCreateRequest.html" title="struct store_api::region_request::RegionCreateRequest">Region<wbr>Create<wbr>Request</a></dt><dt><a class="struct" href="struct.RegionDeleteRequest.html" title="struct store_api::region_request::RegionDeleteRequest">Region<wbr>Delete<wbr>Request</a></dt><dd>Request to delete data from a region.</dd><dt><a class="struct" href="struct.RegionDropRequest.html" title="struct store_api::region_request::RegionDropRequest">Region<wbr>Drop<wbr>Request</a></dt><dt><a class="struct" href="struct.RegionFlushRequest.html" title="struct store_api::region_request::RegionFlushRequest">Region<wbr>Flush<wbr>Request</a></dt><dt><a class="struct" href="struct.RegionOpenRequest.html" title="struct store_api::region_request::RegionOpenRequest">Region<wbr>Open<wbr>Request</a></dt><dd>Open region request.</dd><dt><a class="struct" href="struct.RegionPutRequest.html" title="struct store_api::region_request::RegionPutRequest">Region<wbr>PutRequest</a></dt><dd>Request to put data into a region.</dd><dt><a class="struct" href="struct.RegionReadRequest.html" title="struct store_api::region_request::RegionReadRequest">Region<wbr>Read<wbr>Request</a></dt><dt><a class="struct" href="struct.ReplayCheckpoint.html" title="struct store_api::region_request::ReplayCheckpoint">Replay<wbr>Checkpoint</a></dt><dt><a class="struct" href="struct.SetDefault.html" title="struct store_api::region_request::SetDefault">SetDefault</a></dt></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.AddColumnLocation.html" title="enum store_api::region_request::AddColumnLocation">AddColumn<wbr>Location</a></dt><dd>Location to add a column.</dd><dt><a class="enum" href="enum.AlterKind.html" title="enum store_api::region_request::AlterKind">Alter<wbr>Kind</a></dt><dd>Kind of the alteration.</dd><dt><a class="enum" href="enum.BatchRegionDdlRequest.html" title="enum store_api::region_request::BatchRegionDdlRequest">Batch<wbr>Region<wbr>DdlRequest</a></dt><dt><a class="enum" href="enum.PathType.html" title="enum store_api::region_request::PathType">Path<wbr>Type</a></dt><dd>The type of path to generate.</dd><dt><a class="enum" href="enum.RegionFlushReason.html" title="enum store_api::region_request::RegionFlushReason">Region<wbr>Flush<wbr>Reason</a></dt><dt><a class="enum" href="enum.RegionRequest.html" title="enum store_api::region_request::RegionRequest">Region<wbr>Request</a></dt><dt><a class="enum" href="enum.RegionTruncateRequest.html" title="enum store_api::region_request::RegionTruncateRequest">Region<wbr>Truncate<wbr>Request</a></dt><dd>Truncate region request.</dd><dt><a class="enum" href="enum.SetIndexOption.html" title="enum store_api::region_request::SetIndexOption">SetIndex<wbr>Option</a></dt><dt><a class="enum" href="enum.SetRegionOption.html" title="enum store_api::region_request::SetRegionOption">SetRegion<wbr>Option</a></dt><dt><a class="enum" href="enum.StagingPartitionDirective.html" title="enum store_api::region_request::StagingPartitionDirective">Staging<wbr>Partition<wbr>Directive</a></dt><dd>Request to stage a region with a new partition directive.</dd><dt><a class="enum" href="enum.UnsetIndexOption.html" title="enum store_api::region_request::UnsetIndexOption">Unset<wbr>Index<wbr>Option</a></dt><dt><a class="enum" href="enum.UnsetRegionOption.html" title="enum store_api::region_request::UnsetRegionOption">Unset<wbr>Region<wbr>Option</a></dt></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.make_region_alter.html" title="fn store_api::region_request::make_region_alter">make_<wbr>region_<wbr>alter</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_alters.html" title="fn store_api::region_request::make_region_alters">make_<wbr>region_<wbr>alters</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_apply_staging_manifest.html" title="fn store_api::region_request::make_region_apply_staging_manifest">make_<wbr>region_<wbr>apply_<wbr>staging_<wbr>manifest</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_build_index.html" title="fn store_api::region_request::make_region_build_index">make_<wbr>region_<wbr>build_<wbr>index</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_bulk_inserts.html" title="fn store_api::region_request::make_region_bulk_inserts">make_<wbr>region_<wbr>bulk_<wbr>inserts</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Convert [BulkInsertRequest] to <a href="enum.RegionRequest.html" title="enum store_api::region_request::RegionRequest">RegionRequest</a> and group by <a href="../storage/struct.RegionId.html" title="struct store_api::storage::RegionId">RegionId</a>.</dd><dt><a class="fn" href="fn.make_region_close.html" title="fn store_api::region_request::make_region_close">make_<wbr>region_<wbr>close</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_compact.html" title="fn store_api::region_request::make_region_compact">make_<wbr>region_<wbr>compact</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_create.html" title="fn store_api::region_request::make_region_create">make_<wbr>region_<wbr>create</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_creates.html" title="fn store_api::region_request::make_region_creates">make_<wbr>region_<wbr>creates</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_deletes.html" title="fn store_api::region_request::make_region_deletes">make_<wbr>region_<wbr>deletes</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_drop.html" title="fn store_api::region_request::make_region_drop">make_<wbr>region_<wbr>drop</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_drops.html" title="fn store_api::region_request::make_region_drops">make_<wbr>region_<wbr>drops</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_flush.html" title="fn store_api::region_request::make_region_flush">make_<wbr>region_<wbr>flush</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_open.html" title="fn store_api::region_request::make_region_open">make_<wbr>region_<wbr>open</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_puts.html" title="fn store_api::region_request::make_region_puts">make_<wbr>region_<wbr>puts</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.make_region_truncate.html" title="fn store_api::region_request::make_region_truncate">make_<wbr>region_<wbr>truncate</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.parse_region_alter.html" title="fn store_api::region_request::parse_region_alter">parse_<wbr>region_<wbr>alter</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.parse_region_create.html" title="fn store_api::region_request::parse_region_create">parse_<wbr>region_<wbr>create</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.parse_region_drop.html" title="fn store_api::region_request::parse_region_drop">parse_<wbr>region_<wbr>drop</a><span title="Restricted Visibility"> 🔒</span> </dt></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.AffectedRows.html" title="type store_api::region_request::AffectedRows">Affected<wbr>Rows</a></dt></dl></section></div></main></body></html> |