This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new d9b54c207d Publish built docs triggered by
c843226d84f79fa7ce99576ae8605ecef1a28484
d9b54c207d is described below
commit d9b54c207de92310d62a064d4f85ea8d94529f63
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed Jan 31 21:52:28 2024 +0000
Publish built docs triggered by c843226d84f79fa7ce99576ae8605ecef1a28484
---
_sources/user-guide/example-usage.md.txt | 27 +++++++++++++++++++++--
searchindex.js | 2 +-
user-guide/example-usage.html | 37 +++++++++++++++++++++++---------
3 files changed, 53 insertions(+), 13 deletions(-)
diff --git a/_sources/user-guide/example-usage.md.txt
b/_sources/user-guide/example-usage.md.txt
index 77b196c124..fd525608d3 100644
--- a/_sources/user-guide/example-usage.md.txt
+++ b/_sources/user-guide/example-usage.md.txt
@@ -23,7 +23,7 @@ In this example some simple processing is performed on the
[`example.csv`](https
Even [`more code
examples`](https://github.com/apache/arrow-datafusion/tree/main/datafusion-examples)
attached to the project.
-## Update `Cargo.toml`
+## Add DataFusion as a dependency
Find latest available Datafusion version on [DataFusion's
crates.io] page. Add the dependency to your `Cargo.toml` file:
@@ -33,6 +33,29 @@ datafusion = "31"
tokio = "1.0"
```
+## Add DataFusion latest codebase as a dependency
+
+Cargo supports adding dependency directly from Github which allows testing out
latest DataFusion codebase without waiting the code to be released to crates.io
+according to the [DataFusion release
schedule](https://github.com/apache/arrow-datafusion/blob/main/dev/release/README.md#release-process)
+
+```toml
+datafusion = { git = "https://github.com/apache/arrow-datafusion";, branch =
"main"}
+```
+
+Also it works on the package level
+
+```toml
+datafusion-common = { git = "https://github.com/apache/arrow-datafusion";,
branch = "main", package = "datafusion-common"}
+```
+
+And with features
+
+```toml
+datafusion = { git = "https://github.com/apache/arrow-datafusion";, branch =
"main", default-features = false, features = ["unicode_expressions"] }
+```
+
+More on [Cargo
dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies)
+
## Run a SQL query against data stored in a CSV:
```rust
@@ -239,7 +262,7 @@ like error backtrace. To enable a backtrace you need to add
Datafusion `backtrac
datafusion = { version = "31.0.0", features = ["backtrace"]}
```
-Set environment [`variables`]
https://doc.rust-lang.org/std/backtrace/index.html#environment-variables
+Set environment
[variables](https://doc.rust-lang.org/std/backtrace/index.html#environment-variables)
```bash
RUST_BACKTRACE=1 ./target/debug/datafusion-cli
diff --git a/searchindex.js b/searchindex.js
index 7d5863db7f..7ddacd3c8c 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["contributor-guide/architecture",
"contributor-guide/communication", "contributor-guide/index",
"contributor-guide/quarterly_roadmap", "contributor-guide/roadmap",
"contributor-guide/specification/index",
"contributor-guide/specification/invariants",
"contributor-guide/specification/output-field-name-semantic", "index",
"library-user-guide/adding-udfs", "library-user-guide/building-logical-plans",
"library-user-guide/catalogs", "library-user-guide/custom-tab [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["contributor-guide/architecture",
"contributor-guide/communication", "contributor-guide/index",
"contributor-guide/quarterly_roadmap", "contributor-guide/roadmap",
"contributor-guide/specification/index",
"contributor-guide/specification/invariants",
"contributor-guide/specification/output-field-name-semantic", "index",
"library-user-guide/adding-udfs", "library-user-guide/building-logical-plans",
"library-user-guide/catalogs", "library-user-guide/custom-tab [...]
\ No newline at end of file
diff --git a/user-guide/example-usage.html b/user-guide/example-usage.html
index ca8a635922..ff1ee30175 100644
--- a/user-guide/example-usage.html
+++ b/user-guide/example-usage.html
@@ -353,13 +353,13 @@
<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 class="reference internal nav-link"
href="#add-datafusion-as-a-dependency">
+ Add DataFusion as a dependency
+ </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link"
href="#add-datafusion-latest-codebase-as-a-dependency">
+ Add DataFusion latest codebase as a dependency
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
@@ -467,8 +467,8 @@
<h1>Example Usage<a class="headerlink" href="#example-usage" title="Link to
this heading">¶</a></h1>
<p>In this example some simple processing is performed on the <a
class="reference external"
href="https://github.com/apache/arrow-datafusion/blob/main/datafusion/core/tests/data/example.csv";><code
class="docutils literal notranslate"><span
class="pre">example.csv</span></code></a> file.</p>
<p>Even <a class="reference external"
href="https://github.com/apache/arrow-datafusion/tree/main/datafusion-examples";><code
class="docutils literal notranslate"><span class="pre">more</span> <span
class="pre">code</span> <span class="pre">examples</span></code></a> attached
to the project.</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="Link to this heading">¶</a></h2>
+<section id="add-datafusion-as-a-dependency">
+<h2>Add DataFusion as a dependency<a class="headerlink"
href="#add-datafusion-as-a-dependency" title="Link to this heading">¶</a></h2>
<p>Find latest available Datafusion version on <a class="reference external"
href="https://crates.io/crates/datafusion";>DataFusion’s
crates.io</a> page. Add the dependency 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="w"> </span><span class="o">=</span><span class="w"> </span><span
class="s2">"31"</span>
@@ -476,6 +476,23 @@ crates.io</a> page. Add the dependency to your <code
class="docutils literal not
</pre></div>
</div>
</section>
+<section id="add-datafusion-latest-codebase-as-a-dependency">
+<h2>Add DataFusion latest codebase as a dependency<a class="headerlink"
href="#add-datafusion-latest-codebase-as-a-dependency" title="Link to this
heading">¶</a></h2>
+<p>Cargo supports adding dependency directly from Github which allows testing
out latest DataFusion codebase without waiting the code to be released to
crates.io
+according to the <a class="reference external"
href="https://github.com/apache/arrow-datafusion/blob/main/dev/release/README.md#release-process";>DataFusion
release schedule</a></p>
+<div class="highlight-toml notranslate"><div
class="highlight"><pre><span></span><span class="n">datafusion</span><span
class="w"> </span><span class="o">=</span><span class="w"> </span><span
class="p">{</span><span class="w"> </span><span class="n">git</span><span
class="w"> </span><span class="p">=</span><span class="w"> </span><span
class="s2">"https://github.com/apache/arrow-datafusion"</span><span
class="p">,</span><span class="w"> </span><span class="n">branch</span><span
[...]
+</pre></div>
+</div>
+<p>Also it works on the package level</p>
+<div class="highlight-toml notranslate"><div
class="highlight"><pre><span></span><span
class="n">datafusion-common</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span class="p">{</span><span
class="w"> </span><span class="n">git</span><span class="w"> </span><span
class="p">=</span><span class="w"> </span><span
class="s2">"https://github.com/apache/arrow-datafusion"</span><span
class="p">,</span><span class="w"> </span><span class="n">branch</spa [...]
+</pre></div>
+</div>
+<p>And with features</p>
+<div class="highlight-toml notranslate"><div
class="highlight"><pre><span></span><span class="n">datafusion</span><span
class="w"> </span><span class="o">=</span><span class="w"> </span><span
class="p">{</span><span class="w"> </span><span class="n">git</span><span
class="w"> </span><span class="p">=</span><span class="w"> </span><span
class="s2">"https://github.com/apache/arrow-datafusion"</span><span
class="p">,</span><span class="w"> </span><span class="n">branch</span><span
[...]
+</pre></div>
+</div>
+<p>More on <a class="reference external"
href="https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies";>Cargo
dependencies</a></p>
+</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="Link to this
heading">¶</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>
@@ -663,7 +680,7 @@ like error backtrace. To enable a backtrace you need to add
Datafusion <code cla
<div class="highlight-toml notranslate"><div
class="highlight"><pre><span></span><span class="n">datafusion</span><span
class="w"> </span><span class="o">=</span><span class="w"> </span><span
class="p">{</span><span class="w"> </span><span class="n">version</span><span
class="w"> </span><span class="p">=</span><span class="w"> </span><span
class="s2">"31.0.0"</span><span class="p">,</span><span class="w">
</span><span class="n">features</span><span class="w"> </span><span class [...]
</pre></div>
</div>
-<p>Set environment [<code class="docutils literal notranslate"><span
class="pre">variables</span></code>]
https://doc.rust-lang.org/std/backtrace/index.html#environment-variables</p>
+<p>Set environment <a class="reference external"
href="https://doc.rust-lang.org/std/backtrace/index.html#environment-variables";>variables</a></p>
<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span><span class="nv">RUST_BACKTRACE</span><span
class="o">=</span><span class="m">1</span><span class="w">
</span>./target/debug/datafusion-cli
DataFusion<span class="w"> </span>CLI<span class="w"> </span>v31.0.0
❯<span class="w"> </span><span class="k">select</span><span class="w">
</span>row_numer<span class="o">()</span><span class="w"> </span>over<span
class="w"> </span><span class="o">(</span>partition<span class="w">
</span>by<span class="w"> </span>a<span class="w"> </span>order<span class="w">
</span>by<span class="w"> </span>a<span class="o">)</span><span class="w">
</span>from<span class="w"> </span><span class="o">(</span><span
class="k">select</span><span class="w"> </span><span class [...]
