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 ccc9131fed Publish built docs triggered by
8336a5823ccc12b2828593a6c404d6d5f6d429ac
ccc9131fed is described below
commit ccc9131fedce9fb5bc7ed01ba789046b498ca2b1
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue May 30 19:11:42 2023 +0000
Publish built docs triggered by 8336a5823ccc12b2828593a6c404d6d5f6d429ac
---
_sources/index.rst.txt | 7 +++++++
_sources/user-guide/example-usage.md.txt | 31 +++++++++++++++++++++++++++++++
index.html | 2 ++
searchindex.js | 2 +-
user-guide/example-usage.html | 26 ++++++++++++++++++++++++++
5 files changed, 67 insertions(+), 1 deletion(-)
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
index 83c517faf0..4f45771173 100644
--- a/_sources/index.rst.txt
+++ b/_sources/index.rst.txt
@@ -31,6 +31,13 @@ DataFusion offers SQL and Dataframe APIs, excellent
CSV, Parquet, JSON, and Avro, extensive customization, and a great
community.
+The `example usage`_ section in the user guide and the `datafusion-examples`_
code in the crate contain information on using DataFusion.
+
+The `developer’s guide`_ contains information on how to contribute.
+
+.. _example usage: user-guide/example-usage.html
+.. _datafusion-examples:
https://github.com/apache/arrow-datafusion/tree/master/datafusion-examples
+.. _developer’s guide: contributor-guide/index.html#developer-s-guide
.. _toc.links:
.. toctree::
diff --git a/_sources/user-guide/example-usage.md.txt
b/_sources/user-guide/example-usage.md.txt
index 2bbbe8e38f..69eeb90286 100644
--- a/_sources/user-guide/example-usage.md.txt
+++ b/_sources/user-guide/example-usage.md.txt
@@ -81,6 +81,37 @@ async fn main() -> datafusion::error::Result<()> {
+---+--------+
```
+## Arrow Versions
+
+Many of DataFusion's public APIs use types from the
+[`arrow`] and [`parquet`] crates, so if you use
+`arrow` in your project, the `arrow` version must match that used by
+DataFusion. You can check the required version on [DataFusion's
+crates.io] page.
+
+The easiest way to ensure the versions match is to use the `arrow`
+exported by DataFusion, for example:
+
+```rust
+use datafusion::arrow::datatypes::Schema;
+```
+
+For example, [DataFusion `25.0.0` dependencies] require `arrow`
+`39.0.0`. If instead you used `arrow` `40.0.0` in your project you may
+see errors such as:
+
+```text
+mismatched types [E0308] expected `Schema`, found `arrow_schema::Schema` Note:
`arrow_schema::Schema` and `Schema` have similar names, but are actually
distinct types Note: `arrow_schema::Schema` is defined in crate `arrow_schema`
Note: `Schema` is defined in crate `arrow_schema` Note: perhaps two different
versions of crate `arrow_schema` are being used? Note: associated function
defined here
+```
+
+Or calling `downcast_ref` on an `ArrayRef` may return `None`
+unexpectedly.
+
+[`arrow`]: https://docs.rs/arrow/latest/arrow/
+[`parquet`]: https://docs.rs/parquet/latest/parquet/
+[datafusion's crates.io]: https://crates.io/crates/datafusion
+[datafusion `25.0.0` dependencies]:
https://crates.io/crates/datafusion/25.0.0/dependencies
+
## Identifiers and Capitalization
Please be aware that all identifiers are effectively made lower-case in SQL,
so if your csv file has capital letters (ex: `Name`) you must put your column
name in double quotes or the examples won't work.
diff --git a/index.html b/index.html
index c25b96dfba..e1cbb3d609 100644
--- a/index.html
+++ b/index.html
@@ -315,6 +315,8 @@ in-memory format.</p>
<a class="reference external"
href="https://benchmark.clickhouse.com";>performance</a>, built-in support for
CSV, Parquet, JSON, and Avro, extensive customization, and a great
community.</p>
+<p>The <a class="reference external"
href="user-guide/example-usage.html">example usage</a> section in the user
guide and the <a class="reference external"
href="https://github.com/apache/arrow-datafusion/tree/master/datafusion-examples";>datafusion-examples</a>
code in the crate contain information on using DataFusion.</p>
+<p>The <a class="reference external"
href="contributor-guide/index.html#developer-s-guide">developer’s guide</a>
contains information on how to contribute.</p>
<div class="toctree-wrapper compound" id="toc-links">
<p aria-level="2" class="caption" role="heading"><span
class="caption-text">Links</span></p>
<ul>
diff --git a/searchindex.js b/searchindex.js
index 7888c15bc2..88d0156493 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",
"user-guide/cli", "user-guide/configs", "user-guide/dataframe",
"user-guide/example-usage", "user-guide/expressions", "user-guide/faq", "use
[...]
\ 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",
"user-guide/cli", "user-guide/configs", "user-guide/dataframe",
"user-guide/example-usage", "user-guide/expressions", "user-guide/faq", "use
[...]
\ No newline at end of file
diff --git a/user-guide/example-usage.html b/user-guide/example-usage.html
index 186b260dc3..1d8ebf3b51 100644
--- a/user-guide/example-usage.html
+++ b/user-guide/example-usage.html
@@ -308,6 +308,11 @@
Output from both examples
</a>
</li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#arrow-versions">
+ Arrow Versions
+ </a>
+ </li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link"
href="#identifiers-and-capitalization">
Identifiers and Capitalization
@@ -451,6 +456,27 @@
</pre></div>
</div>
</section>
+<section id="arrow-versions">
+<h2>Arrow Versions<a class="headerlink" href="#arrow-versions"
title="Permalink to this heading">¶</a></h2>
+<p>Many of DataFusion’s public APIs use types from the
+<a class="reference external" href="https://docs.rs/arrow/latest/arrow/";><code
class="docutils literal notranslate"><span class="pre">arrow</span></code></a>
and <a class="reference external"
href="https://docs.rs/parquet/latest/parquet/";><code class="docutils literal
notranslate"><span class="pre">parquet</span></code></a> crates, so if you use
+<code class="docutils literal notranslate"><span
class="pre">arrow</span></code> in your project, the <code class="docutils
literal notranslate"><span class="pre">arrow</span></code> version must match
that used by
+DataFusion. You can check the required version on <a class="reference
external" href="https://crates.io/crates/datafusion";>DataFusion’s
+crates.io</a> page.</p>
+<p>The easiest way to ensure the versions match is to use the <code
class="docutils literal notranslate"><span class="pre">arrow</span></code>
+exported by DataFusion, for example:</p>
+<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">arrow</span>::<span
class="n">datatypes</span>::<span class="n">Schema</span><span
class="p">;</span>
+</pre></div>
+</div>
+<p>For example, <a class="reference external"
href="https://crates.io/crates/datafusion/25.0.0/dependencies";>DataFusion <code
class="docutils literal notranslate"><span class="pre">25.0.0</span></code>
dependencies</a> require <code class="docutils literal notranslate"><span
class="pre">arrow</span></code>
+<code class="docutils literal notranslate"><span
class="pre">39.0.0</span></code>. If instead you used <code class="docutils
literal notranslate"><span class="pre">arrow</span></code> <code
class="docutils literal notranslate"><span class="pre">40.0.0</span></code> in
your project you may
+see errors such as:</p>
+<div class="highlight-text notranslate"><div
class="highlight"><pre><span></span>mismatched types [E0308] expected `Schema`,
found `arrow_schema::Schema` Note: `arrow_schema::Schema` and `Schema` have
similar names, but are actually distinct types Note: `arrow_schema::Schema` is
defined in crate `arrow_schema` Note: `Schema` is defined in crate
`arrow_schema` Note: perhaps two different versions of crate `arrow_schema` are
being used? Note: associated function defined here
+</pre></div>
+</div>
+<p>Or calling <code class="docutils literal notranslate"><span
class="pre">downcast_ref</span></code> on an <code class="docutils literal
notranslate"><span class="pre">ArrayRef</span></code> may return <code
class="docutils literal notranslate"><span class="pre">None</span></code>
+unexpectedly.</p>
+</section>
<section id="identifiers-and-capitalization">
<h2>Identifiers and Capitalization<a class="headerlink"
href="#identifiers-and-capitalization" title="Permalink to this
heading">¶</a></h2>
<p>Please be aware that all identifiers are effectively made lower-case in
SQL, so if your csv file has capital letters (ex: <code class="docutils literal
notranslate"><span class="pre">Name</span></code>) you must put your column
name in double quotes or the examples won’t work.</p>
