You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by al...@apache.org on 2022/02/17 15:06:49 UTC
[arrow-site] branch asf-site updated: update datafusion site (#195)
This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 6b6bfbd update datafusion site (#195)
6b6bfbd is described below
commit 6b6bfbddaf409c67af5699d5ad0f807b95802971
Author: Andrew Lamb <an...@nerdnetworks.org>
AuthorDate: Thu Feb 17 10:06:41 2022 -0500
update datafusion site (#195)
---
.../_sources/user-guide/example-usage.md.txt | 21 +++++---
datafusion/searchindex.js | 2 +-
datafusion/user-guide/example-usage.html | 58 +++++++++++++++++++---
3 files changed, 67 insertions(+), 14 deletions(-)
diff --git a/datafusion/_sources/user-guide/example-usage.md.txt b/datafusion/_sources/user-guide/example-usage.md.txt
index c09e1e8..7793026 100644
--- a/datafusion/_sources/user-guide/example-usage.md.txt
+++ b/datafusion/_sources/user-guide/example-usage.md.txt
@@ -19,7 +19,16 @@
# Example Usage
-Run a SQL query against data stored in a CSV:
+## Update `Cargo.toml`
+
+Add the following to your `Cargo.toml` file:
+
+```toml
+datafusion = "7.0.0"
+tokio = "1.0"
+```
+
+## Run a SQL query against data stored in a CSV:
```rust
use datafusion::prelude::*;
@@ -28,10 +37,10 @@ use datafusion::prelude::*;
async fn main() -> datafusion::error::Result<()> {
// register the table
let mut ctx = ExecutionContext::new();
- ctx.register_csv("example", "tests/example.csv", CsvReadOptions::new())?;
+ ctx.register_csv("example", "tests/example.csv", CsvReadOptions::new()).await?;
// create a plan to run a SQL query
- let df = ctx.sql("SELECT a, MIN(b) FROM example GROUP BY a LIMIT 100")?;
+ let df = ctx.sql("SELECT a, MIN(b) FROM example GROUP BY a LIMIT 100").await?;
// execute and print results
df.show().await?;
@@ -39,7 +48,7 @@ async fn main() -> datafusion::error::Result<()> {
}
```
-Use the DataFrame API to process data stored in a CSV:
+## Use the DataFrame API to process data stored in a CSV:
```rust
use datafusion::prelude::*;
@@ -48,7 +57,7 @@ use datafusion::prelude::*;
async fn main() -> datafusion::error::Result<()> {
// create the dataframe
let mut ctx = ExecutionContext::new();
- let df = ctx.read_csv("tests/example.csv", CsvReadOptions::new())?;
+ let df = ctx.read_csv("tests/example.csv", CsvReadOptions::new()).await?;
let df = df.filter(col("a").lt_eq(col("b")))?
.aggregate(vec![col("a")], vec![min(col("b"))])?;
@@ -59,7 +68,7 @@ async fn main() -> datafusion::error::Result<()> {
}
```
-Both of these examples will produce
+## Output from both examples
```text
+---+--------+
diff --git a/datafusion/searchindex.js b/datafusion/searchindex.js
index ff24006..174fc99 100644
--- a/datafusion/searchindex.js
+++ b/datafusion/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["cli/index","community/communication","index","python/api","python/api/dataframe","python/api/execution_context","python/api/expression","python/api/functions","python/generated/datafusion.DataFrame","python/generated/datafusion.ExecutionContext","python/generated/datafusion.Expression","python/generated/datafusion.functions","python/index","specification/invariants","specification/output-field-name-semantic","specification/quarterly_roadmap","specification/rfc [...]
\ No newline at end of file
+Search.setIndex({docnames:["cli/index","community/communication","index","python/api","python/api/dataframe","python/api/execution_context","python/api/expression","python/api/functions","python/generated/datafusion.DataFrame","python/generated/datafusion.ExecutionContext","python/generated/datafusion.Expression","python/generated/datafusion.functions","python/index","specification/invariants","specification/output-field-name-semantic","specification/quarterly_roadmap","specification/rfc [...]
\ No newline at end of file
diff --git a/datafusion/user-guide/example-usage.html b/datafusion/user-guide/example-usage.html
index 51b3541..c7c4843 100644
--- a/datafusion/user-guide/example-usage.html
+++ b/datafusion/user-guide/example-usage.html
@@ -407,9 +407,39 @@
<div class="toc-item">
+<div class="tocsection onthispage pt-5 pb-3">
+ <i class="fas fa-list"></i> On this page
+</div>
<nav id="bd-toc-nav">
-
+ <ul class="visible nav section-nav flex-column">
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#update-cargo-toml">
+ Update
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ Cargo.toml
+ </span>
+ </code>
+ </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#run-a-sql-query-against-data-stored-in-a-csv">
+ Run a SQL query against data stored in a CSV:
+ </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#use-the-dataframe-api-to-process-data-stored-in-a-csv">
+ Use the DataFrame API to process data stored in a CSV:
+ </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#output-from-both-examples">
+ Output from both examples
+ </a>
+ </li>
+</ul>
+
</nav>
</div>
@@ -456,17 +486,26 @@
-->
<section id="example-usage">
<h1>Example Usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">¶</a></h1>
-<p>Run a SQL query against data stored in a CSV:</p>
+<section id="update-cargo-toml">
+<h2>Update <code class="docutils literal notranslate"><span class="pre">Cargo.toml</span></code><a class="headerlink" href="#update-cargo-toml" title="Permalink to this headline">¶</a></h2>
+<p>Add the following to your <code class="docutils literal notranslate"><span class="pre">Cargo.toml</span></code> file:</p>
+<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span class="n">datafusion</span> <span class="o">=</span> <span class="s">"7.0.0"</span>
+<span class="n">tokio</span> <span class="o">=</span> <span class="s">"1.0"</span>
+</pre></div>
+</div>
+</section>
+<section id="run-a-sql-query-against-data-stored-in-a-csv">
+<h2>Run a SQL query against data stored in a CSV:<a class="headerlink" href="#run-a-sql-query-against-data-stored-in-a-csv" title="Permalink to this headline">¶</a></h2>
<div class="highlight-rust notranslate"><div class="highlight"><pre><span></span><span class="k">use</span><span class="w"> </span><span class="n">datafusion</span>::<span class="n">prelude</span>::<span class="o">*</span><span class="p">;</span><span class="w"></span>
<span class="cp">#[tokio::main]</span><span class="w"></span>
<span class="k">async</span><span class="w"> </span><span class="k">fn</span> <span class="nf">main</span><span class="p">()</span><span class="w"> </span>-> <span class="nc">datafusion</span>::<span class="n">error</span>::<span class="nb">Result</span><span class="o"><</span><span class="p">()</span><span class="o">></span><span class="w"> </span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="c1">// register the table</span>
<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="k">mut</span><span class="w"> </span><span class="n">ctx</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ExecutionContext</span>::<span class="n">new</span><span class="p">();</span><span class="w"></span>
-<span class="w"> </span><span class="n">ctx</span><span class="p">.</span><span class="n">register_csv</span><span class="p">(</span><span class="s">"example"</span><span class="p">,</span><span class="w"> </span><span class="s">"tests/example.csv"</span><span class="p">,</span><span class="w"> </span><span class="n">CsvReadOptions</span>::<span class="n">new</span><span class="p">())</span><span class="o">?</span><span class="p">;</span><span class="w"></span>
+<span class="w"> </span><span class="n">ctx</span><span class="p">.</span><span class="n">register_csv</span><span class="p">(</span><span class="s">"example"</span><span class="p">,</span><span class="w"> </span><span class="s">"tests/example.csv"</span><span class="p">,</span><span class="w"> </span><span class="n">CsvReadOptions</span>::<span class="n">new</span><span class="p">()).</span><span class="k">await</span><span class="o">?</span><span class="p">;</span> [...]
<span class="w"> </span><span class="c1">// create a plan to run a SQL query</span>
-<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="n">df</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ctx</span><span class="p">.</span><span class="n">sql</span><span class="p">(</span><span class="s">"SELECT a, MIN(b) FROM example GROUP BY a LIMIT 100"</span><span class="p">)</span><span class="o">?</span><span class="p">;</span><span class="w"></span>
+<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="n">df</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ctx</span><span class="p">.</span><span class="n">sql</span><span class="p">(</span><span class="s">"SELECT a, MIN(b) FROM example GROUP BY a LIMIT 100"</span><span class="p">).</span><span class="k">await</span><span class="o">?</span><span class="p">;</span><span class="w"></span>
<span class="w"> </span><span class="c1">// execute and print results</span>
<span class="w"> </span><span class="n">df</span><span class="p">.</span><span class="n">show</span><span class="p">().</span><span class="k">await</span><span class="o">?</span><span class="p">;</span><span class="w"></span>
@@ -474,14 +513,16 @@
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
-<p>Use the DataFrame API to process data stored in a CSV:</p>
+</section>
+<section id="use-the-dataframe-api-to-process-data-stored-in-a-csv">
+<h2>Use the DataFrame API to process data stored in a CSV:<a class="headerlink" href="#use-the-dataframe-api-to-process-data-stored-in-a-csv" title="Permalink to this headline">¶</a></h2>
<div class="highlight-rust notranslate"><div class="highlight"><pre><span></span><span class="k">use</span><span class="w"> </span><span class="n">datafusion</span>::<span class="n">prelude</span>::<span class="o">*</span><span class="p">;</span><span class="w"></span>
<span class="cp">#[tokio::main]</span><span class="w"></span>
<span class="k">async</span><span class="w"> </span><span class="k">fn</span> <span class="nf">main</span><span class="p">()</span><span class="w"> </span>-> <span class="nc">datafusion</span>::<span class="n">error</span>::<span class="nb">Result</span><span class="o"><</span><span class="p">()</span><span class="o">></span><span class="w"> </span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="c1">// create the dataframe</span>
<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="k">mut</span><span class="w"> </span><span class="n">ctx</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ExecutionContext</span>::<span class="n">new</span><span class="p">();</span><span class="w"></span>
-<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="n">df</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ctx</span><span class="p">.</span><span class="n">read_csv</span><span class="p">(</span><span class="s">"tests/example.csv"</span><span class="p">,</span><span class="w"> </span><span class="n">CsvReadOptions</span>::<span class="n">new</span><span class="p">())</span><span class="o">?</span [...]
+<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="n">df</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ctx</span><span class="p">.</span><span class="n">read_csv</span><span class="p">(</span><span class="s">"tests/example.csv"</span><span class="p">,</span><span class="w"> </span><span class="n">CsvReadOptions</span>::<span class="n">new</span><span class="p">()).</span><span class="k">await< [...]
<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="n">df</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">df</span><span class="p">.</span><span class="n">filter</span><span class="p">(</span><span class="n">col</span><span class="p">(</span><span class="s">"a"</span><span class="p">).</span><span class="n">lt_eq</span><span class="p">(</span><span class="n">col</span><span class="p">(</span><spa [...]
<span class="w"> </span><span class="p">.</span><span class="n">aggregate</span><span class="p">(</span><span class="fm">vec!</span><span class="p">[</span><span class="n">col</span><span class="p">(</span><span class="s">"a"</span><span class="p">)],</span><span class="w"> </span><span class="fm">vec!</span><span class="p">[</span><span class="n">min</span><span class="p">(</span><span class="n">col</span><span class="p">(</span><span class="s">"b"</span><s [...]
@@ -492,7 +533,9 @@
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
-<p>Both of these examples will produce</p>
+</section>
+<section id="output-from-both-examples">
+<h2>Output from both examples<a class="headerlink" href="#output-from-both-examples" title="Permalink to this headline">¶</a></h2>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>+---+--------+
| a | MIN(b) |
+---+--------+
@@ -501,6 +544,7 @@
</pre></div>
</div>
</section>
+</section>
</div>