rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-01-06 21:32:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
greptimedb/store_api/storage/index.html
github-merge-queue[bot] e35339bc52 Deploying to gh-pages from @ GreptimeTeam/greptimedb@ada4666e10 🚀
2026-01-06 14:05:21 +00:00

6 lines
11 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Storage APIs."><title>store_api::storage - 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="store_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 storage</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-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module storage</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><li><a href="#traits" title="Traits">Traits</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">store_api</a></div><h1>Module <span>storage</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/store_api/storage.rs.html#15-34">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Storage APIs.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="consts/index.html" title="mod store_api::storage::consts">consts</a></dt><dd>Constants.</dd><dt><a class="mod" href="descriptors/index.html" title="mod store_api::storage::descriptors">descriptors</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="file/index.html" title="mod store_api::storage::file">file</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="requests/index.html" title="mod store_api::storage::requests">requests</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="types/index.html" title="mod store_api::storage::types">types</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Common types.</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.ColumnDescriptor.html" title="struct store_api::storage::ColumnDescriptor">Column<wbr>Descriptor</a></dt><dd>A <a href="struct.ColumnDescriptor.html" title="struct store_api::storage::ColumnDescriptor">ColumnDescriptor</a> contains information to create a column.</dd><dt><a class="struct" href="struct.ColumnDescriptorBuilder.html" title="struct store_api::storage::ColumnDescriptorBuilder">Column<wbr>Descriptor<wbr>Builder</a></dt><dd>Builder for <a href="struct.ColumnDescriptor.html"><code>ColumnDescriptor</code></a>.</dd><dt><a class="struct" href="struct.ColumnSchema.html" title="struct store_api::storage::ColumnSchema">Column<wbr>Schema</a></dt><dd>Schema of a column, used as an immutable struct.</dd><dt><a class="struct" href="struct.FileId.html" title="struct store_api::storage::FileId">FileId</a></dt><dd>Unique id for [SST File].</dd><dt><a class="struct" href="struct.FileRef.html" title="struct store_api::storage::FileRef">FileRef</a></dt><dt><a class="struct" href="struct.FileRefsManifest.html" title="struct store_api::storage::FileRefsManifest">File<wbr>Refs<wbr>Manifest</a></dt><dd>The tmp file manifest which record a table’s file references.
Also record the manifest version when these tmp files are read.</dd><dt><a class="struct" href="struct.GcReport.html" title="struct store_api::storage::GcReport">GcReport</a></dt><dt><a class="struct" href="struct.ParseIdError.html" title="struct store_api::storage::ParseIdError">Parse<wbr>IdError</a></dt><dt><a class="struct" href="struct.RegionId.html" title="struct store_api::storage::RegionId">Region<wbr>Id</a></dt><dd>Id of the region. It’s generated by concatenating table id, region group and region number.</dd><dt><a class="struct" href="struct.ScanRequest.html" title="struct store_api::storage::ScanRequest">Scan<wbr>Request</a></dt><dt><a class="struct" href="struct.Schema.html" title="struct store_api::storage::Schema">Schema</a></dt><dd>A common schema, should be immutable.</dd><dt><a class="struct" href="struct.SchemaBuilder.html" title="struct store_api::storage::SchemaBuilder">Schema<wbr>Builder</a></dt><dt><a class="struct" href="struct.VectorSearchMatches.html" title="struct store_api::storage::VectorSearchMatches">Vector<wbr>Search<wbr>Matches</a></dt><dd>Search results from vector index.</dd><dt><a class="struct" href="struct.VectorSearchRequest.html" title="struct store_api::storage::VectorSearchRequest">Vector<wbr>Search<wbr>Request</a></dt><dd>A hint for KNN vector search.</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.ColumnDefaultConstraint.html" title="enum store_api::storage::ColumnDefaultConstraint">Column<wbr>Default<wbr>Constraint</a></dt><dd>Column’s default constraint.</dd><dt><a class="enum" href="enum.ColumnDescriptorBuilderError.html" title="enum store_api::storage::ColumnDescriptorBuilderError">Column<wbr>Descriptor<wbr>Builder<wbr>Error</a></dt><dd>Error type for ColumnDescriptorBuilder</dd><dt><a class="enum" href="enum.ConcreteDataType.html" title="enum store_api::storage::ConcreteDataType">Concrete<wbr>Data<wbr>Type</a></dt><dt><a class="enum" href="enum.SequenceRange.html" title="enum store_api::storage::SequenceRange">Sequence<wbr>Range</a></dt><dd>A range of sequence numbers.</dd><dt><a class="enum" href="enum.TimeSeriesDistribution.html" title="enum store_api::storage::TimeSeriesDistribution">Time<wbr>Series<wbr>Distribution</a></dt><dd>A hint on how to distribute time-series data on the scan output.</dd><dt><a class="enum" href="enum.TimeSeriesRowSelector.html" title="enum store_api::storage::TimeSeriesRowSelector">Time<wbr>Series<wbr>RowSelector</a></dt><dd>A hint on how to select rows from a time-series.</dd><dt><a class="enum" href="enum.VectorDistanceMetric.html" title="enum store_api::storage::VectorDistanceMetric">Vector<wbr>Distance<wbr>Metric</a></dt><dd>Distance metric for vector similarity search.</dd><dt><a class="enum" href="enum.VectorIndexEngineType.html" title="enum store_api::storage::VectorIndexEngineType">Vector<wbr>Index<wbr>Engine<wbr>Type</a></dt><dd>Supported vector index engine types.</dd></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.MAX_REGION_SEQ.html" title="constant store_api::storage::MAX_REGION_SEQ">MAX_<wbr>REGION_<wbr>SEQ</a></dt><dd>The max valid region sequence number.</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.VectorIndexEngine.html" title="trait store_api::storage::VectorIndexEngine">Vector<wbr>Index<wbr>Engine</a></dt><dd>Trait for vector index engines (HNSW implementations).</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.ColumnId.html" title="type store_api::storage::ColumnId">Column<wbr>Id</a></dt><dd>Id of column. Unique in each region.</dd><dt><a class="type" href="type.IndexVersion.html" title="type store_api::storage::IndexVersion">Index<wbr>Version</a></dt><dd>Index version</dd><dt><a class="type" href="type.RegionGroup.html" title="type store_api::storage::RegionGroup">Region<wbr>Group</a></dt><dd>Group number of one region. Unique in each region.</dd><dt><a class="type" href="type.RegionNumber.html" title="type store_api::storage::RegionNumber">Region<wbr>Number</a></dt><dd>Id of regions under the same table. Unique in each table.
Is composed by <a href="type.RegionGroup.html" title="type store_api::storage::RegionGroup">RegionGroup</a> and <a href="type.RegionSeq.html" title="type store_api::storage::RegionSeq">RegionSeq</a>.</dd><dt><a class="type" href="type.RegionSeq.html" title="type store_api::storage::RegionSeq">Region<wbr>Seq</a></dt><dd>Sequence number of region inside one table. Unique in each table.
The first 8 bits are preserved for <a href="type.RegionGroup.html" title="type store_api::storage::RegionGroup">RegionGroup</a>.</dd><dt><a class="type" href="type.SchemaRef.html" title="type store_api::storage::SchemaRef">Schema<wbr>Ref</a></dt><dt><a class="type" href="type.SequenceNumber.html" title="type store_api::storage::SequenceNumber">Sequence<wbr>Number</a></dt><dd>Represents a sequence number of data in storage. The offset of logstore can be used
as a sequence number.</dd><dt><a class="type" href="type.TableId.html" title="type store_api::storage::TableId">TableId</a></dt><dd>Id of table. Universal unique.</dd></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink