mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-15 04:20:39 +00:00
2 lines
19 KiB
HTML
2 lines
19 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 `meta` mod in crate `api`."><title>api::v1::meta - 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="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 meta</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</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module meta</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="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</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" tabindex="-1"><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>meta</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/api/v1.rs.html#19">Source</a> </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="cluster_client/index.html" title="mod api::v1::meta::cluster_client">cluster_<wbr>client</a></dt><dd>Generated client implementations.</dd><dt><a class="mod" href="cluster_server/index.html" title="mod api::v1::meta::cluster_server">cluster_<wbr>server</a></dt><dd>Generated server implementations.</dd><dt><a class="mod" href="config_client/index.html" title="mod api::v1::meta::config_client">config_<wbr>client</a></dt><dd>Generated client implementations.</dd><dt><a class="mod" href="config_server/index.html" title="mod api::v1::meta::config_server">config_<wbr>server</a></dt><dd>Generated server implementations.</dd><dt><a class="mod" href="ddl_task_request/index.html" title="mod api::v1::meta::ddl_task_request">ddl_<wbr>task_<wbr>request</a></dt><dd>Nested message and enum types in <code>DdlTaskRequest</code>.</dd><dt><a class="mod" href="heartbeat_client/index.html" title="mod api::v1::meta::heartbeat_client">heartbeat_<wbr>client</a></dt><dd>Generated client implementations.</dd><dt><a class="mod" href="heartbeat_request/index.html" title="mod api::v1::meta::heartbeat_request">heartbeat_<wbr>request</a></dt><dd>Nested message and enum types in <code>HeartbeatRequest</code>.</dd><dt><a class="mod" href="heartbeat_server/index.html" title="mod api::v1::meta::heartbeat_server">heartbeat_<wbr>server</a></dt><dd>Generated server implementations.</dd><dt><a class="mod" href="lock_client/index.html" title="mod api::v1::meta::lock_client">lock_<wbr>client</a></dt><dd>Generated client implementations.</dd><dt><a class="mod" href="lock_server/index.html" title="mod api::v1::meta::lock_server">lock_<wbr>server</a></dt><dd>Generated server implementations.</dd><dt><a class="mod" href="mailbox_message/index.html" title="mod api::v1::meta::mailbox_message">mailbox_<wbr>message</a></dt><dd>Nested message and enum types in <code>MailboxMessage</code>.</dd><dt><a class="mod" href="procedure_service_client/index.html" title="mod api::v1::meta::procedure_service_client">procedure_<wbr>service_<wbr>client</a></dt><dd>Generated client implementations.</dd><dt><a class="mod" href="procedure_service_server/index.html" title="mod api::v1::meta::procedure_service_server">procedure_<wbr>service_<wbr>server</a></dt><dd>Generated server implementations.</dd><dt><a class="mod" href="reconcile_request/index.html" title="mod api::v1::meta::reconcile_request">reconcile_<wbr>request</a></dt><dd>Nested message and enum types in <code>ReconcileRequest</code>.</dd><dt><a class="mod" href="store_client/index.html" title="mod api::v1::meta::store_client">store_<wbr>client</a></dt><dd>Generated client implementations.</dd><dt><a class="mod" href="store_server/index.html" title="mod api::v1::meta::store_server">store_<wbr>server</a></dt><dd>Generated server implementations.</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.AlterDatabaseTask.html" title="struct api::v1::meta::AlterDatabaseTask">Alter<wbr>Database<wbr>Task</a></dt><dd>Alter database tasks</dd><dt><a class="struct" href="struct.AlterTableTask.html" title="struct api::v1::meta::AlterTableTask">Alter<wbr>Table<wbr>Task</a></dt><dt><a class="struct" href="struct.AlterTableTasks.html" title="struct api::v1::meta::AlterTableTasks">Alter<wbr>Table<wbr>Tasks</a></dt><dt><a class="struct" href="struct.AskLeaderRequest.html" title="struct api::v1::meta::AskLeaderRequest">AskLeader<wbr>Request</a></dt><dt><a class="struct" href="struct.AskLeaderResponse.html" title="struct api::v1::meta::AskLeaderResponse">AskLeader<wbr>Response</a></dt><dt><a class="struct" href="struct.BatchDeleteRequest.html" title="struct api::v1::meta::BatchDeleteRequest">Batch<wbr>Delete<wbr>Request</a></dt><dt><a class="struct" href="struct.BatchDeleteResponse.html" title="struct api::v1::meta::BatchDeleteResponse">Batch<wbr>Delete<wbr>Response</a></dt><dt><a class="struct" href="struct.BatchGetRequest.html" title="struct api::v1::meta::BatchGetRequest">Batch<wbr>GetRequest</a></dt><dt><a class="struct" href="struct.BatchGetResponse.html" title="struct api::v1::meta::BatchGetResponse">Batch<wbr>GetResponse</a></dt><dt><a class="struct" href="struct.BatchPutRequest.html" title="struct api::v1::meta::BatchPutRequest">Batch<wbr>PutRequest</a></dt><dt><a class="struct" href="struct.BatchPutResponse.html" title="struct api::v1::meta::BatchPutResponse">Batch<wbr>PutResponse</a></dt><dt><a class="struct" href="struct.CommentOnTask.html" title="struct api::v1::meta::CommentOnTask">Comment<wbr>OnTask</a></dt><dt><a class="struct" href="struct.CompareAndPutRequest.html" title="struct api::v1::meta::CompareAndPutRequest">Compare<wbr>AndPut<wbr>Request</a></dt><dt><a class="struct" href="struct.CompareAndPutResponse.html" title="struct api::v1::meta::CompareAndPutResponse">Compare<wbr>AndPut<wbr>Response</a></dt><dt><a class="struct" href="struct.CreateDatabaseTask.html" title="struct api::v1::meta::CreateDatabaseTask">Create<wbr>Database<wbr>Task</a></dt><dt><a class="struct" href="struct.CreateFlowTask.html" title="struct api::v1::meta::CreateFlowTask">Create<wbr>Flow<wbr>Task</a></dt><dt><a class="struct" href="struct.CreateTableTask.html" title="struct api::v1::meta::CreateTableTask">Create<wbr>Table<wbr>Task</a></dt><dt><a class="struct" href="struct.CreateTableTasks.html" title="struct api::v1::meta::CreateTableTasks">Create<wbr>Table<wbr>Tasks</a></dt><dt><a class="struct" href="struct.CreateTriggerTask.html" title="struct api::v1::meta::CreateTriggerTask">Create<wbr>Trigger<wbr>Task</a></dt><dt><a class="struct" href="struct.CreateViewTask.html" title="struct api::v1::meta::CreateViewTask">Create<wbr>View<wbr>Task</a></dt><dd>Create a view task</dd><dt><a class="struct" href="struct.DatanodeWorkloads.html" title="struct api::v1::meta::DatanodeWorkloads">Datanode<wbr>Workloads</a></dt><dd>/ The workload types of the datanode.</dd><dt><a class="struct" href="struct.DdlTaskRequest.html" title="struct api::v1::meta::DdlTaskRequest">DdlTask<wbr>Request</a></dt><dt><a class="struct" href="struct.DdlTaskResponse.html" title="struct api::v1::meta::DdlTaskResponse">DdlTask<wbr>Response</a></dt><dt><a class="struct" href="struct.DeleteRangeRequest.html" title="struct api::v1::meta::DeleteRangeRequest">Delete<wbr>Range<wbr>Request</a></dt><dt><a class="struct" href="struct.DeleteRangeResponse.html" title="struct api::v1::meta::DeleteRangeResponse">Delete<wbr>Range<wbr>Response</a></dt><dt><a class="struct" href="struct.DropDatabaseTask.html" title="struct api::v1::meta::DropDatabaseTask">Drop<wbr>Database<wbr>Task</a></dt><dt><a class="struct" href="struct.DropFlowTask.html" title="struct api::v1::meta::DropFlowTask">Drop<wbr>Flow<wbr>Task</a></dt><dt><a class="struct" href="struct.DropTableTask.html" title="struct api::v1::meta::DropTableTask">Drop<wbr>Table<wbr>Task</a></dt><dt><a class="struct" href="struct.DropTableTasks.html" title="struct api::v1::meta::DropTableTasks">Drop<wbr>Table<wbr>Tasks</a></dt><dt><a class="struct" href="struct.DropTriggerTask.html" title="struct api::v1::meta::DropTriggerTask">Drop<wbr>Trigger<wbr>Task</a></dt><dt><a class="struct" href="struct.DropViewTask.html" title="struct api::v1::meta::DropViewTask">Drop<wbr>View<wbr>Task</a></dt><dd>Drop a view task</dd><dt><a class="struct" href="struct.Error.html" title="struct api::v1::meta::Error">Error</a></dt><dt><a class="struct" href="struct.FlowStat.html" title="struct api::v1::meta::FlowStat">Flow<wbr>Stat</a></dt><dt><a class="struct" href="struct.FlownodeWorkloads.html" title="struct api::v1::meta::FlownodeWorkloads">Flownode<wbr>Workloads</a></dt><dd>/ The workload types of the flownode.</dd><dt><a class="struct" href="struct.FrontendWorkloads.html" title="struct api::v1::meta::FrontendWorkloads">Frontend<wbr>Workloads</a></dt><dd>/ The workload types of the frontend.</dd><dt><a class="struct" href="struct.GcRegionsRequest.html" title="struct api::v1::meta::GcRegionsRequest">GcRegions<wbr>Request</a></dt><dt><a class="struct" href="struct.GcRegionsResponse.html" title="struct api::v1::meta::GcRegionsResponse">GcRegions<wbr>Response</a></dt><dt><a class="struct" href="struct.GcStats.html" title="struct api::v1::meta::GcStats">GcStats</a></dt><dt><a class="struct" href="struct.GcTableRequest.html" title="struct api::v1::meta::GcTableRequest">GcTable<wbr>Request</a></dt><dt><a class="struct" href="struct.GcTableResponse.html" title="struct api::v1::meta::GcTableResponse">GcTable<wbr>Response</a></dt><dt><a class="struct" href="struct.GrantedRegion.html" title="struct api::v1::meta::GrantedRegion">Granted<wbr>Region</a></dt><dd>The granted region is the region that the meta server granted leases.</dd><dt><a class="struct" href="struct.HeartbeatConfig.html" title="struct api::v1::meta::HeartbeatConfig">Heartbeat<wbr>Config</a></dt><dt><a class="struct" href="struct.HeartbeatRequest.html" title="struct api::v1::meta::HeartbeatRequest">Heartbeat<wbr>Request</a></dt><dt><a class="struct" href="struct.HeartbeatResponse.html" title="struct api::v1::meta::HeartbeatResponse">Heartbeat<wbr>Response</a></dt><dt><a class="struct" href="struct.KeyValue.html" title="struct api::v1::meta::KeyValue">KeyValue</a></dt><dt><a class="struct" href="struct.LockRequest.html" title="struct api::v1::meta::LockRequest">Lock<wbr>Request</a></dt><dt><a class="struct" href="struct.LockResponse.html" title="struct api::v1::meta::LockResponse">Lock<wbr>Response</a></dt><dt><a class="struct" href="struct.MailboxMessage.html" title="struct api::v1::meta::MailboxMessage">Mailbox<wbr>Message</a></dt><dt><a class="struct" href="struct.MailboxMessageHeader.html" title="struct api::v1::meta::MailboxMessageHeader">Mailbox<wbr>Message<wbr>Header</a></dt><dt><a class="struct" href="struct.MetasrvNodeInfo.html" title="struct api::v1::meta::MetasrvNodeInfo">Metasrv<wbr>Node<wbr>Info</a></dt><dt><a class="struct" href="struct.MetasrvPeersRequest.html" title="struct api::v1::meta::MetasrvPeersRequest">Metasrv<wbr>Peers<wbr>Request</a></dt><dt><a class="struct" href="struct.MetasrvPeersResponse.html" title="struct api::v1::meta::MetasrvPeersResponse">Metasrv<wbr>Peers<wbr>Response</a></dt><dt><a class="struct" href="struct.MigrateRegionRequest.html" title="struct api::v1::meta::MigrateRegionRequest">Migrate<wbr>Region<wbr>Request</a></dt><dt><a class="struct" href="struct.MigrateRegionResponse.html" title="struct api::v1::meta::MigrateRegionResponse">Migrate<wbr>Region<wbr>Response</a></dt><dt><a class="struct" href="struct.NodeInfo.html" title="struct api::v1::meta::NodeInfo">Node<wbr>Info</a></dt><dt><a class="struct" href="struct.Partition.html" title="struct api::v1::meta::Partition">Partition</a></dt><dd>Partition definition.</dd><dt><a class="struct" href="struct.Peer.html" title="struct api::v1::meta::Peer">Peer</a></dt><dt><a class="struct" href="struct.PeerDict.html" title="struct api::v1::meta::PeerDict">Peer<wbr>Dict</a></dt><dt><a class="struct" href="struct.ProcedureDetailRequest.html" title="struct api::v1::meta::ProcedureDetailRequest">Procedure<wbr>Detail<wbr>Request</a></dt><dt><a class="struct" href="struct.ProcedureDetailResponse.html" title="struct api::v1::meta::ProcedureDetailResponse">Procedure<wbr>Detail<wbr>Response</a></dt><dt><a class="struct" href="struct.ProcedureId.html" title="struct api::v1::meta::ProcedureId">Procedure<wbr>Id</a></dt><dd>Procedure identifier</dd><dt><a class="struct" href="struct.ProcedureMeta.html" title="struct api::v1::meta::ProcedureMeta">Procedure<wbr>Meta</a></dt><dt><a class="struct" href="struct.ProcedureStateResponse.html" title="struct api::v1::meta::ProcedureStateResponse">Procedure<wbr>State<wbr>Response</a></dt><dt><a class="struct" href="struct.PullConfigRequest.html" title="struct api::v1::meta::PullConfigRequest">Pull<wbr>Config<wbr>Request</a></dt><dt><a class="struct" href="struct.PullConfigResponse.html" title="struct api::v1::meta::PullConfigResponse">Pull<wbr>Config<wbr>Response</a></dt><dt><a class="struct" href="struct.PutRequest.html" title="struct api::v1::meta::PutRequest">PutRequest</a></dt><dt><a class="struct" href="struct.PutResponse.html" title="struct api::v1::meta::PutResponse">PutResponse</a></dt><dt><a class="struct" href="struct.QueryProcedureRequest.html" title="struct api::v1::meta::QueryProcedureRequest">Query<wbr>Procedure<wbr>Request</a></dt><dt><a class="struct" href="struct.RangeRequest.html" title="struct api::v1::meta::RangeRequest">Range<wbr>Request</a></dt><dt><a class="struct" href="struct.RangeResponse.html" title="struct api::v1::meta::RangeResponse">Range<wbr>Response</a></dt><dt><a class="struct" href="struct.ReconcileCatalog.html" title="struct api::v1::meta::ReconcileCatalog">Reconcile<wbr>Catalog</a></dt><dt><a class="struct" href="struct.ReconcileDatabase.html" title="struct api::v1::meta::ReconcileDatabase">Reconcile<wbr>Database</a></dt><dt><a class="struct" href="struct.ReconcileRequest.html" title="struct api::v1::meta::ReconcileRequest">Reconcile<wbr>Request</a></dt><dt><a class="struct" href="struct.ReconcileResponse.html" title="struct api::v1::meta::ReconcileResponse">Reconcile<wbr>Response</a></dt><dt><a class="struct" href="struct.ReconcileTable.html" title="struct api::v1::meta::ReconcileTable">Reconcile<wbr>Table</a></dt><dt><a class="struct" href="struct.Region.html" title="struct api::v1::meta::Region">Region</a></dt><dt><a class="struct" href="struct.RegionLease.html" title="struct api::v1::meta::RegionLease">Region<wbr>Lease</a></dt><dt><a class="struct" href="struct.RegionRoute.html" title="struct api::v1::meta::RegionRoute">Region<wbr>Route</a></dt><dt><a class="struct" href="struct.RegionStat.html" title="struct api::v1::meta::RegionStat">Region<wbr>Stat</a></dt><dt><a class="struct" href="struct.RequestHeader.html" title="struct api::v1::meta::RequestHeader">Request<wbr>Header</a></dt><dt><a class="struct" href="struct.ResponseHeader.html" title="struct api::v1::meta::ResponseHeader">Response<wbr>Header</a></dt><dt><a class="struct" href="struct.Table.html" title="struct api::v1::meta::Table">Table</a></dt><dt><a class="struct" href="struct.TableRoute.html" title="struct api::v1::meta::TableRoute">Table<wbr>Route</a></dt><dt><a class="struct" href="struct.TableRouteValue.html" title="struct api::v1::meta::TableRouteValue">Table<wbr>Route<wbr>Value</a></dt><dd>This message is only for saving into store.
|
|
TODO(weny): Remove it, Now, the upgrade tool is still dependent on it.</dd><dt><a class="struct" href="struct.TimeInterval.html" title="struct api::v1::meta::TimeInterval">Time<wbr>Interval</a></dt><dt><a class="struct" href="struct.TopicStat.html" title="struct api::v1::meta::TopicStat">Topic<wbr>Stat</a></dt><dt><a class="struct" href="struct.TruncateTableTask.html" title="struct api::v1::meta::TruncateTableTask">Truncate<wbr>Table<wbr>Task</a></dt><dt><a class="struct" href="struct.UnlockRequest.html" title="struct api::v1::meta::UnlockRequest">Unlock<wbr>Request</a></dt><dt><a class="struct" href="struct.UnlockResponse.html" title="struct api::v1::meta::UnlockResponse">Unlock<wbr>Response</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.DdlTaskType.html" title="enum api::v1::meta::DdlTaskType">DdlTask<wbr>Type</a></dt><dt><a class="enum" href="enum.ErrorCode.html" title="enum api::v1::meta::ErrorCode">Error<wbr>Code</a></dt><dt><a class="enum" href="enum.ProcedureStatus.html" title="enum api::v1::meta::ProcedureStatus">Procedure<wbr>Status</a></dt><dt><a class="enum" href="enum.RegionRole.html" title="enum api::v1::meta::RegionRole">Region<wbr>Role</a></dt><dt><a class="enum" href="enum.ResolveStrategy.html" title="enum api::v1::meta::ResolveStrategy">Resolve<wbr>Strategy</a></dt><dt><a class="enum" href="enum.Role.html" title="enum api::v1::meta::Role">Role</a></dt></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.PROTOCOL_VERSION.html" title="constant api::v1::meta::PROTOCOL_VERSION">PROTOCOL_<wbr>VERSION</a></dt></dl></section></div></main></body></html> |