| <!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 `parquet/src/arrow/async_reader/store.rs`."><title>store.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="parquet" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (8c127df75 2024-05-16)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../../../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[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"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a> |
| <a href="#2" id="2">2</a> |
| <a href="#3" id="3">3</a> |
| <a href="#4" id="4">4</a> |
| <a href="#5" id="5">5</a> |
| <a href="#6" id="6">6</a> |
| <a href="#7" id="7">7</a> |
| <a href="#8" id="8">8</a> |
| <a href="#9" id="9">9</a> |
| <a href="#10" id="10">10</a> |
| <a href="#11" id="11">11</a> |
| <a href="#12" id="12">12</a> |
| <a href="#13" id="13">13</a> |
| <a href="#14" id="14">14</a> |
| <a href="#15" id="15">15</a> |
| <a href="#16" id="16">16</a> |
| <a href="#17" id="17">17</a> |
| <a href="#18" id="18">18</a> |
| <a href="#19" id="19">19</a> |
| <a href="#20" id="20">20</a> |
| <a href="#21" id="21">21</a> |
| <a href="#22" id="22">22</a> |
| <a href="#23" id="23">23</a> |
| <a href="#24" id="24">24</a> |
| <a href="#25" id="25">25</a> |
| <a href="#26" id="26">26</a> |
| <a href="#27" id="27">27</a> |
| <a href="#28" id="28">28</a> |
| <a href="#29" id="29">29</a> |
| <a href="#30" id="30">30</a> |
| <a href="#31" id="31">31</a> |
| <a href="#32" id="32">32</a> |
| <a href="#33" id="33">33</a> |
| <a href="#34" id="34">34</a> |
| <a href="#35" id="35">35</a> |
| <a href="#36" id="36">36</a> |
| <a href="#37" id="37">37</a> |
| <a href="#38" id="38">38</a> |
| <a href="#39" id="39">39</a> |
| <a href="#40" id="40">40</a> |
| <a href="#41" id="41">41</a> |
| <a href="#42" id="42">42</a> |
| <a href="#43" id="43">43</a> |
| <a href="#44" id="44">44</a> |
| <a href="#45" id="45">45</a> |
| <a href="#46" id="46">46</a> |
| <a href="#47" id="47">47</a> |
| <a href="#48" id="48">48</a> |
| <a href="#49" id="49">49</a> |
| <a href="#50" id="50">50</a> |
| <a href="#51" id="51">51</a> |
| <a href="#52" id="52">52</a> |
| <a href="#53" id="53">53</a> |
| <a href="#54" id="54">54</a> |
| <a href="#55" id="55">55</a> |
| <a href="#56" id="56">56</a> |
| <a href="#57" id="57">57</a> |
| <a href="#58" id="58">58</a> |
| <a href="#59" id="59">59</a> |
| <a href="#60" id="60">60</a> |
| <a href="#61" id="61">61</a> |
| <a href="#62" id="62">62</a> |
| <a href="#63" id="63">63</a> |
| <a href="#64" id="64">64</a> |
| <a href="#65" id="65">65</a> |
| <a href="#66" id="66">66</a> |
| <a href="#67" id="67">67</a> |
| <a href="#68" id="68">68</a> |
| <a href="#69" id="69">69</a> |
| <a href="#70" id="70">70</a> |
| <a href="#71" id="71">71</a> |
| <a href="#72" id="72">72</a> |
| <a href="#73" id="73">73</a> |
| <a href="#74" id="74">74</a> |
| <a href="#75" id="75">75</a> |
| <a href="#76" id="76">76</a> |
| <a href="#77" id="77">77</a> |
| <a href="#78" id="78">78</a> |
| <a href="#79" id="79">79</a> |
| <a href="#80" id="80">80</a> |
| <a href="#81" id="81">81</a> |
| <a href="#82" id="82">82</a> |
| <a href="#83" id="83">83</a> |
| <a href="#84" id="84">84</a> |
| <a href="#85" id="85">85</a> |
| <a href="#86" id="86">86</a> |
| <a href="#87" id="87">87</a> |
| <a href="#88" id="88">88</a> |
| <a href="#89" id="89">89</a> |
| <a href="#90" id="90">90</a> |
| <a href="#91" id="91">91</a> |
| <a href="#92" id="92">92</a> |
| <a href="#93" id="93">93</a> |
| <a href="#94" id="94">94</a> |
| <a href="#95" id="95">95</a> |
| <a href="#96" id="96">96</a> |
| <a href="#97" id="97">97</a> |
| <a href="#98" id="98">98</a> |
| <a href="#99" id="99">99</a> |
| <a href="#100" id="100">100</a> |
| <a href="#101" id="101">101</a> |
| <a href="#102" id="102">102</a> |
| <a href="#103" id="103">103</a> |
| <a href="#104" id="104">104</a> |
| <a href="#105" id="105">105</a> |
| <a href="#106" id="106">106</a> |
| <a href="#107" id="107">107</a> |
| <a href="#108" id="108">108</a> |
| <a href="#109" id="109">109</a> |
| <a href="#110" id="110">110</a> |
| <a href="#111" id="111">111</a> |
| <a href="#112" id="112">112</a> |
| <a href="#113" id="113">113</a> |
| <a href="#114" id="114">114</a> |
| <a href="#115" id="115">115</a> |
| <a href="#116" id="116">116</a> |
| <a href="#117" id="117">117</a> |
| <a href="#118" id="118">118</a> |
| <a href="#119" id="119">119</a> |
| <a href="#120" id="120">120</a> |
| <a href="#121" id="121">121</a> |
| <a href="#122" id="122">122</a> |
| <a href="#123" id="123">123</a> |
| <a href="#124" id="124">124</a> |
| <a href="#125" id="125">125</a> |
| <a href="#126" id="126">126</a> |
| <a href="#127" id="127">127</a> |
| <a href="#128" id="128">128</a> |
| <a href="#129" id="129">129</a> |
| <a href="#130" id="130">130</a> |
| <a href="#131" id="131">131</a> |
| <a href="#132" id="132">132</a> |
| <a href="#133" id="133">133</a> |
| <a href="#134" id="134">134</a> |
| <a href="#135" id="135">135</a> |
| <a href="#136" id="136">136</a> |
| <a href="#137" id="137">137</a> |
| <a href="#138" id="138">138</a> |
| <a href="#139" id="139">139</a> |
| <a href="#140" id="140">140</a> |
| <a href="#141" id="141">141</a> |
| <a href="#142" id="142">142</a> |
| <a href="#143" id="143">143</a> |
| <a href="#144" id="144">144</a> |
| <a href="#145" id="145">145</a> |
| <a href="#146" id="146">146</a> |
| <a href="#147" id="147">147</a> |
| <a href="#148" id="148">148</a> |
| <a href="#149" id="149">149</a> |
| <a href="#150" id="150">150</a> |
| <a href="#151" id="151">151</a> |
| <a href="#152" id="152">152</a> |
| <a href="#153" id="153">153</a> |
| <a href="#154" id="154">154</a> |
| <a href="#155" id="155">155</a> |
| <a href="#156" id="156">156</a> |
| <a href="#157" id="157">157</a> |
| <a href="#158" id="158">158</a> |
| <a href="#159" id="159">159</a> |
| <a href="#160" id="160">160</a> |
| <a href="#161" id="161">161</a> |
| <a href="#162" id="162">162</a> |
| <a href="#163" id="163">163</a> |
| <a href="#164" id="164">164</a> |
| <a href="#165" id="165">165</a> |
| <a href="#166" id="166">166</a> |
| <a href="#167" id="167">167</a> |
| <a href="#168" id="168">168</a> |
| <a href="#169" id="169">169</a> |
| <a href="#170" id="170">170</a> |
| <a href="#171" id="171">171</a> |
| <a href="#172" id="172">172</a> |
| <a href="#173" id="173">173</a> |
| <a href="#174" id="174">174</a> |
| <a href="#175" id="175">175</a> |
| <a href="#176" id="176">176</a> |
| <a href="#177" id="177">177</a> |
| <a href="#178" id="178">178</a> |
| <a href="#179" id="179">179</a> |
| <a href="#180" id="180">180</a> |
| <a href="#181" id="181">181</a> |
| <a href="#182" id="182">182</a> |
| <a href="#183" id="183">183</a> |
| <a href="#184" id="184">184</a> |
| <a href="#185" id="185">185</a> |
| <a href="#186" id="186">186</a> |
| <a href="#187" id="187">187</a> |
| <a href="#188" id="188">188</a> |
| <a href="#189" id="189">189</a> |
| <a href="#190" id="190">190</a> |
| <a href="#191" id="191">191</a> |
| <a href="#192" id="192">192</a> |
| <a href="#193" id="193">193</a> |
| <a href="#194" id="194">194</a> |
| </pre></div><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| |
| </span><span class="kw">use </span>std::ops::Range; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use </span>bytes::Bytes; |
| <span class="kw">use </span>futures::future::BoxFuture; |
| <span class="kw">use </span>futures::{FutureExt, TryFutureExt}; |
| |
| <span class="kw">use </span>object_store::{ObjectMeta, ObjectStore}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::arrow::async_reader::{AsyncFileReader, MetadataLoader}; |
| <span class="kw">use </span><span class="kw">crate</span>::errors::{ParquetError, <span class="prelude-ty">Result</span>}; |
| <span class="kw">use </span><span class="kw">crate</span>::file::metadata::ParquetMetaData; |
| |
| <span class="doccomment">/// Reads Parquet files in object storage using [`ObjectStore`]. |
| /// |
| /// ```no_run |
| /// # use std::io::stdout; |
| /// # use std::sync::Arc; |
| /// # use object_store::azure::MicrosoftAzureBuilder; |
| /// # use object_store::ObjectStore; |
| /// # use object_store::path::Path; |
| /// # use parquet::arrow::async_reader::ParquetObjectReader; |
| /// # use parquet::arrow::ParquetRecordBatchStreamBuilder; |
| /// # use parquet::schema::printer::print_parquet_metadata; |
| /// # async fn run() { |
| /// // Populate configuration from environment |
| /// let storage_container = Arc::new(MicrosoftAzureBuilder::from_env().build().unwrap()); |
| /// let location = Path::from("path/to/blob.parquet"); |
| /// let meta = storage_container.head(&location).await.unwrap(); |
| /// println!("Found Blob with {}B at {}", meta.size, meta.location); |
| /// |
| /// // Show Parquet metadata |
| /// let reader = ParquetObjectReader::new(storage_container, meta); |
| /// let builder = ParquetRecordBatchStreamBuilder::new(reader).await.unwrap(); |
| /// print_parquet_metadata(&mut stdout(), builder.metadata()); |
| /// # } |
| /// ``` |
| </span><span class="attr">#[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>ParquetObjectReader { |
| store: Arc<<span class="kw">dyn </span>ObjectStore>, |
| meta: ObjectMeta, |
| metadata_size_hint: <span class="prelude-ty">Option</span><usize>, |
| preload_column_index: bool, |
| preload_offset_index: bool, |
| } |
| |
| <span class="kw">impl </span>ParquetObjectReader { |
| <span class="doccomment">/// Creates a new [`ParquetObjectReader`] for the provided [`ObjectStore`] and [`ObjectMeta`] |
| /// |
| /// [`ObjectMeta`] can be obtained using [`ObjectStore::list`] or [`ObjectStore::head`] |
| </span><span class="kw">pub fn </span>new(store: Arc<<span class="kw">dyn </span>ObjectStore>, meta: ObjectMeta) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| store, |
| meta, |
| metadata_size_hint: <span class="prelude-val">None</span>, |
| preload_column_index: <span class="bool-val">false</span>, |
| preload_offset_index: <span class="bool-val">false</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Provide a hint as to the size of the parquet file's footer, |
| /// see [fetch_parquet_metadata](crate::arrow::async_reader::fetch_parquet_metadata) |
| </span><span class="kw">pub fn </span>with_footer_size_hint(<span class="self">self</span>, hint: usize) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| metadata_size_hint: <span class="prelude-val">Some</span>(hint), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Load the Column Index as part of [`Self::get_metadata`] |
| </span><span class="kw">pub fn </span>with_preload_column_index(<span class="self">self</span>, preload_column_index: bool) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| preload_column_index, |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Load the Offset Index as part of [`Self::get_metadata`] |
| </span><span class="kw">pub fn </span>with_preload_offset_index(<span class="self">self</span>, preload_offset_index: bool) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| preload_offset_index, |
| ..<span class="self">self |
| </span>} |
| } |
| } |
| |
| <span class="kw">impl </span>AsyncFileReader <span class="kw">for </span>ParquetObjectReader { |
| <span class="kw">fn </span>get_bytes(<span class="kw-2">&mut </span><span class="self">self</span>, range: Range<usize>) -> BoxFuture<<span class="lifetime">'_</span>, <span class="prelude-ty">Result</span><Bytes>> { |
| <span class="self">self</span>.store |
| .get_range(<span class="kw-2">&</span><span class="self">self</span>.meta.location, range) |
| .map_err(|e| ParquetError::General(<span class="macro">format!</span>(<span class="string">"AsyncChunkReader::get_bytes error: {e}"</span>))) |
| .boxed() |
| } |
| |
| <span class="kw">fn </span>get_byte_ranges(<span class="kw-2">&mut </span><span class="self">self</span>, ranges: Vec<Range<usize>>) -> BoxFuture<<span class="lifetime">'_</span>, <span class="prelude-ty">Result</span><Vec<Bytes>>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Send, |
| { |
| <span class="kw">async move </span>{ |
| <span class="self">self</span>.store |
| .get_ranges(<span class="kw-2">&</span><span class="self">self</span>.meta.location, <span class="kw-2">&</span>ranges) |
| .<span class="kw">await |
| </span>.map_err(|e| { |
| ParquetError::General(<span class="macro">format!</span>( |
| <span class="string">"ParquetObjectReader::get_byte_ranges error: {e}" |
| </span>)) |
| }) |
| } |
| .boxed() |
| } |
| |
| <span class="kw">fn </span>get_metadata(<span class="kw-2">&mut </span><span class="self">self</span>) -> BoxFuture<<span class="lifetime">'_</span>, <span class="prelude-ty">Result</span><Arc<ParquetMetaData>>> { |
| Box::pin(<span class="kw">async move </span>{ |
| <span class="kw">let </span>preload_column_index = <span class="self">self</span>.preload_column_index; |
| <span class="kw">let </span>preload_offset_index = <span class="self">self</span>.preload_offset_index; |
| <span class="kw">let </span>file_size = <span class="self">self</span>.meta.size; |
| <span class="kw">let </span>prefetch = <span class="self">self</span>.metadata_size_hint; |
| <span class="kw">let </span><span class="kw-2">mut </span>loader = MetadataLoader::load(<span class="self">self</span>, file_size, prefetch).<span class="kw">await</span><span class="question-mark">?</span>; |
| loader |
| .load_page_index(preload_column_index, preload_offset_index) |
| .<span class="kw">await</span><span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Arc::new(loader.finish())) |
| }) |
| } |
| } |
| |
| <span class="attr">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use </span>futures::TryStreamExt; |
| |
| <span class="kw">use </span>arrow::util::test_util::parquet_test_data; |
| <span class="kw">use </span>object_store::local::LocalFileSystem; |
| <span class="kw">use </span>object_store::path::Path; |
| <span class="kw">use </span>object_store::ObjectStore; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::arrow::async_reader::ParquetObjectReader; |
| <span class="kw">use </span><span class="kw">crate</span>::arrow::ParquetRecordBatchStreamBuilder; |
| |
| <span class="attr">#[tokio::test] |
| </span><span class="kw">async fn </span>test_simple() { |
| <span class="kw">let </span>res = parquet_test_data(); |
| <span class="kw">let </span>store = LocalFileSystem::new_with_prefix(res).unwrap(); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>meta = store |
| .head(<span class="kw-2">&</span>Path::from(<span class="string">"alltypes_plain.parquet"</span>)) |
| .<span class="kw">await |
| </span>.unwrap(); |
| |
| <span class="kw">let </span>store = Arc::new(store) <span class="kw">as </span>Arc<<span class="kw">dyn </span>ObjectStore>; |
| <span class="kw">let </span>object_reader = ParquetObjectReader::new(Arc::clone(<span class="kw-2">&</span>store), meta.clone()); |
| <span class="kw">let </span>builder = ParquetRecordBatchStreamBuilder::new(object_reader) |
| .<span class="kw">await |
| </span>.unwrap(); |
| <span class="kw">let </span>batches: Vec<<span class="kw">_</span>> = builder.build().unwrap().try_collect().<span class="kw">await</span>.unwrap(); |
| |
| <span class="macro">assert_eq!</span>(batches.len(), <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(batches[<span class="number">0</span>].num_rows(), <span class="number">8</span>); |
| |
| meta.location = Path::from(<span class="string">"I don't exist.parquet"</span>); |
| |
| <span class="kw">let </span>object_reader = ParquetObjectReader::new(store, meta); |
| <span class="comment">// Cannot use unwrap_err as ParquetRecordBatchStreamBuilder: !Debug |
| </span><span class="kw">match </span>ParquetRecordBatchStreamBuilder::new(object_reader).<span class="kw">await </span>{ |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="macro">panic!</span>(<span class="string">"expected failure"</span>), |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">let </span>err = e.to_string(); |
| <span class="macro">assert!</span>( |
| err.contains(<span class="string">"not found: No such file or directory (os error 2)"</span>), |
| <span class="string">"{}"</span>, |
| err |
| ); |
| } |
| } |
| } |
| } |
| </code></pre></div></section></main></body></html> |
