mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-08 06:12:55 +00:00
7 lines
10 KiB
HTML
7 lines
10 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` mod in crate `api`."><title>api::v1::region - 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="api" 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 region</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../api/index.html">api</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module region</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></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In api::v1</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">api</a>::<wbr><a href="../index.html">v1</a></div><h1>Module <span>region</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="alter_request/index.html" title="mod api::v1::region::alter_request">alter_<wbr>request</a></dt><dd>Nested message and enum types in <code>AlterRequest</code>.</dd><dt><a class="mod" href="bulk_insert_request/index.html" title="mod api::v1::region::bulk_insert_request">bulk_<wbr>insert_<wbr>request</a></dt><dd>Nested message and enum types in <code>BulkInsertRequest</code>.</dd><dt><a class="mod" href="compact_request/index.html" title="mod api::v1::region::compact_request">compact_<wbr>request</a></dt><dd>Nested message and enum types in <code>CompactRequest</code>.</dd><dt><a class="mod" href="region_client/index.html" title="mod api::v1::region::region_client">region_<wbr>client</a></dt><dd>Generated client implementations.</dd><dt><a class="mod" href="region_request/index.html" title="mod api::v1::region::region_request">region_<wbr>request</a></dt><dd>Nested message and enum types in <code>RegionRequest</code>.</dd><dt><a class="mod" href="region_server/index.html" title="mod api::v1::region::region_server">region_<wbr>server</a></dt><dd>Generated server implementations.</dd><dt><a class="mod" href="sync_request/index.html" title="mod api::v1::region::sync_request">sync_<wbr>request</a></dt><dd>Nested message and enum types in <code>SyncRequest</code>.</dd><dt><a class="mod" href="truncate_request/index.html" title="mod api::v1::region::truncate_request">truncate_<wbr>request</a></dt><dd>Nested message and enum types in <code>TruncateRequest</code>.</dd></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.AddColumn.html" title="struct api::v1::region::AddColumn">AddColumn</a></dt><dt><a class="struct" href="struct.AddColumns.html" title="struct api::v1::region::AddColumns">AddColumns</a></dt><dt><a class="struct" href="struct.All.html" title="struct api::v1::region::All">All</a></dt><dd>Truncate all data in region</dd><dt><a class="struct" href="struct.AlterRequest.html" title="struct api::v1::region::AlterRequest">Alter<wbr>Request</a></dt><dt><a class="struct" href="struct.AlterRequests.html" title="struct api::v1::region::AlterRequests">Alter<wbr>Requests</a></dt><dt><a class="struct" href="struct.ApplyStagingManifestRequest.html" title="struct api::v1::region::ApplyStagingManifestRequest">Apply<wbr>Staging<wbr>Manifest<wbr>Request</a></dt><dd>/ Apply staging manifest request.</dd><dt><a class="struct" href="struct.BuildIndexRequest.html" title="struct api::v1::region::BuildIndexRequest">Build<wbr>Index<wbr>Request</a></dt><dt><a class="struct" href="struct.BulkInsertRequest.html" title="struct api::v1::region::BulkInsertRequest">Bulk<wbr>Insert<wbr>Request</a></dt><dd>Request of bulk ingestion API.</dd><dt><a class="struct" href="struct.CloseRequest.html" title="struct api::v1::region::CloseRequest">Close<wbr>Request</a></dt><dt><a class="struct" href="struct.CompactRequest.html" title="struct api::v1::region::CompactRequest">Compact<wbr>Request</a></dt><dt><a class="struct" href="struct.CreateRequest.html" title="struct api::v1::region::CreateRequest">Create<wbr>Request</a></dt><dt><a class="struct" href="struct.CreateRequests.html" title="struct api::v1::region::CreateRequests">Create<wbr>Requests</a></dt><dd>Create a batch of regions at once, usually used to create multiple logical
|
|
regions at once. Different engines can choose whether to support this
|
|
request. Metric Engine needs it.</dd><dt><a class="struct" href="struct.DeleteRequest.html" title="struct api::v1::region::DeleteRequest">Delete<wbr>Request</a></dt><dt><a class="struct" href="struct.DeleteRequests.html" title="struct api::v1::region::DeleteRequests">Delete<wbr>Requests</a></dt><dt><a class="struct" href="struct.DropColumn.html" title="struct api::v1::region::DropColumn">Drop<wbr>Column</a></dt><dt><a class="struct" href="struct.DropColumns.html" title="struct api::v1::region::DropColumns">Drop<wbr>Columns</a></dt><dt><a class="struct" href="struct.DropRequest.html" title="struct api::v1::region::DropRequest">Drop<wbr>Request</a></dt><dt><a class="struct" href="struct.DropRequests.html" title="struct api::v1::region::DropRequests">Drop<wbr>Requests</a></dt><dd>Same as CreateRequests, but for dropping regions.</dd><dt><a class="struct" href="struct.FileMetas.html" title="struct api::v1::region::FileMetas">File<wbr>Metas</a></dt><dd>The file metas of a staging manifest.
|
|
It is a json array of file metadatas.</dd><dt><a class="struct" href="struct.FlushRequest.html" title="struct api::v1::region::FlushRequest">Flush<wbr>Request</a></dt><dt><a class="struct" href="struct.InsertRequest.html" title="struct api::v1::region::InsertRequest">Insert<wbr>Request</a></dt><dt><a class="struct" href="struct.InsertRequests.html" title="struct api::v1::region::InsertRequests">Insert<wbr>Requests</a></dt><dt><a class="struct" href="struct.ListMetadataRequest.html" title="struct api::v1::region::ListMetadataRequest">List<wbr>Metadata<wbr>Request</a></dt><dd>Get region metadatas of a list of regions.</dd><dt><a class="struct" href="struct.MetricManifestInfo.html" title="struct api::v1::region::MetricManifestInfo">Metric<wbr>Manifest<wbr>Info</a></dt><dd>Manifest info for metric engine.</dd><dt><a class="struct" href="struct.MitoManifestInfo.html" title="struct api::v1::region::MitoManifestInfo">Mito<wbr>Manifest<wbr>Info</a></dt><dd>Manifest info for mito engine.</dd><dt><a class="struct" href="struct.OpenRequest.html" title="struct api::v1::region::OpenRequest">Open<wbr>Request</a></dt><dt><a class="struct" href="struct.QueryRequest.html" title="struct api::v1::region::QueryRequest">Query<wbr>Request</a></dt><dt><a class="struct" href="struct.RegionColumnDef.html" title="struct api::v1::region::RegionColumnDef">Region<wbr>Column<wbr>Def</a></dt><dd>The column definition of a region. Unlike the message <code>ColumnDef</code> in
|
|
<code>ddl.proto</code> which is for clients outside GreptimeDB, this <code>RegionColumnDef</code>
|
|
is for region requests use only. So it carries an extra field <code>column_id</code>
|
|
that is known internally.</dd><dt><a class="struct" href="struct.RegionRequest.html" title="struct api::v1::region::RegionRequest">Region<wbr>Request</a></dt><dt><a class="struct" href="struct.RegionRequestHeader.html" title="struct api::v1::region::RegionRequestHeader">Region<wbr>Request<wbr>Header</a></dt><dt><a class="struct" href="struct.RegionResponse.html" title="struct api::v1::region::RegionResponse">Region<wbr>Response</a></dt><dt><a class="struct" href="struct.Regular.html" title="struct api::v1::region::Regular">Regular</a></dt><dd>/ Regular compaction</dd><dt><a class="struct" href="struct.StrictWindow.html" title="struct api::v1::region::StrictWindow">Strict<wbr>Window</a></dt><dd>/ Strictly-windowed compaction.</dd><dt><a class="struct" href="struct.SyncColumns.html" title="struct api::v1::region::SyncColumns">Sync<wbr>Columns</a></dt><dt><a class="struct" href="struct.SyncRequest.html" title="struct api::v1::region::SyncRequest">Sync<wbr>Request</a></dt><dd>Sync request for region.</dd><dt><a class="struct" href="struct.TruncateRequest.html" title="struct api::v1::region::TruncateRequest">Truncate<wbr>Request</a></dt></dl></section></div></main></body></html> |