This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/iceberg-rust.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 155917f deploy: a3f9aecb80e582dfafb450f41e4f760176c6c36c
155917f is described below
commit 155917f205f48dd29a8f0e4771f901c82f891758
Author: liurenjie1024 <[email protected]>
AuthorDate: Wed Aug 14 12:59:51 2024 +0000
deploy: a3f9aecb80e582dfafb450f41e4f760176c6c36c
---
api/iceberg/index.html | 30 ++++++++++++-
api/search.desc/iceberg/iceberg-desc-0-.js | 2 +-
api/src/iceberg/lib.rs.html | 70 +++++++++++++++++++++++++++++-
3 files changed, 99 insertions(+), 3 deletions(-)
diff --git a/api/iceberg/index.html b/api/iceberg/index.html
index 9660e70..b5810da 100644
--- a/api/iceberg/index.html
+++ b/api/iceberg/index.html
@@ -1,2 +1,30 @@
-<!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="Native
Rust implementation of Apache Iceberg"><title>iceberg -
Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.
[...]
+<!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="Apache
Iceberg Official Native Rust Implementation"><title>iceberg -
Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e497
[...]
+<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2><h3
id="scan-a-table"><a class="doc-anchor" href="#scan-a-table">§</a>Scan A
Table</h3>
+<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">use </span>futures::TryStreamExt;
+<span class="kw">use </span>iceberg::io::{FileIO, FileIOBuilder};
+<span class="kw">use </span>iceberg::{Catalog, <span
class="prelude-ty">Result</span>, TableIdent};
+<span class="kw">use </span>iceberg_catalog_memory::MemoryCatalog;
+
+<span class="attr">#[tokio::main]
+</span><span class="kw">async fn </span>main() -> <span
class="prelude-ty">Result</span><()> {
+ <span class="comment">// Build your file IO.
+ </span><span class="kw">let </span>file_io = FileIOBuilder::new(<span
class="string">"memory"</span>).build()<span class="question-mark">?</span>;
+ <span class="comment">// Connect to a catalog.
+ </span><span class="kw">let </span>catalog = MemoryCatalog::new(file_io,
<span class="prelude-val">None</span>);
+ <span class="comment">// Load table from catalog.
+ </span><span class="kw">let </span>table = catalog
+ .load_table(<span
class="kw-2">&</span>TableIdent::from_strs([<span
class="string">"hello"</span>, <span class="string">"world"</span>])<span
class="question-mark">?</span>)
+ .<span class="kw">await</span><span class="question-mark">?</span>;
+ <span class="comment">// Build table scan.
+ </span><span class="kw">let </span>stream = table
+ .scan()
+ .select([<span class="string">"name"</span>, <span
class="string">"id"</span>])
+ .build()<span class="question-mark">?
+ </span>.to_arrow()
+ .<span class="kw">await</span><span class="question-mark">?</span>;
+
+ <span class="comment">// Consume this stream like arrow record batch
stream.
+ </span><span class="kw">let </span>_data: Vec<<span
class="kw">_</span>> = stream.try_collect().<span
class="kw">await</span><span class="question-mark">?</span>;
+ <span class="prelude-val">Ok</span>(())
+}</code></pre></div>
</div></details><h2 id="modules" class="section-header">Modules<a
href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div
class="item-name"><a class="mod" href="arrow/index.html" title="mod
iceberg::arrow">arrow</a></div><div class="desc docblock-short">Conversion
between Iceberg and Arrow schema</div></li><li><div class="item-name"><a
class="mod" href="expr/index.html" title="mod iceberg::expr">expr</a></div><div
class="desc docblock-short">This module contains expressi [...]
\ No newline at end of file
diff --git a/api/search.desc/iceberg/iceberg-desc-0-.js
b/api/search.desc/iceberg/iceberg-desc-0-.js
index e201ade..0402c35 100644
--- a/api/search.desc/iceberg/iceberg-desc-0-.js
+++ b/api/search.desc/iceberg/iceberg-desc-0-.js
@@ -1 +1 @@
-searchState.loadedDescShard("iceberg", 0, "Native Rust implementation of
Apache Iceberg\nAdd a new schema to the table\nAdd snapshot to table.\nAdd sort
order to table.\nAdd a new partition spec to the table\nAssign a new UUID to
the table\nThe catalog API for Iceberg Rust.\nThe table’s current schema id
must match the requirement.\nIceberg data is invalid.\nThe table’s default sort
order id must match the …\nThe table’s default spec id must match the
requirement.\nContains the error val [...]
\ No newline at end of file
+searchState.loadedDescShard("iceberg", 0, "Apache Iceberg Official Native Rust
Implementation\nAdd a new schema to the table\nAdd snapshot to table.\nAdd sort
order to table.\nAdd a new partition spec to the table\nAssign a new UUID to
the table\nThe catalog API for Iceberg Rust.\nThe table’s current schema id
must match the requirement.\nIceberg data is invalid.\nThe table’s default sort
order id must match the …\nThe table’s default spec id must match the
requirement.\nContains the err [...]
\ No newline at end of file
diff --git a/api/src/iceberg/lib.rs.html b/api/src/iceberg/lib.rs.html
index 90b1c19..54c9034 100644
--- a/api/src/iceberg/lib.rs.html
+++ b/api/src/iceberg/lib.rs.html
@@ -48,6 +48,40 @@
<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>
</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
@@ -65,7 +99,41 @@
// specific language governing permissions and limitations
// under the License.
-</span><span class="doccomment">//! Native Rust implementation of Apache
Iceberg
+</span><span class="doccomment">//! Apache Iceberg Official Native Rust
Implementation
+//!
+//! # Examples
+//!
+//! ## Scan A Table
+//!
+//! ```rust, no_run
+//! use futures::TryStreamExt;
+//! use iceberg::io::{FileIO, FileIOBuilder};
+//! use iceberg::{Catalog, Result, TableIdent};
+//! use iceberg_catalog_memory::MemoryCatalog;
+//!
+//! #[tokio::main]
+//! async fn main() -> Result<()> {
+//! // Build your file IO.
+//! let file_io = FileIOBuilder::new("memory").build()?;
+//! // Connect to a catalog.
+//! let catalog = MemoryCatalog::new(file_io, None);
+//! // Load table from catalog.
+//! let table = catalog
+//! .load_table(&TableIdent::from_strs(["hello", "world"])?)
+//! .await?;
+//! // Build table scan.
+//! let stream = table
+//! .scan()
+//! .select(["name", "id"])
+//! .build()?
+//! .to_arrow()
+//! .await?;
+//!
+//! // Consume this stream like arrow record batch stream.
+//! let _data: Vec<_> = stream.try_collect().await?;
+//! Ok(())
+//! }
+//! ```
</span><span class="attr">#![deny(missing_docs)]
