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/datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new aec03ebb73 Publish built docs triggered by
0b2eb50c0f980562a6c009f541c4dbd5831b5fe1
aec03ebb73 is described below
commit aec03ebb7383d45ecb60dbe9e927fd6a91098a2d
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Thu Jul 11 14:59:24 2024 +0000
Publish built docs triggered by 0b2eb50c0f980562a6c009f541c4dbd5831b5fe1
---
.../aggregate_function.rs | 2 +-
_sources/index.rst.txt | 8 +-
_sources/library-user-guide/index.md.txt | 21 +-
_sources/user-guide/crate-configuration.md.txt | 146 +++++++++++++
_sources/user-guide/example-usage.md.txt | 129 -----------
contributor-guide/architecture.html | 5 +
contributor-guide/communication.html | 5 +
contributor-guide/getting_started.html | 5 +
contributor-guide/governance.html | 5 +
contributor-guide/howtos.html | 5 +
contributor-guide/index.html | 5 +
contributor-guide/inviting.html | 5 +
contributor-guide/quarterly_roadmap.html | 5 +
contributor-guide/roadmap.html | 5 +
contributor-guide/specification/index.html | 5 +
contributor-guide/specification/invariants.html | 5 +
.../specification/output-field-name-semantic.html | 5 +
contributor-guide/testing.html | 5 +
download.html | 5 +
genindex.html | 5 +
index.html | 14 +-
library-user-guide/adding-udfs.html | 5 +
library-user-guide/building-logical-plans.html | 5 +
library-user-guide/catalogs.html | 5 +
library-user-guide/custom-table-providers.html | 5 +
library-user-guide/extending-operators.html | 5 +
library-user-guide/index.html | 23 +-
library-user-guide/profiling.html | 5 +
library-user-guide/using-the-dataframe-api.html | 5 +
library-user-guide/using-the-sql-api.html | 5 +
library-user-guide/working-with-exprs.html | 5 +
objects.inv | Bin 1611 -> 1627 bytes
search.html | 5 +
searchindex.js | 2 +-
user-guide/cli/datasources.html | 5 +
user-guide/cli/index.html | 11 +-
user-guide/cli/installation.html | 5 +
user-guide/cli/overview.html | 5 +
user-guide/cli/usage.html | 5 +
user-guide/configs.html | 5 +
...example-usage.html => crate-configuration.html} | 242 ++-------------------
user-guide/dataframe.html | 5 +
user-guide/example-usage.html | 142 +-----------
user-guide/expressions.html | 5 +
user-guide/faq.html | 5 +
user-guide/introduction.html | 5 +
user-guide/sql/aggregate_functions.html | 5 +
user-guide/sql/data_types.html | 5 +
user-guide/sql/ddl.html | 5 +
user-guide/sql/dml.html | 5 +
user-guide/sql/explain.html | 5 +
user-guide/sql/index.html | 5 +
user-guide/sql/information_schema.html | 5 +
user-guide/sql/operators.html | 5 +
user-guide/sql/scalar_functions.html | 5 +
user-guide/sql/select.html | 5 +
user-guide/sql/sql_status.html | 5 +
user-guide/sql/subqueries.html | 5 +
user-guide/sql/window_functions.html | 5 +
user-guide/sql/write_options.html | 5 +
60 files changed, 484 insertions(+), 496 deletions(-)
diff --git a/_downloads/f9718f9b04809de030b1693c73858f19/aggregate_function.rs
b/_downloads/f9718f9b04809de030b1693c73858f19/aggregate_function.rs
index 23e98714df..3cae78eaed 100644
--- a/_downloads/f9718f9b04809de030b1693c73858f19/aggregate_function.rs
+++ b/_downloads/f9718f9b04809de030b1693c73858f19/aggregate_function.rs
@@ -118,7 +118,7 @@ impl AggregateFunction {
pub fn nullable(&self) -> Result<bool> {
match self {
AggregateFunction::Max | AggregateFunction::Min => Ok(true),
- AggregateFunction::ArrayAgg => Ok(false),
+ AggregateFunction::ArrayAgg => Ok(true),
}
}
}
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
index d491df04f7..8fbff208f5 100644
--- a/_sources/index.rst.txt
+++ b/_sources/index.rst.txt
@@ -41,13 +41,16 @@ DataFusion offers SQL and Dataframe APIs, excellent
CSV, Parquet, JSON, and Avro, extensive customization, and a great
community.
-To get started with examples, see the `example usage`_ section of the user
guide and the `datafusion-examples`_ directory.
+To get started, see
-See the `developer’s guide`_ for contributing and `communication`_ for getting
in touch with us.
+* The `example usage`_ section of the user guide and the
`datafusion-examples`_ directory.
+* The `library user guide`_ for examples of using DataFusion's extension APIs
+* The `developer’s guide`_ for contributing and `communication`_ for getting
in touch with us.
.. _example usage: user-guide/example-usage.html
.. _datafusion-examples:
https://github.com/apache/datafusion/tree/main/datafusion-examples
.. _developer’s guide: contributor-guide/index.html#developer-s-guide
+.. _library user guide: library-user-guide/index.html
.. _communication: contributor-guide/communication.html
.. _toc.asf-links:
@@ -80,6 +83,7 @@ See the `developer’s guide`_ for contributing and
`communication`_ for getting
user-guide/introduction
user-guide/example-usage
+ user-guide/crate-configuration
user-guide/cli/index
user-guide/dataframe
user-guide/expressions
diff --git a/_sources/library-user-guide/index.md.txt
b/_sources/library-user-guide/index.md.txt
index 47257e0c92..fd126a1120 100644
--- a/_sources/library-user-guide/index.md.txt
+++ b/_sources/library-user-guide/index.md.txt
@@ -19,8 +19,25 @@
# Introduction
-The library user guide explains how to use the DataFusion library as a
dependency in your Rust project. Please check out the user-guide for more
details on how to use DataFusion's SQL and DataFrame APIs, or the contributor
guide for details on how to contribute to DataFusion.
+The library user guide explains how to use the DataFusion library as a
+dependency in your Rust project and customize its behavior using its extension
APIs.
-If you haven't reviewed the [architecture section in the docs][docs], it's a
useful place to get the lay of the land before starting down a specific path.
+Please check out the [user guide] for getting started using
+DataFusion's SQL and DataFrame APIs, or the [contributor guide]
+for details on how to contribute to DataFusion.
+If you haven't reviewed the [architecture section in the docs][docs], it's a
+useful place to get the lay of the land before starting down a specific path.
+
+DataFusion is designed to be extensible at all points, including
+
+- [x] User Defined Functions (UDFs)
+- [x] User Defined Aggregate Functions (UDAFs)
+- [x] User Defined Table Source (`TableProvider`) for tables
+- [x] User Defined `Optimizer` passes (plan rewrites)
+- [x] User Defined `LogicalPlan` nodes
+- [x] User Defined `ExecutionPlan` nodes
+
+[user guide]: ../user-guide/example-usage.md
+[contributor guide]: ../contributor-guide/index.md
[docs]: https://docs.rs/datafusion/latest/datafusion/#architecture
diff --git a/_sources/user-guide/crate-configuration.md.txt
b/_sources/user-guide/crate-configuration.md.txt
new file mode 100644
index 0000000000..0587d06a39
--- /dev/null
+++ b/_sources/user-guide/crate-configuration.md.txt
@@ -0,0 +1,146 @@
+<!---
+ 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.
+-->
+
+# Crate Configuration
+
+This section contains information on how to configure DataFusion in your Rust
+project. See the [Configuration Settings] section for a list of options that
+control DataFusion's behavior.
+
+[configuration settings]: configs.md
+
+## Add latest non published DataFusion dependency
+
+DataFusion changes are published to `crates.io` according to the [release
schedule](https://github.com/apache/datafusion/blob/main/dev/release/README.md#release-process)
+
+If you would like to test out DataFusion changes which are merged but not yet
+published, Cargo supports adding dependency directly to GitHub branch:
+
+```toml
+datafusion = { git = "https://github.com/apache/datafusion";, branch = "main"}
+```
+
+Also it works on the package level
+
+```toml
+datafusion-common = { git = "https://github.com/apache/datafusion";, branch =
"main", package = "datafusion-common"}
+```
+
+And with features
+
+```toml
+datafusion = { git = "https://github.com/apache/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)
+
+## Optimized Configuration
+
+For an optimized build several steps are required. First, use the below in
your `Cargo.toml`. It is
+worth noting that using the settings in the `[profile.release]` section will
significantly increase the build time.
+
+```toml
+[dependencies]
+datafusion = { version = "22.0" }
+tokio = { version = "^1.0", features = ["rt-multi-thread"] }
+snmalloc-rs = "0.3"
+
+[profile.release]
+lto = true
+codegen-units = 1
+```
+
+Then, in `main.rs.` update the memory allocator with the below after your
imports:
+
+```rust ,ignore
+use datafusion::prelude::*;
+
+#[global_allocator]
+static ALLOC: snmalloc_rs::SnMalloc = snmalloc_rs::SnMalloc;
+
+#[tokio::main]
+async fn main() -> datafusion::error::Result<()> {
+ Ok(())
+}
+```
+
+Based on the instruction set architecture you are building on you will want to
configure the `target-cpu` as well, ideally
+with `native` or at least `avx2`.
+
+```shell
+RUSTFLAGS='-C target-cpu=native' cargo run --release
+```
+
+## Enable backtraces
+
+By default Datafusion returns errors as a plain message. There is option to
enable more verbose details about the error,
+like error backtrace. To enable a backtrace you need to add Datafusion
`backtrace` feature to your `Cargo.toml` file:
+
+```toml
+datafusion = { version = "31.0.0", features = ["backtrace"]}
+```
+
+Set environment
[variables](https://doc.rust-lang.org/std/backtrace/index.html#environment-variables)
+
+```bash
+RUST_BACKTRACE=1 ./target/debug/datafusion-cli
+DataFusion CLI v31.0.0
+> select row_numer() over (partition by a order by a) from (select 1 a);
+Error during planning: Invalid function 'row_numer'.
+Did you mean 'ROW_NUMBER'?
+
+backtrace: 0: std::backtrace_rs::backtrace::libunwind::trace
+ at
/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/../../backtrace/src/backtrace/libunwind.rs:93:5
+ 1: std::backtrace_rs::backtrace::trace_unsynchronized
+ at
/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/../../backtrace/src/backtrace/mod.rs:66:5
+ 2: std::backtrace::Backtrace::create
+ at
/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/backtrace.rs:332:13
+ 3: std::backtrace::Backtrace::capture
+ at
/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/backtrace.rs:298:9
+ 4: datafusion_common::error::DataFusionError::get_back_trace
+ at /datafusion/datafusion/common/src/error.rs:436:30
+ 5: datafusion_sql::expr::function::<impl
datafusion_sql::planner::SqlToRel<S>>::sql_function_to_expr
+ ............
+```
+
+The backtraces are useful when debugging code. If there is a test in
`datafusion/core/src/physical_planner.rs`
+
+```
+#[tokio::test]
+async fn test_get_backtrace_for_failed_code() -> Result<()> {
+ let ctx = SessionContext::new();
+
+ let sql = "
+ select row_numer() over (partition by a order by a) from (select 1 a);
+ ";
+
+ let _ = ctx.sql(sql).await?.collect().await?;
+
+ Ok(())
+}
+```
+
+To obtain a backtrace:
+
+```bash
+cargo build --features=backtrace
+RUST_BACKTRACE=1 cargo test --features=backtrace --package datafusion --lib --
physical_planner::tests::test_get_backtrace_for_failed_code --exact --nocapture
+```
+
+Note: The backtrace wrapped into systems calls, so some steps on top of the
backtrace can be ignored
diff --git a/_sources/user-guide/example-usage.md.txt
b/_sources/user-guide/example-usage.md.txt
index 7dbd4045e7..813dbb1bc0 100644
--- a/_sources/user-guide/example-usage.md.txt
+++ b/_sources/user-guide/example-usage.md.txt
@@ -33,29 +33,6 @@ datafusion = "latest_version"
tokio = { version = "1.0", features = ["rt-multi-thread"] }
```
-## Add latest non published DataFusion dependency
-
-DataFusion changes are published to `crates.io` according to [release
schedule](https://github.com/apache/datafusion/blob/main/dev/release/README.md#release-process)
-In case if it is required to test out DataFusion changes which are merged but
yet to be published, Cargo supports adding dependency directly to GitHub branch
-
-```toml
-datafusion = { git = "https://github.com/apache/datafusion";, branch = "main"}
-```
-
-Also it works on the package level
-
-```toml
-datafusion-common = { git = "https://github.com/apache/datafusion";, branch =
"main", package = "datafusion-common"}
-```
-
-And with features
-
-```toml
-datafusion = { git = "https://github.com/apache/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
@@ -201,109 +178,3 @@ async fn main() -> datafusion::error::Result<()> {
| 1 | 2 |
+---+--------+
```
-
-## Extensibility
-
-DataFusion is designed to be extensible at all points. To that end, you can
provide your own custom:
-
-- [x] User Defined Functions (UDFs)
-- [x] User Defined Aggregate Functions (UDAFs)
-- [x] User Defined Table Source (`TableProvider`) for tables
-- [x] User Defined `Optimizer` passes (plan rewrites)
-- [x] User Defined `LogicalPlan` nodes
-- [x] User Defined `ExecutionPlan` nodes
-
-## Optimized Configuration
-
-For an optimized build several steps are required. First, use the below in
your `Cargo.toml`. It is
-worth noting that using the settings in the `[profile.release]` section will
significantly increase the build time.
-
-```toml
-[dependencies]
-datafusion = { version = "22.0" }
-tokio = { version = "^1.0", features = ["rt-multi-thread"] }
-snmalloc-rs = "0.3"
-
-[profile.release]
-lto = true
-codegen-units = 1
-```
-
-Then, in `main.rs.` update the memory allocator with the below after your
imports:
-
-```rust ,ignore
-use datafusion::prelude::*;
-
-#[global_allocator]
-static ALLOC: snmalloc_rs::SnMalloc = snmalloc_rs::SnMalloc;
-
-#[tokio::main]
-async fn main() -> datafusion::error::Result<()> {
- Ok(())
-}
-```
-
-Based on the instruction set architecture you are building on you will want to
configure the `target-cpu` as well, ideally
-with `native` or at least `avx2`.
-
-```shell
-RUSTFLAGS='-C target-cpu=native' cargo run --release
-```
-
-## Enable backtraces
-
-By default Datafusion returns errors as a plain message. There is option to
enable more verbose details about the error,
-like error backtrace. To enable a backtrace you need to add Datafusion
`backtrace` feature to your `Cargo.toml` file:
-
-```toml
-datafusion = { version = "31.0.0", features = ["backtrace"]}
-```
-
-Set environment
[variables](https://doc.rust-lang.org/std/backtrace/index.html#environment-variables)
-
-```bash
-RUST_BACKTRACE=1 ./target/debug/datafusion-cli
-DataFusion CLI v31.0.0
-> select row_number() over (partition by a order by a) from (select 1 a);
-Error during planning: Invalid function 'row_number'.
-Did you mean 'ROW_NUMBER'?
-
-backtrace: 0: std::backtrace_rs::backtrace::libunwind::trace
- at
/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/../../backtrace/src/backtrace/libunwind.rs:93:5
- 1: std::backtrace_rs::backtrace::trace_unsynchronized
- at
/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/../../backtrace/src/backtrace/mod.rs:66:5
- 2: std::backtrace::Backtrace::create
- at
/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/backtrace.rs:332:13
- 3: std::backtrace::Backtrace::capture
- at
/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/backtrace.rs:298:9
- 4: datafusion_common::error::DataFusionError::get_back_trace
- at /datafusion/datafusion/common/src/error.rs:436:30
- 5: datafusion_sql::expr::function::<impl
datafusion_sql::planner::SqlToRel<S>>::sql_function_to_expr
- ............
-```
-
-The backtraces are useful when debugging code. If there is a test in
`datafusion/core/src/physical_planner.rs`
-
-```
-#[tokio::test]
-async fn test_get_backtrace_for_failed_code() -> Result<()> {
- let ctx = SessionContext::new();
-
- let sql = "
- select row_number() over (partition by a order by a) from (select 1 a);
- ";
-
- let _ = ctx.sql(sql).await?.collect().await?;
-
- Ok(())
-}
-```
-
-To obtain a backtrace:
-
-```bash
-cargo build --features=backtrace
-RUST_BACKTRACE=1 cargo test --features=backtrace --package datafusion --lib --
physical_planner::tests::test_get_backtrace_for_failed_code --exact --nocapture
-```
-
-Note: The backtrace wrapped into systems calls, so some steps on top of the
backtrace can be ignored
diff --git a/contributor-guide/architecture.html
b/contributor-guide/architecture.html
index 02468f835a..0ef9652973 100644
--- a/contributor-guide/architecture.html
+++ b/contributor-guide/architecture.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/communication.html
b/contributor-guide/communication.html
index fb1b9078bd..6e9225553e 100644
--- a/contributor-guide/communication.html
+++ b/contributor-guide/communication.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/getting_started.html
b/contributor-guide/getting_started.html
index a2bf28ac10..3d89744b68 100644
--- a/contributor-guide/getting_started.html
+++ b/contributor-guide/getting_started.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/governance.html
b/contributor-guide/governance.html
index 4f4bd349f2..d83c482ddd 100644
--- a/contributor-guide/governance.html
+++ b/contributor-guide/governance.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/howtos.html b/contributor-guide/howtos.html
index 14adc603ea..85a11d9505 100644
--- a/contributor-guide/howtos.html
+++ b/contributor-guide/howtos.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/index.html b/contributor-guide/index.html
index 567cd14a9f..cfd87411c0 100644
--- a/contributor-guide/index.html
+++ b/contributor-guide/index.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/inviting.html b/contributor-guide/inviting.html
index fe4bc401cf..9b70f6c5e3 100644
--- a/contributor-guide/inviting.html
+++ b/contributor-guide/inviting.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/quarterly_roadmap.html
b/contributor-guide/quarterly_roadmap.html
index 5765b9f40a..bd28600c35 100644
--- a/contributor-guide/quarterly_roadmap.html
+++ b/contributor-guide/quarterly_roadmap.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/roadmap.html b/contributor-guide/roadmap.html
index c3293e7a26..911c339e60 100644
--- a/contributor-guide/roadmap.html
+++ b/contributor-guide/roadmap.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/specification/index.html
b/contributor-guide/specification/index.html
index 45448683fe..36a0b5e0d8 100644
--- a/contributor-guide/specification/index.html
+++ b/contributor-guide/specification/index.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal"
href="../../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/specification/invariants.html
b/contributor-guide/specification/invariants.html
index dbbd924773..f6bfd2f9d1 100644
--- a/contributor-guide/specification/invariants.html
+++ b/contributor-guide/specification/invariants.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal"
href="../../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/specification/output-field-name-semantic.html
b/contributor-guide/specification/output-field-name-semantic.html
index de8df5beed..dba161ed69 100644
--- a/contributor-guide/specification/output-field-name-semantic.html
+++ b/contributor-guide/specification/output-field-name-semantic.html
@@ -150,6 +150,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal"
href="../../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../../user-guide/cli/index.html">
DataFusion CLI
diff --git a/contributor-guide/testing.html b/contributor-guide/testing.html
index 834df0e39a..a37395482e 100644
--- a/contributor-guide/testing.html
+++ b/contributor-guide/testing.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/download.html b/download.html
index c01009011c..0d22afa1b2 100644
--- a/download.html
+++ b/download.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="user-guide/cli/index.html">
DataFusion CLI
diff --git a/genindex.html b/genindex.html
index bc606b303b..09b3bda8d5 100644
--- a/genindex.html
+++ b/genindex.html
@@ -148,6 +148,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="user-guide/cli/index.html">
DataFusion CLI
diff --git a/index.html b/index.html
index f8a55893c7..830af9c82c 100644
--- a/index.html
+++ b/index.html
@@ -150,6 +150,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="user-guide/cli/index.html">
DataFusion CLI
@@ -510,8 +515,12 @@ 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>To get started with examples, see the <a class="reference external"
href="user-guide/example-usage.html">example usage</a> section of the user
guide and the <a class="reference external"
href="https://github.com/apache/datafusion/tree/main/datafusion-examples";>datafusion-examples</a>
directory.</p>
-<p>See the <a class="reference external"
href="contributor-guide/index.html#developer-s-guide">developer’s guide</a> for
contributing and <a class="reference external"
href="contributor-guide/communication.html">communication</a> for getting in
touch with us.</p>
+<p>To get started, see</p>
+<ul class="simple">
+<li><p>The <a class="reference external"
href="user-guide/example-usage.html">example usage</a> section of the user
guide and the <a class="reference external"
href="https://github.com/apache/datafusion/tree/main/datafusion-examples";>datafusion-examples</a>
directory.</p></li>
+<li><p>The <a class="reference external"
href="library-user-guide/index.html">library user guide</a> for examples of
using DataFusion’s extension APIs</p></li>
+<li><p>The <a class="reference external"
href="contributor-guide/index.html#developer-s-guide">developer’s guide</a> for
contributing and <a class="reference external"
href="contributor-guide/communication.html">communication</a> for getting in
touch with us.</p></li>
+</ul>
<div class="toctree-wrapper compound" id="toc-asf-links">
<p aria-level="2" class="caption" role="heading"><span
class="caption-text">ASF Links</span></p>
<ul>
@@ -538,6 +547,7 @@ community.</p>
<ul>
<li class="toctree-l1"><a class="reference internal"
href="user-guide/introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal"
href="user-guide/example-usage.html">Example Usage</a></li>
+<li class="toctree-l1"><a class="reference internal"
href="user-guide/crate-configuration.html">Crate Configuration</a></li>
<li class="toctree-l1"><a class="reference internal"
href="user-guide/cli/index.html">DataFusion CLI</a></li>
<li class="toctree-l1"><a class="reference internal"
href="user-guide/dataframe.html">DataFrame API</a></li>
<li class="toctree-l1"><a class="reference internal"
href="user-guide/expressions.html">Expression API</a></li>
diff --git a/library-user-guide/adding-udfs.html
b/library-user-guide/adding-udfs.html
index 4a75981be5..a159508144 100644
--- a/library-user-guide/adding-udfs.html
+++ b/library-user-guide/adding-udfs.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/library-user-guide/building-logical-plans.html
b/library-user-guide/building-logical-plans.html
index 32bf91eb65..9259e1077f 100644
--- a/library-user-guide/building-logical-plans.html
+++ b/library-user-guide/building-logical-plans.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/library-user-guide/catalogs.html b/library-user-guide/catalogs.html
index 5b5af6dc40..a985b81342 100644
--- a/library-user-guide/catalogs.html
+++ b/library-user-guide/catalogs.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/library-user-guide/custom-table-providers.html
b/library-user-guide/custom-table-providers.html
index e7049b0ef8..cf06ba6528 100644
--- a/library-user-guide/custom-table-providers.html
+++ b/library-user-guide/custom-table-providers.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/library-user-guide/extending-operators.html
b/library-user-guide/extending-operators.html
index 182670e1b8..5caf73e422 100644
--- a/library-user-guide/extending-operators.html
+++ b/library-user-guide/extending-operators.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/library-user-guide/index.html b/library-user-guide/index.html
index dbff6a78dc..15e1ae4d55 100644
--- a/library-user-guide/index.html
+++ b/library-user-guide/index.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
@@ -516,8 +521,22 @@
-->
<section id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Link to this
heading">¶</a></h1>
-<p>The library user guide explains how to use the DataFusion library as a
dependency in your Rust project. Please check out the user-guide for more
details on how to use DataFusion’s SQL and DataFrame APIs, or the contributor
guide for details on how to contribute to DataFusion.</p>
-<p>If you haven’t reviewed the <a class="reference external"
href="https://docs.rs/datafusion/latest/datafusion/#architecture";>architecture
section in the docs</a>, it’s a useful place to get the lay of the land before
starting down a specific path.</p>
+<p>The library user guide explains how to use the DataFusion library as a
+dependency in your Rust project and customize its behavior using its extension
APIs.</p>
+<p>Please check out the <a class="reference internal"
href="../user-guide/example-usage.html"><span class="std std-doc">user
guide</span></a> for getting started using
+DataFusion’s SQL and DataFrame APIs, or the <a class="reference internal"
href="../contributor-guide/index.html"><span class="std std-doc">contributor
guide</span></a>
+for details on how to contribute to DataFusion.</p>
+<p>If you haven’t reviewed the <a class="reference external"
href="https://docs.rs/datafusion/latest/datafusion/#architecture";>architecture
section in the docs</a>, it’s a
+useful place to get the lay of the land before starting down a specific
path.</p>
+<p>DataFusion is designed to be extensible at all points, including</p>
+<ul class="contains-task-list simple">
+<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined Functions
(UDFs)</p></li>
+<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined Aggregate
Functions (UDAFs)</p></li>
+<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined Table
Source (<code class="docutils literal notranslate"><span
class="pre">TableProvider</span></code>) for tables</p></li>
+<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined <code
class="docutils literal notranslate"><span class="pre">Optimizer</span></code>
passes (plan rewrites)</p></li>
+<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined <code
class="docutils literal notranslate"><span
class="pre">LogicalPlan</span></code> nodes</p></li>
+<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined <code
class="docutils literal notranslate"><span
class="pre">ExecutionPlan</span></code> nodes</p></li>
+</ul>
</section>
diff --git a/library-user-guide/profiling.html
b/library-user-guide/profiling.html
index 4a47889a2f..9d38a0adde 100644
--- a/library-user-guide/profiling.html
+++ b/library-user-guide/profiling.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/library-user-guide/using-the-dataframe-api.html
b/library-user-guide/using-the-dataframe-api.html
index eb9ba77339..9374fae2a0 100644
--- a/library-user-guide/using-the-dataframe-api.html
+++ b/library-user-guide/using-the-dataframe-api.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/library-user-guide/using-the-sql-api.html
b/library-user-guide/using-the-sql-api.html
index 0ef1c64172..e5ea4955e2 100644
--- a/library-user-guide/using-the-sql-api.html
+++ b/library-user-guide/using-the-sql-api.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/library-user-guide/working-with-exprs.html
b/library-user-guide/working-with-exprs.html
index 38c4b0524f..dda1744085 100644
--- a/library-user-guide/working-with-exprs.html
+++ b/library-user-guide/working-with-exprs.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../user-guide/cli/index.html">
DataFusion CLI
diff --git a/objects.inv b/objects.inv
index cd98942a87..91383ce951 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/search.html b/search.html
index 81c93fb17a..6baf63b793 100644
--- a/search.html
+++ b/search.html
@@ -155,6 +155,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="user-guide/crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="user-guide/cli/index.html">
DataFusion CLI
diff --git a/searchindex.js b/searchindex.js
index 0ac34db1c8..b3572ed638 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"!=": [[43, "op-neq"]], "!~": [[43,
"op-re-not-match"]], "!~*": [[43, "op-re-not-match-i"]], "!~~": [[43, "id18"]],
"!~~*": [[43, "id19"]], "#": [[43, "op-bit-xor"]], "%": [[43, "op-modulo"]],
"&": [[43, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[10,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[43, "op-multiply"]], "+": [[43, "op-plus"]], "-": [[43, "op-minus"]], "/": [[
[...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"!=": [[44, "op-neq"]], "!~": [[44,
"op-re-not-match"]], "!~*": [[44, "op-re-not-match-i"]], "!~~": [[44, "id18"]],
"!~~*": [[44, "id19"]], "#": [[44, "op-bit-xor"]], "%": [[44, "op-modulo"]],
"&": [[44, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[10,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[44, "op-multiply"]], "+": [[44, "op-plus"]], "-": [[44, "op-minus"]], "/": [[
[...]
\ No newline at end of file
diff --git a/user-guide/cli/datasources.html b/user-guide/cli/datasources.html
index b2a0df3a34..e7f3478fb8 100644
--- a/user-guide/cli/datasources.html
+++ b/user-guide/cli/datasources.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 current active has-children">
<a class="reference internal" href="index.html">
DataFusion CLI
diff --git a/user-guide/cli/index.html b/user-guide/cli/index.html
index fef0038987..5bea717637 100644
--- a/user-guide/cli/index.html
+++ b/user-guide/cli/index.html
@@ -35,7 +35,7 @@
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Overview" href="overview.html" />
- <link rel="prev" title="Example Usage" href="../example-usage.html" />
+ <link rel="prev" title="Crate Configuration"
href="../crate-configuration.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 current active has-children">
<a class="current reference internal" href="#">
DataFusion CLI
@@ -548,11 +553,11 @@
<!-- Previous / next buttons -->
<div class='prev-next-area'>
- <a class='left-prev' id="prev-link" href="../example-usage.html"
title="previous page">
+ <a class='left-prev' id="prev-link" href="../crate-configuration.html"
title="previous page">
<i class="fas fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
- <p class="prev-next-title">Example Usage</p>
+ <p class="prev-next-title">Crate Configuration</p>
</div>
</a>
<a class='right-next' id="next-link" href="overview.html" title="next
page">
diff --git a/user-guide/cli/installation.html b/user-guide/cli/installation.html
index fe1f2ee2ed..c4c8fe8995 100644
--- a/user-guide/cli/installation.html
+++ b/user-guide/cli/installation.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 current active has-children">
<a class="reference internal" href="index.html">
DataFusion CLI
diff --git a/user-guide/cli/overview.html b/user-guide/cli/overview.html
index 20700a5f81..87eff2a7d3 100644
--- a/user-guide/cli/overview.html
+++ b/user-guide/cli/overview.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 current active has-children">
<a class="reference internal" href="index.html">
DataFusion CLI
diff --git a/user-guide/cli/usage.html b/user-guide/cli/usage.html
index 670ba3af8e..2607744caf 100644
--- a/user-guide/cli/usage.html
+++ b/user-guide/cli/usage.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 current active has-children">
<a class="reference internal" href="index.html">
DataFusion CLI
diff --git a/user-guide/configs.html b/user-guide/configs.html
index 98bda9b97f..0f38bdc6d2 100644
--- a/user-guide/configs.html
+++ b/user-guide/configs.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="cli/index.html">
DataFusion CLI
diff --git a/user-guide/example-usage.html b/user-guide/crate-configuration.html
similarity index 53%
copy from user-guide/example-usage.html
copy to user-guide/crate-configuration.html
index 2b5b9e8a83..2c11c880d1 100644
--- a/user-guide/example-usage.html
+++ b/user-guide/crate-configuration.html
@@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"
/><meta name="viewport" content="width=device-width, initial-scale=1" />
- <title>Example Usage — Apache DataFusion documentation</title>
+ <title>Crate Configuration — Apache DataFusion documentation</title>
<link href="../_static/styles/theme.css?digest=1999514e3f237ded88cf"
rel="stylesheet">
<link
href="../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf"
rel="stylesheet">
@@ -35,7 +35,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="DataFusion CLI" href="cli/index.html" />
- <link rel="prev" title="Introduction" href="introduction.html" />
+ <link rel="prev" title="Example Usage" href="example-usage.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
@@ -146,9 +146,14 @@
Introduction
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="example-usage.html">
+ Example Usage
+ </a>
+ </li>
<li class="toctree-l1 current active">
<a class="current reference internal" href="#">
- Example Usage
+ Crate Configuration
</a>
</li>
<li class="toctree-l1 has-children">
@@ -473,61 +478,11 @@
<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="#add-published-datafusion-dependency">
- Add published DataFusion dependency
- </a>
- </li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link"
href="#add-latest-non-published-datafusion-dependency">
Add latest non published DataFusion dependency
</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>
- <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
- </a>
- </li>
- <li class="toc-h2 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id1">
- 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="#id2">
- 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="#id3">
- Output from both examples
- </a>
- </li>
- <li class="toc-h2 nav-item toc-entry">
- <a class="reference internal nav-link" href="#extensibility">
- Extensibility
- </a>
- </li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#optimized-configuration">
Optimized Configuration
@@ -547,7 +502,7 @@
<div class="tocsection editthispage">
- <a
href="https://github.com/apache/arrow-datafusion/edit/main/docs/source/user-guide/example-usage.md";>
+ <a
href="https://github.com/apache/arrow-datafusion/edit/main/docs/source/user-guide/crate-configuration.md";>
<i class="fas fa-pencil-alt"></i> Edit this page
</a>
</div>
@@ -584,23 +539,16 @@
specific language governing permissions and limitations
under the License.
-->
-<section id="example-usage">
-<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/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/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="add-published-datafusion-dependency">
-<h2>Add published DataFusion dependency<a class="headerlink"
href="#add-published-datafusion-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">"latest_version"</span>
-<span class="n">tokio</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">"1.0"</span><span class="p">,</span><span class="w">
</span><span class="n">features</span><span class="w"> </span><span
class="p">=</span><span class="w"> </span><span class="p">[</span><span
class="s2">"rt-mu [...]
-</pre></div>
-</div>
-</section>
+<section id="crate-configuration">
+<h1>Crate Configuration<a class="headerlink" href="#crate-configuration"
title="Link to this heading">¶</a></h1>
+<p>This section contains information on how to configure DataFusion in your
Rust
+project. See the <a class="reference internal" href="configs.html"><span
class="std std-doc">Configuration Settings</span></a> section for a list of
options that
+control DataFusion’s behavior.</p>
<section id="add-latest-non-published-datafusion-dependency">
<h2>Add latest non published DataFusion dependency<a class="headerlink"
href="#add-latest-non-published-datafusion-dependency" title="Link to this
heading">¶</a></h2>
-<p>DataFusion changes are published to <code class="docutils literal
notranslate"><span class="pre">crates.io</span></code> according to <a
class="reference external"
href="https://github.com/apache/datafusion/blob/main/dev/release/README.md#release-process";>release
schedule</a>
-In case if it is required to test out DataFusion changes which are merged but
yet to be published, Cargo supports adding dependency directly to GitHub
branch</p>
+<p>DataFusion changes are published to <code class="docutils literal
notranslate"><span class="pre">crates.io</span></code> according to the <a
class="reference external"
href="https://github.com/apache/datafusion/blob/main/dev/release/README.md#release-process";>release
schedule</a></p>
+<p>If you would like to test out DataFusion changes which are merged but not
yet
+published, Cargo supports adding dependency directly to GitHub branch:</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/datafusion"</span><span
class="p">,</span><span class="w"> </span><span class="n">branch</span><span
class [...]
</pre></div>
</div>
@@ -614,152 +562,6 @@ In case if it is required to test out DataFusion changes
which are merged but ye
</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="p">::</span><span
class="n">prelude</span><span class="p">::</span><span class="o">*</span><span
class="p">;</span>
-
-<span class="cp">#[tokio::main]</span>
-<span class="k">async</span><span class="w"> </span><span
class="k">fn</span><span class="w"> </span><span class="nf">main</span><span
class="p">()</span><span class="w"> </span><span class="p">-></span><span
class="w"> </span><span class="nc">datafusion</span><span
class="p">::</span><span class="n">error</span><span class="p">::</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="c1">// register the table</span>
-<span class="w"> </span><span class="kd">let</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">SessionContext</span><span class="p">::</span><span
class="n">new</span><span class="p">();</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/data/example.csv"</span><span
class="p">,</span><span class="w"> </span><span
class="n">CsvReadOptions</span><span class="p">::</span><span
class="n">new</span><span class="p">()).</span><span
class="k">await</span><span class="o">?</s [...]
-
-<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 WHERE a <= b 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="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><span class="nb">Ok</span><span class="p">(())</span>
-<span class="p">}</span>
-</pre></div>
-</div>
-<p>See <a class="reference internal"
href="../library-user-guide/using-the-sql-api.html"><span class="std
std-doc">the SQL API</span></a> section of the
-library guide for more information on the SQL API.</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="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="p">::</span><span
class="n">prelude</span><span class="p">::</span><span class="o">*</span><span
class="p">;</span>
-
-<span class="cp">#[tokio::main]</span>
-<span class="k">async</span><span class="w"> </span><span
class="k">fn</span><span class="w"> </span><span class="nf">main</span><span
class="p">()</span><span class="w"> </span><span class="p">-></span><span
class="w"> </span><span class="nc">datafusion</span><span
class="p">::</span><span class="n">error</span><span class="p">::</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="c1">// create the dataframe</span>
-<span class="w"> </span><span class="kd">let</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">SessionContext</span><span class="p">::</span><span
class="n">new</span><span class="p">();</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/data/example.csv"</span><span
class="p">,</span><span class="w"> </span><span
class="n">CsvReadOptions</span><span class="p">::</span><span
class="n">new</span><span class="p">()).< [...]
-
-<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 [...]
-<span class="w"> </span><span class="p">.</span><span
class="n">limit</span><span class="p">(</span><span class="mi">0</span><span
class="p">,</span><span class="w"> </span><span class="nb">Some</span><span
class="p">(</span><span class="mi">100</span><span class="p">))</span><span
class="o">?</span><span class="p">;</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><span class="nb">Ok</span><span class="p">(())</span>
-<span class="p">}</span>
-</pre></div>
-</div>
-</section>
-<section id="output-from-both-examples">
-<h2>Output from both examples<a class="headerlink"
href="#output-from-both-examples" title="Link to this heading">¶</a></h2>
-<div class="highlight-text notranslate"><div
class="highlight"><pre><span></span>+---+--------+
-| a | MIN(b) |
-+---+--------+
-| 1 | 2 |
-+---+--------+
-</pre></div>
-</div>
-</section>
-<section id="arrow-versions">
-<h2>Arrow Versions<a class="headerlink" href="#arrow-versions" title="Link 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="p">::</span><span
class="n">arrow</span><span class="p">::</span><span
class="n">datatypes</span><span class="p">::</span><span
class="n">Schema</span><span class="p">;</span>
-</pre></div>
-</div>
-<p>For example, [DataFusion <code class="docutils literal notranslate"><span
class="pre">25.0.0</span></code> dependencies] 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="Link 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>
-<p>To illustrate this behavior, consider the <a class="reference download
internal" download=""
href="../_downloads/3cce4d737d8c5814f5b50d859d21ba53/capitalized_example.csv"><span
class="xref download myst"><code class="docutils literal notranslate"><span
class="pre">capitalized_example.csv</span></code></span></a> file:</p>
-</section>
-<section id="id1">
-<h2>Run a SQL query against data stored in a CSV:<a class="headerlink"
href="#id1" 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="p">::</span><span
class="n">prelude</span><span class="p">::</span><span class="o">*</span><span
class="p">;</span>
-
-<span class="cp">#[tokio::main]</span>
-<span class="k">async</span><span class="w"> </span><span
class="k">fn</span><span class="w"> </span><span class="nf">main</span><span
class="p">()</span><span class="w"> </span><span class="p">-></span><span
class="w"> </span><span class="nc">datafusion</span><span
class="p">::</span><span class="n">error</span><span class="p">::</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="c1">// register the table</span>
-<span class="w"> </span><span class="kd">let</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">SessionContext</span><span class="p">::</span><span
class="n">new</span><span class="p">();</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/data/capitalized_example.csv"</span><span
class="p">,</span><span class="w"> </span><span
class="n">CsvReadOptions</span><span class="p">::</span><span
class="n">new</span><span class="p">()).</span><span
class="k">await</span><span cl [...]
-
-<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 </span><span class="se">\"</span><span
class="s">A</span><span class="se">\"</span><span class="s">, MIN(b) FROM
example WHERE </span><span class="se">\"</span><span class="s" [...]
-
-<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><span class="nb">Ok</span><span class="p">(())</span>
-<span class="p">}</span>
-</pre></div>
-</div>
-</section>
-<section id="id2">
-<h2>Use the DataFrame API to process data stored in a CSV:<a
class="headerlink" href="#id2" 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="p">::</span><span
class="n">prelude</span><span class="p">::</span><span class="o">*</span><span
class="p">;</span>
-
-<span class="cp">#[tokio::main]</span>
-<span class="k">async</span><span class="w"> </span><span
class="k">fn</span><span class="w"> </span><span class="nf">main</span><span
class="p">()</span><span class="w"> </span><span class="p">-></span><span
class="w"> </span><span class="nc">datafusion</span><span
class="p">::</span><span class="n">error</span><span class="p">::</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="c1">// create the dataframe</span>
-<span class="w"> </span><span class="kd">let</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">SessionContext</span><span class="p">::</span><span
class="n">new</span><span class="p">();</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/data/capitalized_example.csv"</span><span
class="p">,</span><span class="w"> </span><span
class="n">CsvReadOptions</span><span class="p">::</span><span
class="n">new</span><span cla [...]
-
-<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="w"> </span><span class="c1">// col will parse the input
string, hence requiring double quotes to maintain the capitalization</span>
-<span class="w"> </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">"</span><span
class="se">\"</span><span class="s">A</span><span
class="se">\"</span><span class="s">"</span><span
class="p">).</span><span class="n">lt_eq</span><span class="p">(</span><span
class="n">col</span><span class="p">(</span><span
class="s">"c"</span><span class="p">)))</span><sp [...]
-<span class="w"> </span><span class="c1">// alternatively use ident to
pass in an unqualified column name directly without parsing</span>
-<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">ident</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><span [...]
-<span class="w"> </span><span class="p">.</span><span
class="n">limit</span><span class="p">(</span><span class="mi">0</span><span
class="p">,</span><span class="w"> </span><span class="nb">Some</span><span
class="p">(</span><span class="mi">100</span><span class="p">))</span><span
class="o">?</span><span class="p">;</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><span class="nb">Ok</span><span class="p">(())</span>
-<span class="p">}</span>
-</pre></div>
-</div>
-</section>
-<section id="id3">
-<h2>Output from both examples<a class="headerlink" href="#id3" title="Link to
this heading">¶</a></h2>
-<div class="highlight-text notranslate"><div
class="highlight"><pre><span></span>+---+--------+
-| A | MIN(b) |
-+---+--------+
-| 2 | 1 |
-| 1 | 2 |
-+---+--------+
-</pre></div>
-</div>
-</section>
-<section id="extensibility">
-<h2>Extensibility<a class="headerlink" href="#extensibility" title="Link to
this heading">¶</a></h2>
-<p>DataFusion is designed to be extensible at all points. To that end, you can
provide your own custom:</p>
-<ul class="contains-task-list simple">
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined Functions
(UDFs)</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined Aggregate
Functions (UDAFs)</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined Table
Source (<code class="docutils literal notranslate"><span
class="pre">TableProvider</span></code>) for tables</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined <code
class="docutils literal notranslate"><span class="pre">Optimizer</span></code>
passes (plan rewrites)</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined <code
class="docutils literal notranslate"><span
class="pre">LogicalPlan</span></code> nodes</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined <code
class="docutils literal notranslate"><span
class="pre">ExecutionPlan</span></code> nodes</p></li>
-</ul>
-</section>
<section id="optimized-configuration">
<h2>Optimized Configuration<a class="headerlink"
href="#optimized-configuration" title="Link to this heading">¶</a></h2>
<p>For an optimized build several steps are required. First, use the below in
your <code class="docutils literal notranslate"><span
class="pre">Cargo.toml</span></code>. It is
@@ -802,8 +604,8 @@ like error backtrace. To enable a backtrace you need to add
Datafusion <code cla
<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_number<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 c [...]
-Error<span class="w"> </span>during<span class="w"> </span>planning:<span
class="w"> </span>Invalid<span class="w"> </span><span
class="k">function</span><span class="w"> </span><span
class="s1">'row_number'</span>.
+><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 cl [...]
+Error<span class="w"> </span>during<span class="w"> </span>planning:<span
class="w"> </span>Invalid<span class="w"> </span><span
class="k">function</span><span class="w"> </span><span
class="s1">'row_numer'</span>.
Did<span class="w"> </span>you<span class="w"> </span>mean<span class="w">
</span><span class="s1">'ROW_NUMBER'</span>?
backtrace:<span class="w"> </span><span class="m">0</span>:<span class="w">
</span>std::backtrace_rs::backtrace::libunwind::trace
@@ -826,7 +628,7 @@ async fn test_get_backtrace_for_failed_code() ->
Result<()> {
let ctx = SessionContext::new();
let sql = "
- select row_number() over (partition by a order by a) from (select 1 a);
+ select row_numer() over (partition by a order by a) from (select 1 a);
";
let _ = ctx.sql(sql).await?.collect().await?;
@@ -850,11 +652,11 @@ async fn test_get_backtrace_for_failed_code() ->
Result<()> {
<!-- Previous / next buttons -->
<div class='prev-next-area'>
- <a class='left-prev' id="prev-link" href="introduction.html"
title="previous page">
+ <a class='left-prev' id="prev-link" href="example-usage.html"
title="previous page">
<i class="fas fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
- <p class="prev-next-title">Introduction</p>
+ <p class="prev-next-title">Example Usage</p>
</div>
</a>
<a class='right-next' id="next-link" href="cli/index.html" title="next
page">
diff --git a/user-guide/dataframe.html b/user-guide/dataframe.html
index d88900ab06..c3b2584cd1 100644
--- a/user-guide/dataframe.html
+++ b/user-guide/dataframe.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="cli/index.html">
DataFusion CLI
diff --git a/user-guide/example-usage.html b/user-guide/example-usage.html
index 2b5b9e8a83..8e75613485 100644
--- a/user-guide/example-usage.html
+++ b/user-guide/example-usage.html
@@ -34,7 +34,7 @@
<script async="true" defer="true"
src="https://buttons.github.io/buttons.js";></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="DataFusion CLI" href="cli/index.html" />
+ <link rel="next" title="Crate Configuration"
href="crate-configuration.html" />
<link rel="prev" title="Introduction" href="introduction.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="cli/index.html">
DataFusion CLI
@@ -478,11 +483,6 @@
Add published DataFusion dependency
</a>
</li>
- <li class="toc-h2 nav-item toc-entry">
- <a class="reference internal nav-link"
href="#add-latest-non-published-datafusion-dependency">
- Add latest non published DataFusion dependency
- </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
@@ -523,21 +523,6 @@
Output from both examples
</a>
</li>
- <li class="toc-h2 nav-item toc-entry">
- <a class="reference internal nav-link" href="#extensibility">
- Extensibility
- </a>
- </li>
- <li class="toc-h2 nav-item toc-entry">
- <a class="reference internal nav-link" href="#optimized-configuration">
- Optimized Configuration
- </a>
- </li>
- <li class="toc-h2 nav-item toc-entry">
- <a class="reference internal nav-link" href="#enable-backtraces">
- Enable backtraces
- </a>
- </li>
</ul>
</nav>
@@ -597,23 +582,6 @@ crates.io</a> page. Add the dependency to your <code
class="docutils literal not
</pre></div>
</div>
</section>
-<section id="add-latest-non-published-datafusion-dependency">
-<h2>Add latest non published DataFusion dependency<a class="headerlink"
href="#add-latest-non-published-datafusion-dependency" title="Link to this
heading">¶</a></h2>
-<p>DataFusion changes are published to <code class="docutils literal
notranslate"><span class="pre">crates.io</span></code> according to <a
class="reference external"
href="https://github.com/apache/datafusion/blob/main/dev/release/README.md#release-process";>release
schedule</a>
-In case if it is required to test out DataFusion changes which are merged but
yet to be published, Cargo supports adding dependency directly to GitHub
branch</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/datafusion"</span><span
class="p">,</span><span class="w"> </span><span class="n">branch</span><span
class [...]
-</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/datafusion"</span><span
class="p">,</span><span class="w"> </span><span class="n">branch</span><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/datafusion"</span><span
class="p">,</span><span class="w"> </span><span class="n">branch</span><span
class [...]
-</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="p">::</span><span
class="n">prelude</span><span class="p">::</span><span class="o">*</span><span
class="p">;</span>
@@ -748,100 +716,6 @@ unexpectedly.</p>
</pre></div>
</div>
</section>
-<section id="extensibility">
-<h2>Extensibility<a class="headerlink" href="#extensibility" title="Link to
this heading">¶</a></h2>
-<p>DataFusion is designed to be extensible at all points. To that end, you can
provide your own custom:</p>
-<ul class="contains-task-list simple">
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined Functions
(UDFs)</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined Aggregate
Functions (UDAFs)</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined Table
Source (<code class="docutils literal notranslate"><span
class="pre">TableProvider</span></code>) for tables</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined <code
class="docutils literal notranslate"><span class="pre">Optimizer</span></code>
passes (plan rewrites)</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined <code
class="docutils literal notranslate"><span
class="pre">LogicalPlan</span></code> nodes</p></li>
-<li class="task-list-item"><p><input class="task-list-item-checkbox"
checked="checked" disabled="disabled" type="checkbox"> User Defined <code
class="docutils literal notranslate"><span
class="pre">ExecutionPlan</span></code> nodes</p></li>
-</ul>
-</section>
-<section id="optimized-configuration">
-<h2>Optimized Configuration<a class="headerlink"
href="#optimized-configuration" title="Link to this heading">¶</a></h2>
-<p>For an optimized build several steps are required. First, use the below in
your <code class="docutils literal notranslate"><span
class="pre">Cargo.toml</span></code>. It is
-worth noting that using the settings in the <code class="docutils literal
notranslate"><span class="pre">[profile.release]</span></code> section will
significantly increase the build time.</p>
-<div class="highlight-toml notranslate"><div
class="highlight"><pre><span></span><span class="k">[dependencies]</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">"22.0"</span><span class="w"> </span><span
class="p">}</span>
-<span class="n">tokio</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">"^1.0"</span><span class="p">,</span><span class="w">
</span><span class="n">features</span><span class="w"> </span><span
class="p">=</span><span class="w"> </span><span class="p">[</span><span
class="s2">"rt-m [...]
-<span class="n">snmalloc-rs</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span
class="s2">"0.3"</span>
-
-<span class="k">[profile.release]</span>
-<span class="n">lto</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span class="kc">true</span>
-<span class="n">codegen-units</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span class="mi">1</span>
-</pre></div>
-</div>
-<p>Then, in <code class="docutils literal notranslate"><span
class="pre">main.rs.</span></code> update the memory allocator with the below
after your imports:</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="p">::</span><span
class="n">prelude</span><span class="p">::</span><span class="o">*</span><span
class="p">;</span>
-
-<span class="cp">#[global_allocator]</span>
-<span class="k">static</span><span class="w"> </span><span
class="n">ALLOC</span><span class="p">:</span><span class="w"> </span><span
class="nc">snmalloc_rs</span><span class="p">::</span><span
class="n">SnMalloc</span><span class="w"> </span><span class="o">=</span><span
class="w"> </span><span class="n">snmalloc_rs</span><span
class="p">::</span><span class="n">SnMalloc</span><span class="p">;</span>
-
-<span class="cp">#[tokio::main]</span>
-<span class="k">async</span><span class="w"> </span><span
class="k">fn</span><span class="w"> </span><span class="nf">main</span><span
class="p">()</span><span class="w"> </span><span class="p">-></span><span
class="w"> </span><span class="nc">datafusion</span><span
class="p">::</span><span class="n">error</span><span class="p">::</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="nb">Ok</span><span class="p">(())</span>
-<span class="p">}</span>
-</pre></div>
-</div>
-<p>Based on the instruction set architecture you are building on you will want
to configure the <code class="docutils literal notranslate"><span
class="pre">target-cpu</span></code> as well, ideally
-with <code class="docutils literal notranslate"><span
class="pre">native</span></code> or at least <code class="docutils literal
notranslate"><span class="pre">avx2</span></code>.</p>
-<div class="highlight-shell notranslate"><div
class="highlight"><pre><span></span><span class="nv">RUSTFLAGS</span><span
class="o">=</span><span class="s1">'-C target-cpu=native'</span><span
class="w"> </span>cargo<span class="w"> </span>run<span class="w">
</span>--release
-</pre></div>
-</div>
-</section>
-<section id="enable-backtraces">
-<h2>Enable backtraces<a class="headerlink" href="#enable-backtraces"
title="Link to this heading">¶</a></h2>
-<p>By default Datafusion returns errors as a plain message. There is option to
enable more verbose details about the error,
-like error backtrace. To enable a backtrace you need to add Datafusion <code
class="docutils literal notranslate"><span class="pre">backtrace</span></code>
feature 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="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 <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_number<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 c [...]
-Error<span class="w"> </span>during<span class="w"> </span>planning:<span
class="w"> </span>Invalid<span class="w"> </span><span
class="k">function</span><span class="w"> </span><span
class="s1">'row_number'</span>.
-Did<span class="w"> </span>you<span class="w"> </span>mean<span class="w">
</span><span class="s1">'ROW_NUMBER'</span>?
-
-backtrace:<span class="w"> </span><span class="m">0</span>:<span class="w">
</span>std::backtrace_rs::backtrace::libunwind::trace
-<span class="w"> </span>at<span class="w">
</span>/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/../../backtrace/src/backtrace/libunwind.rs:93:5
-<span class="w"> </span><span class="m">1</span>:<span class="w">
</span>std::backtrace_rs::backtrace::trace_unsynchronized
-<span class="w"> </span>at<span class="w">
</span>/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/../../backtrace/src/backtrace/mod.rs:66:5
-<span class="w"> </span><span class="m">2</span>:<span class="w">
</span>std::backtrace::Backtrace::create
-<span class="w"> </span>at<span class="w">
</span>/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/backtrace.rs:332:13
-<span class="w"> </span><span class="m">3</span>:<span class="w">
</span>std::backtrace::Backtrace::capture
-<span class="w"> </span>at<span class="w">
</span>/rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/backtrace.rs:298:9
-<span class="w"> </span><span class="m">4</span>:<span class="w">
</span>datafusion_common::error::DataFusionError::get_back_trace
-<span class="w"> </span>at<span class="w">
</span>/datafusion/datafusion/common/src/error.rs:436:30
-<span class="w"> </span><span class="m">5</span>:<span class="w">
</span>datafusion_sql::expr::function::<impl<span class="w">
</span>datafusion_sql::planner::SqlToRel<S>>::sql_function_to_expr
-<span class="w"> </span>............
-</pre></div>
-</div>
-<p>The backtraces are useful when debugging code. If there is a test in <code
class="docutils literal notranslate"><span
class="pre">datafusion/core/src/physical_planner.rs</span></code></p>
-<div class="highlight-default notranslate"><div
class="highlight"><pre><span></span>#[tokio::test]
-async fn test_get_backtrace_for_failed_code() -> Result<()> {
- let ctx = SessionContext::new();
-
- let sql = "
- select row_number() over (partition by a order by a) from (select 1 a);
- ";
-
- let _ = ctx.sql(sql).await?.collect().await?;
-
- Ok(())
-}
-</pre></div>
-</div>
-<p>To obtain a backtrace:</p>
-<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span>cargo<span class="w"> </span>build<span
class="w"> </span>--features<span class="o">=</span>backtrace
-<span class="nv">RUST_BACKTRACE</span><span class="o">=</span><span
class="m">1</span><span class="w"> </span>cargo<span class="w"> </span><span
class="nb">test</span><span class="w"> </span>--features<span
class="o">=</span>backtrace<span class="w"> </span>--package<span class="w">
</span>datafusion<span class="w"> </span>--lib<span class="w"> </span>--<span
class="w">
</span>physical_planner::tests::test_get_backtrace_for_failed_code<span
class="w"> </span>--exact<span class="w"> </spa [...]
-</pre></div>
-</div>
-<p>Note: The backtrace wrapped into systems calls, so some steps on top of the
backtrace can be ignored</p>
-</section>
</section>
@@ -857,10 +731,10 @@ async fn test_get_backtrace_for_failed_code() ->
Result<()> {
<p class="prev-next-title">Introduction</p>
</div>
</a>
- <a class='right-next' id="next-link" href="cli/index.html" title="next
page">
+ <a class='right-next' id="next-link" href="crate-configuration.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
- <p class="prev-next-title">DataFusion CLI</p>
+ <p class="prev-next-title">Crate Configuration</p>
</div>
<i class="fas fa-angle-right"></i>
</a>
diff --git a/user-guide/expressions.html b/user-guide/expressions.html
index 00dd4d5090..4ca966891f 100644
--- a/user-guide/expressions.html
+++ b/user-guide/expressions.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="cli/index.html">
DataFusion CLI
diff --git a/user-guide/faq.html b/user-guide/faq.html
index e3ef225b7c..2a2f968881 100644
--- a/user-guide/faq.html
+++ b/user-guide/faq.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="cli/index.html">
DataFusion CLI
diff --git a/user-guide/introduction.html b/user-guide/introduction.html
index 18014b74a5..d92c6c9998 100644
--- a/user-guide/introduction.html
+++ b/user-guide/introduction.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/aggregate_functions.html
b/user-guide/sql/aggregate_functions.html
index 006074265c..5a63032e9a 100644
--- a/user-guide/sql/aggregate_functions.html
+++ b/user-guide/sql/aggregate_functions.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/data_types.html b/user-guide/sql/data_types.html
index c4e50f4ddd..ba2c9aefb4 100644
--- a/user-guide/sql/data_types.html
+++ b/user-guide/sql/data_types.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/ddl.html b/user-guide/sql/ddl.html
index 4515a14f1b..6db0645c9c 100644
--- a/user-guide/sql/ddl.html
+++ b/user-guide/sql/ddl.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/dml.html b/user-guide/sql/dml.html
index 5c821b393d..313e500d9a 100644
--- a/user-guide/sql/dml.html
+++ b/user-guide/sql/dml.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/explain.html b/user-guide/sql/explain.html
index ed14ae1cac..2988e917ad 100644
--- a/user-guide/sql/explain.html
+++ b/user-guide/sql/explain.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/index.html b/user-guide/sql/index.html
index 554698c019..722e182f15 100644
--- a/user-guide/sql/index.html
+++ b/user-guide/sql/index.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/information_schema.html
b/user-guide/sql/information_schema.html
index 7d8ca2fbfd..dd11bac5c0 100644
--- a/user-guide/sql/information_schema.html
+++ b/user-guide/sql/information_schema.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/operators.html b/user-guide/sql/operators.html
index 83be3e1e71..06c2c0a622 100644
--- a/user-guide/sql/operators.html
+++ b/user-guide/sql/operators.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/scalar_functions.html
b/user-guide/sql/scalar_functions.html
index b6152fb49b..0dde2d6b7f 100644
--- a/user-guide/sql/scalar_functions.html
+++ b/user-guide/sql/scalar_functions.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/select.html b/user-guide/sql/select.html
index 8efb7221f3..5901cba46a 100644
--- a/user-guide/sql/select.html
+++ b/user-guide/sql/select.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/sql_status.html b/user-guide/sql/sql_status.html
index 0903de7e3a..a86b883fcc 100644
--- a/user-guide/sql/sql_status.html
+++ b/user-guide/sql/sql_status.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/subqueries.html b/user-guide/sql/subqueries.html
index cee95ef5ec..d9a940426d 100644
--- a/user-guide/sql/subqueries.html
+++ b/user-guide/sql/subqueries.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/window_functions.html
b/user-guide/sql/window_functions.html
index 6be8816daf..7771e8e445 100644
--- a/user-guide/sql/window_functions.html
+++ b/user-guide/sql/window_functions.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
diff --git a/user-guide/sql/write_options.html
b/user-guide/sql/write_options.html
index afbf7f0f77..a1b6025f8e 100644
--- a/user-guide/sql/write_options.html
+++ b/user-guide/sql/write_options.html
@@ -151,6 +151,11 @@
Example Usage
</a>
</li>
+ <li class="toctree-l1">
+ <a class="reference internal" href="../crate-configuration.html">
+ Crate Configuration
+ </a>
+ </li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../cli/index.html">
DataFusion CLI
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
