mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-07-06 14:00:40 +00:00
115 lines
14 KiB
HTML
115 lines
14 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="Source of the Rust file `src/store-api/src/logstore.rs`."><title>logstore.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><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]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">store_api/</div>logstore.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
|
|
<a href=#2 id=2 data-nosnippet>2</a>//
|
|
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
|
|
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
|
|
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
|
|
<a href=#6 id=6 data-nosnippet>6</a>//
|
|
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
|
|
<a href=#8 id=8 data-nosnippet>8</a>//
|
|
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
|
|
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
|
|
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
|
|
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
|
|
<a href=#14 id=14 data-nosnippet>14</a>
|
|
<a href=#15 id=15 data-nosnippet>15</a></span><span class="doccomment">//! LogStore APIs.
|
|
<a href=#16 id=16 data-nosnippet>16</a>
|
|
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">pub mod </span>entry;
|
|
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">pub mod </span>provider;
|
|
<a href=#19 id=19 data-nosnippet>19</a>
|
|
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>std::collections::HashMap;
|
|
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>std::pin::Pin;
|
|
<a href=#22 id=22 data-nosnippet>22</a>
|
|
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>common_error::ext::ErrorExt;
|
|
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>entry::Entry;
|
|
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>futures::Stream;
|
|
<a href=#26 id=26 data-nosnippet>26</a>
|
|
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">pub type </span>SendableEntryStream<<span class="lifetime">'a</span>, I, E> = Pin<Box<<span class="kw">dyn </span>Stream<Item = <span class="prelude-ty">Result</span><Vec<I>, E>> + Send + <span class="lifetime">'a</span>>>;
|
|
<a href=#28 id=28 data-nosnippet>28</a>
|
|
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">pub use </span><span class="kw">crate</span>::logstore::entry::Id <span class="kw">as </span>EntryId;
|
|
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">use </span><span class="kw">crate</span>::logstore::provider::Provider;
|
|
<a href=#31 id=31 data-nosnippet>31</a><span class="kw">use </span><span class="kw">crate</span>::storage::RegionId;
|
|
<a href=#32 id=32 data-nosnippet>32</a>
|
|
<a href=#33 id=33 data-nosnippet>33</a><span class="comment">// The information used to locate WAL index for the specified region.
|
|
<a href=#34 id=34 data-nosnippet>34</a></span><span class="attr">#[derive(Debug, Clone, Copy)]
|
|
<a href=#35 id=35 data-nosnippet>35</a></span><span class="kw">pub struct </span>WalIndex {
|
|
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">pub </span>region_id: RegionId,
|
|
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">pub </span>location_id: u64,
|
|
<a href=#38 id=38 data-nosnippet>38</a>}
|
|
<a href=#39 id=39 data-nosnippet>39</a>
|
|
<a href=#40 id=40 data-nosnippet>40</a><span class="kw">impl </span>WalIndex {
|
|
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw">pub fn </span>new(region_id: RegionId, location_id: u64) -> <span class="self">Self </span>{
|
|
<a href=#42 id=42 data-nosnippet>42</a> <span class="self">Self </span>{
|
|
<a href=#43 id=43 data-nosnippet>43</a> region_id,
|
|
<a href=#44 id=44 data-nosnippet>44</a> location_id,
|
|
<a href=#45 id=45 data-nosnippet>45</a> }
|
|
<a href=#46 id=46 data-nosnippet>46</a> }
|
|
<a href=#47 id=47 data-nosnippet>47</a>}
|
|
<a href=#48 id=48 data-nosnippet>48</a>
|
|
<a href=#49 id=49 data-nosnippet>49</a><span class="doccomment">/// `LogStore` serves as a Write-Ahead-Log for storage engine.
|
|
<a href=#50 id=50 data-nosnippet>50</a></span><span class="attr">#[async_trait::async_trait]
|
|
<a href=#51 id=51 data-nosnippet>51</a></span><span class="kw">pub trait </span>LogStore: Send + Sync + <span class="lifetime">'static </span>+ std::fmt::Debug {
|
|
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">type </span>Error: ErrorExt + Send + Sync + <span class="lifetime">'static</span>;
|
|
<a href=#53 id=53 data-nosnippet>53</a>
|
|
<a href=#54 id=54 data-nosnippet>54</a> <span class="doccomment">/// Stops components of the logstore.
|
|
<a href=#55 id=55 data-nosnippet>55</a> </span><span class="kw">async fn </span>stop(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>;
|
|
<a href=#56 id=56 data-nosnippet>56</a>
|
|
<a href=#57 id=57 data-nosnippet>57</a> <span class="doccomment">/// Appends a batch of entries and returns a response containing a map where the key is a region id
|
|
<a href=#58 id=58 data-nosnippet>58</a> /// while the value is the id of the last successfully written entry of the region.
|
|
<a href=#59 id=59 data-nosnippet>59</a> </span><span class="kw">async fn </span>append_batch(<span class="kw-2">&</span><span class="self">self</span>, entries: Vec<Entry>) -> <span class="prelude-ty">Result</span><AppendBatchResponse, <span class="self">Self</span>::Error>;
|
|
<a href=#60 id=60 data-nosnippet>60</a>
|
|
<a href=#61 id=61 data-nosnippet>61</a> <span class="doccomment">/// Creates a new `EntryStream` to asynchronously generates `Entry` with ids
|
|
<a href=#62 id=62 data-nosnippet>62</a> /// starting from `id`.
|
|
<a href=#63 id=63 data-nosnippet>63</a> </span><span class="kw">async fn </span>read(
|
|
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw-2">&</span><span class="self">self</span>,
|
|
<a href=#65 id=65 data-nosnippet>65</a> provider: <span class="kw-2">&</span>Provider,
|
|
<a href=#66 id=66 data-nosnippet>66</a> id: EntryId,
|
|
<a href=#67 id=67 data-nosnippet>67</a> index: <span class="prelude-ty">Option</span><WalIndex>,
|
|
<a href=#68 id=68 data-nosnippet>68</a> ) -> <span class="prelude-ty">Result</span><SendableEntryStream<<span class="lifetime">'static</span>, Entry, <span class="self">Self</span>::Error>, <span class="self">Self</span>::Error>;
|
|
<a href=#69 id=69 data-nosnippet>69</a>
|
|
<a href=#70 id=70 data-nosnippet>70</a> <span class="doccomment">/// Creates a new `Namespace` from the given ref.
|
|
<a href=#71 id=71 data-nosnippet>71</a> </span><span class="kw">async fn </span>create_namespace(<span class="kw-2">&</span><span class="self">self</span>, ns: <span class="kw-2">&</span>Provider) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>;
|
|
<a href=#72 id=72 data-nosnippet>72</a>
|
|
<a href=#73 id=73 data-nosnippet>73</a> <span class="doccomment">/// Deletes an existing `Namespace` specified by the given ref.
|
|
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="kw">async fn </span>delete_namespace(<span class="kw-2">&</span><span class="self">self</span>, ns: <span class="kw-2">&</span>Provider) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>;
|
|
<a href=#75 id=75 data-nosnippet>75</a>
|
|
<a href=#76 id=76 data-nosnippet>76</a> <span class="doccomment">/// Lists all existing namespaces.
|
|
<a href=#77 id=77 data-nosnippet>77</a> </span><span class="kw">async fn </span>list_namespaces(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><Vec<Provider>, <span class="self">Self</span>::Error>;
|
|
<a href=#78 id=78 data-nosnippet>78</a>
|
|
<a href=#79 id=79 data-nosnippet>79</a> <span class="doccomment">/// Marks all entries with ids `<=entry_id` of the given `namespace` as obsolete,
|
|
<a href=#80 id=80 data-nosnippet>80</a> /// so that the log store can safely delete those entries. This method does not guarantee
|
|
<a href=#81 id=81 data-nosnippet>81</a> /// that the obsolete entries are deleted immediately.
|
|
<a href=#82 id=82 data-nosnippet>82</a> </span><span class="kw">async fn </span>obsolete(
|
|
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw-2">&</span><span class="self">self</span>,
|
|
<a href=#84 id=84 data-nosnippet>84</a> provider: <span class="kw-2">&</span>Provider,
|
|
<a href=#85 id=85 data-nosnippet>85</a> region_id: RegionId,
|
|
<a href=#86 id=86 data-nosnippet>86</a> entry_id: EntryId,
|
|
<a href=#87 id=87 data-nosnippet>87</a> ) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>;
|
|
<a href=#88 id=88 data-nosnippet>88</a>
|
|
<a href=#89 id=89 data-nosnippet>89</a> <span class="doccomment">/// Makes an entry instance of the associated Entry type
|
|
<a href=#90 id=90 data-nosnippet>90</a> </span><span class="kw">fn </span>entry(
|
|
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw-2">&</span><span class="self">self</span>,
|
|
<a href=#92 id=92 data-nosnippet>92</a> data: Vec<u8>,
|
|
<a href=#93 id=93 data-nosnippet>93</a> entry_id: EntryId,
|
|
<a href=#94 id=94 data-nosnippet>94</a> region_id: RegionId,
|
|
<a href=#95 id=95 data-nosnippet>95</a> provider: <span class="kw-2">&</span>Provider,
|
|
<a href=#96 id=96 data-nosnippet>96</a> ) -> <span class="prelude-ty">Result</span><Entry, <span class="self">Self</span>::Error>;
|
|
<a href=#97 id=97 data-nosnippet>97</a>
|
|
<a href=#98 id=98 data-nosnippet>98</a> <span class="doccomment">/// Returns the latest entry id in the log store.
|
|
<a href=#99 id=99 data-nosnippet>99</a> </span><span class="kw">fn </span>latest_entry_id(<span class="kw-2">&</span><span class="self">self</span>, provider: <span class="kw-2">&</span>Provider) -> <span class="prelude-ty">Result</span><EntryId, <span class="self">Self</span>::Error>;
|
|
<a href=#100 id=100 data-nosnippet>100</a>}
|
|
<a href=#101 id=101 data-nosnippet>101</a>
|
|
<a href=#102 id=102 data-nosnippet>102</a><span class="doccomment">/// The response of an `append` operation.
|
|
<a href=#103 id=103 data-nosnippet>103</a></span><span class="attr">#[derive(Debug, Default)]
|
|
<a href=#104 id=104 data-nosnippet>104</a></span><span class="kw">pub struct </span>AppendResponse {
|
|
<a href=#105 id=105 data-nosnippet>105</a> <span class="doccomment">/// The id of the entry appended to the log store.
|
|
<a href=#106 id=106 data-nosnippet>106</a> </span><span class="kw">pub </span>last_entry_id: EntryId,
|
|
<a href=#107 id=107 data-nosnippet>107</a>}
|
|
<a href=#108 id=108 data-nosnippet>108</a>
|
|
<a href=#109 id=109 data-nosnippet>109</a><span class="doccomment">/// The response of an `append_batch` operation.
|
|
<a href=#110 id=110 data-nosnippet>110</a></span><span class="attr">#[derive(Debug, Default)]
|
|
<a href=#111 id=111 data-nosnippet>111</a></span><span class="kw">pub struct </span>AppendBatchResponse {
|
|
<a href=#112 id=112 data-nosnippet>112</a> <span class="doccomment">/// Key: region id (as u64). Value: the id of the last successfully written entry of the region.
|
|
<a href=#113 id=113 data-nosnippet>113</a> </span><span class="kw">pub </span>last_entry_ids: HashMap<RegionId, EntryId>,
|
|
<a href=#114 id=114 data-nosnippet>114</a>}
|
|
</code></pre></div></section></main></body></html> |