Apache DataFusion SQL Query Engine
Update links in documentation to point at new example locations (#18931)
Andrew Lamb838e1dea832e
diff --git a/datafusion/core/src/execution/context/mod.rs b/datafusion/core/src/execution/context/mod.rsindex 9c7339e674..d9e6452d1d 100644--- a/datafusion/core/src/execution/context/mod.rs+++ b/datafusion/core/src/execution/context/mod.rs@@ -785,7 +785,7 @@ impl SessionContext {/// * [`SessionState::create_physical_expr`] for a lower level API////// [simplified]: datafusion_optimizer::simplify_expressions- /// [expr_api]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/expr_api.rs+ /// [expr_api]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/expr_api.rspub fn create_physical_expr(&self,expr: Expr,@@ -1903,7 +1903,7 @@ pub trait QueryPlanner: Debug {/// because the implementation and requirements vary widely. Please see/// [function_factory example] for a reference implementation.///-/// [function_factory example]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/function_factory.rs+/// [function_factory example]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/function_factory.rs////// # Examples of syntax that can be supported///diff --git a/datafusion/core/src/execution/session_state.rs b/datafusion/core/src/execution/session_state.rsindex 8bc526fbfb..37ec27ef75 100644--- a/datafusion/core/src/execution/session_state.rs+++ b/datafusion/core/src/execution/session_state.rs@@ -707,7 +707,7 @@ impl SessionState {/// * [`create_physical_expr`] for a lower-level API////// [simplified]: datafusion_optimizer::simplify_expressions- /// [expr_api]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/expr_api.rs+ /// [expr_api]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/expr_api.rs/// [`SessionContext::create_physical_expr`]: crate::execution::context::SessionContext::create_physical_exprpub fn create_physical_expr(&self,diff --git a/datafusion/core/src/lib.rs b/datafusion/core/src/lib.rsindex 2408488d04..84ba8691a7 100644--- a/datafusion/core/src/lib.rs+++ b/datafusion/core/src/lib.rs@@ -360,7 +360,7 @@//! [`TreeNode`]: datafusion_common::tree_node::TreeNode//! [`tree_node module`]: datafusion_expr::logical_plan::tree_node//! [`ExprSimplifier`]: crate::optimizer::simplify_expressions::ExprSimplifier-//! [`expr_api`.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/expr_api.rs+//! [`expr_api`.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/expr_api.rs//!//! ### Physical Plans//!@@ -649,7 +649,7 @@//!//! [Tokio]: https://tokio.rs//! [`Runtime`]: tokio::runtime::Runtime-//! [thread_pools example]: https://github.com/apache/datafusion/tree/main/datafusion-examples/examples/thread_pools.rs+//! [thread_pools example]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/thread_pools.rs//! [`task`]: tokio::task//! [Using Rustlang’s Async Tokio Runtime for CPU-Bound Tasks]: https://thenewstack.io/using-rustlangs-async-tokio-runtime-for-cpu-bound-tasks///! [`RepartitionExec`]: physical_plan::repartition::RepartitionExecdiff --git a/datafusion/datasource-parquet/src/source.rs b/datafusion/datasource-parquet/src/source.rsindex da7bc125d2..ad7474af80 100644--- a/datafusion/datasource-parquet/src/source.rs+++ b/datafusion/datasource-parquet/src/source.rs@@ -240,7 +240,7 @@ use parquet::encryption::decrypt::FileDecryptionProperties;////// For a complete example, see the [`advanced_parquet_index` example]).///-/// [`parquet_index_advanced` example]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_parquet_index.rs+/// [`parquet_index_advanced` example]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/data_io/parquet_advanced_index.rs////// # Execution Overview///diff --git a/datafusion/execution/src/memory_pool/pool.rs b/datafusion/execution/src/memory_pool/pool.rsindex 135a55275b..9b2a861b75 100644--- a/datafusion/execution/src/memory_pool/pool.rs+++ b/datafusion/execution/src/memory_pool/pool.rs@@ -319,8 +319,8 @@ impl TrackedConsumer {////// For more examples of using `TrackConsumersPool`, see the [memory_pool_tracking.rs] example///-/// [memory_pool_tracking.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/memory_pool_tracking.rs-/// [memory_pool_execution_plan.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/memory_pool_execution_plan.rs+/// [memory_pool_tracking.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/execution_monitoring/memory_pool_tracking.rs+/// [memory_pool_execution_plan.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/execution_monitoring/memory_pool_execution_plan.rs#[derive(Debug)]pub struct TrackConsumersPool<I> {/// The wrapped memory pool that actually handles reservation logicdiff --git a/datafusion/execution/src/parquet_encryption.rs b/datafusion/execution/src/parquet_encryption.rsindex 027421e08f..45eac10264 100644--- a/datafusion/execution/src/parquet_encryption.rs+++ b/datafusion/execution/src/parquet_encryption.rs@@ -32,7 +32,7 @@ use std::sync::Arc;/// integrate with a user's key management service (KMS)./// For example usage, see the [`parquet_encrypted_with_kms` example].///-/// [`parquet_encrypted_with_kms` example]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/parquet_encrypted_with_kms.rs+/// [`parquet_encrypted_with_kms` example]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/data_io/parquet_encrypted_with_kms.rs#[async_trait]pub trait EncryptionFactory: Send + Sync + std::fmt::Debug + 'static {/// Generate file encryption properties to use when writing a Parquet file.diff --git a/datafusion/expr/src/expr.rs b/datafusion/expr/src/expr.rsindex 13160d573a..714925dadc 100644--- a/datafusion/expr/src/expr.rs+++ b/datafusion/expr/src/expr.rs@@ -479,7 +479,7 @@ impl<'a> TreeNodeContainer<'a, Self> for Expr {/// that may be missing in the physical data but present in the logical schema./// See the [default_column_values.rs] example implementation.///-/// [default_column_values.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/default_column_values.rs+/// [default_column_values.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/custom_data_source/default_column_values.rspub type SchemaFieldMetadata = std::collections::HashMap<String, String>;/// Intersects multiple metadata instances for UNION operations.diff --git a/datafusion/expr/src/simplify.rs b/datafusion/expr/src/simplify.rsindex 02794271a9..0d644b8e0c 100644--- a/datafusion/expr/src/simplify.rs+++ b/datafusion/expr/src/simplify.rs@@ -48,7 +48,7 @@ pub trait SimplifyInfo {/// # Example/// See the `simplify_demo` in the [`expr_api` example]///-/// [`expr_api` example]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/expr_api.rs+/// [`expr_api` example]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/expr_api.rs#[derive(Debug, Clone)]pub struct SimplifyContext<'a> {schema: Option<DFSchemaRef>,diff --git a/datafusion/expr/src/udaf.rs b/datafusion/expr/src/udaf.rsindex e2ae697dee..df158f8838 100644--- a/datafusion/expr/src/udaf.rs+++ b/datafusion/expr/src/udaf.rs@@ -74,8 +74,8 @@ use crate::{Documentation, Signature};/// [aggregate function]: https://en.wikipedia.org/wiki/Aggregate_function/// [`Accumulator`]: Accumulator/// [`create_udaf`]: crate::expr_fn::create_udaf-/// [`simple_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/simple_udaf.rs-/// [`advanced_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udaf.rs+/// [`simple_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/simple_udaf.rs+/// [`advanced_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udaf.rs#[derive(Debug, Clone, PartialOrd)]pub struct AggregateUDF {inner: Arc<dyn AggregateUDFImpl>,@@ -360,7 +360,7 @@ where/// See [`advanced_udaf.rs`] for a full example with complete implementation and/// [`AggregateUDF`] for other available options.///-/// [`advanced_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udaf.rs+/// [`advanced_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udaf.rs////// # Basic Example/// ```diff --git a/datafusion/expr/src/udf.rs b/datafusion/expr/src/udf.rsindex 449ddf5909..89d8569a26 100644--- a/datafusion/expr/src/udf.rs+++ b/datafusion/expr/src/udf.rs@@ -57,8 +57,8 @@ use std::sync::Arc;/// compatibility with the older API.////// [`create_udf`]: crate::expr_fn::create_udf-/// [`simple_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/simple_udf.rs-/// [`advanced_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udf.rs+/// [`simple_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/simple_udf.rs+/// [`advanced_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udf.rs#[derive(Debug, Clone)]pub struct ScalarUDF {inner: Arc<dyn ScalarUDFImpl>,@@ -413,7 +413,7 @@ pub struct ReturnFieldArgs<'a> {/// See [`advanced_udf.rs`] for a full example with complete implementation and/// [`ScalarUDF`] for other available options.///-/// [`advanced_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udf.rs+/// [`advanced_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udf.rs////// # Basic Example/// ```diff --git a/datafusion/expr/src/udwf.rs b/datafusion/expr/src/udwf.rsindex 3220fdcbca..c879e1f762 100644--- a/datafusion/expr/src/udwf.rs+++ b/datafusion/expr/src/udwf.rs@@ -66,8 +66,8 @@ use datafusion_physical_expr_common::physical_expr::PhysicalExpr;////// [`PartitionEvaluator`]: crate::PartitionEvaluator/// [`create_udwf`]: crate::expr_fn::create_udwf-/// [`simple_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/simple_udwf.rs-/// [`advanced_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udwf.rs+/// [`simple_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/simple_udwf.rs+/// [`advanced_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udwf.rs#[derive(Debug, Clone, PartialOrd)]pub struct WindowUDF {inner: Arc<dyn WindowUDFImpl>,@@ -237,7 +237,7 @@ where/// [`WindowUDF`] for other available options.//////-/// [`advanced_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udwf.rs+/// [`advanced_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udwf.rs/// # Basic Example/// ```/// # use std::any::Any;@@ -355,7 +355,7 @@ pub trait WindowUDFImpl: Debug + DynEq + DynHash + Send + Sync {/// optimizations manually for specific UDFs.////// Example:- /// `advanced_udwf.rs`: <https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/advanced_udwf.rs>+ /// `advanced_udwf.rs`: <https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udwf.rs>////// # Returns/// [None] if simplify is not defined or,diff --git a/datafusion/functions/src/datetime/make_date.rs b/datafusion/functions/src/datetime/make_date.rsindex 0fe5d156a8..8699e85b93 100644--- a/datafusion/functions/src/datetime/make_date.rs+++ b/datafusion/functions/src/datetime/make_date.rs@@ -51,7 +51,7 @@ use datafusion_macros::user_doc;+-----------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)"#,argument(name = "year",diff --git a/datafusion/functions/src/datetime/to_char.rs b/datafusion/functions/src/datetime/to_char.rsindex ed8090c9a2..cff096dc92 100644--- a/datafusion/functions/src/datetime/to_char.rs+++ b/datafusion/functions/src/datetime/to_char.rs@@ -48,7 +48,7 @@ use datafusion_macros::user_doc;+----------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)"#,argument(name = "expression",diff --git a/datafusion/functions/src/datetime/to_date.rs b/datafusion/functions/src/datetime/to_date.rsindex 3840c8d8bb..9ac5f8b371 100644--- a/datafusion/functions/src/datetime/to_date.rs+++ b/datafusion/functions/src/datetime/to_date.rs@@ -53,7 +53,7 @@ Note: `to_date` returns Date32, which represents its values as the number of day+---------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)"#,standard_argument(name = "expression", prefix = "String"),argument(diff --git a/datafusion/functions/src/datetime/to_timestamp.rs b/datafusion/functions/src/datetime/to_timestamp.rsindex 0a07000977..cf6c342938 100644--- a/datafusion/functions/src/datetime/to_timestamp.rs+++ b/datafusion/functions/src/datetime/to_timestamp.rs@@ -55,7 +55,7 @@ Note: `to_timestamp` returns `Timestamp(ns)`. The supported range for integer in| 2023-05-17T03:59:00.123456789 |+--------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)"#,argument(name = "expression",@@ -89,7 +89,7 @@ pub struct ToTimestampFunc {| 2023-05-17T03:59:00 |+----------------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)"#,argument(name = "expression",@@ -123,7 +123,7 @@ pub struct ToTimestampSecondsFunc {| 2023-05-17T03:59:00.123 |+---------------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)"#,argument(name = "expression",@@ -157,7 +157,7 @@ pub struct ToTimestampMillisFunc {| 2023-05-17T03:59:00.123456 |+---------------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)"#,argument(name = "expression",@@ -191,7 +191,7 @@ pub struct ToTimestampMicrosFunc {| 2023-05-17T03:59:00.123456789 |+---------------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)"#,argument(name = "expression",diff --git a/datafusion/functions/src/regex/regexplike.rs b/datafusion/functions/src/regex/regexplike.rsindex d75eb9141c..55001f30f6 100644--- a/datafusion/functions/src/regex/regexplike.rs+++ b/datafusion/functions/src/regex/regexplike.rs@@ -56,7 +56,7 @@ SELECT regexp_like('aBc', '(b|d)', 'i');| true |+--------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/regexp.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/regexp.rs)"#,standard_argument(name = "str", prefix = "String"),standard_argument(name = "regexp", prefix = "Regular"),diff --git a/datafusion/functions/src/regex/regexpmatch.rs b/datafusion/functions/src/regex/regexpmatch.rsindex ba52822a02..1255b2913f 100644--- a/datafusion/functions/src/regex/regexpmatch.rs+++ b/datafusion/functions/src/regex/regexpmatch.rs@@ -48,7 +48,7 @@ use std::sync::Arc;| [B] |+---------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/regexp.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/regexp.rs)"#,standard_argument(name = "str", prefix = "String"),argument(diff --git a/datafusion/functions/src/regex/regexpreplace.rs b/datafusion/functions/src/regex/regexpreplace.rsindex 29da195c7a..81146eb54d 100644--- a/datafusion/functions/src/regex/regexpreplace.rs+++ b/datafusion/functions/src/regex/regexpreplace.rs@@ -61,7 +61,7 @@ SELECT regexp_replace('aBc', '(b|d)', 'Ab\\1a', 'i');| aAbBac |+-------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/regexp.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/regexp.rs)"#,standard_argument(name = "str", prefix = "String"),argument(diff --git a/datafusion/physical-plan/src/execution_plan.rs b/datafusion/physical-plan/src/execution_plan.rsindex 553e3e26ce..c37a8ade07 100644--- a/datafusion/physical-plan/src/execution_plan.rs+++ b/datafusion/physical-plan/src/execution_plan.rs@@ -85,7 +85,7 @@ use futures::stream::{StreamExt, TryStreamExt};/// `ExecutionPlan` with memory tracking and spilling support.////// [`datafusion-examples`]: https://github.com/apache/datafusion/tree/main/datafusion-examples-/// [`memory_pool_execution_plan.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/memory_pool_execution_plan.rs+/// [`memory_pool_execution_plan.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/execution_monitoring/memory_pool_execution_plan.rspub trait ExecutionPlan: Debug + DisplayAs + Send + Sync {/// Short name for the ExecutionPlan, such as 'DataSourceExec'.///diff --git a/datafusion/pruning/src/pruning_predicate.rs b/datafusion/pruning/src/pruning_predicate.rsindex 527a0e0946..f804a64fdc 100644--- a/datafusion/pruning/src/pruning_predicate.rs+++ b/datafusion/pruning/src/pruning_predicate.rs@@ -86,7 +86,7 @@ use datafusion_physical_plan::{ColumnarValue, PhysicalExpr};/// example of how to use `PruningPredicate` to prune files based on min/max/// values.///-/// [`pruning.rs` example in the `datafusion-examples`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/pruning.rs+/// [`pruning.rs` example in the `datafusion-examples`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/pruning.rs////// Given an expression like `x = 5` and statistics for 3 containers (Row/// Groups, files, etc) `A`, `B`, and `C`:diff --git a/datafusion/session/src/session.rs b/datafusion/session/src/session.rsindex fd033172f2..14757da67d 100644--- a/datafusion/session/src/session.rs+++ b/datafusion/session/src/session.rs@@ -100,7 +100,7 @@ pub trait Session: Send + Sync {/// + 2` will not be simplified to `a = 3` as this is a more involved process./// See the [expr_api] example for how to simplify expressions.///- /// [expr_api]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/expr_api.rs+ /// [expr_api]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/expr_api.rsfn create_physical_expr(&self,expr: Expr,diff --git a/docs/source/contributor-guide/howtos.md b/docs/source/contributor-guide/howtos.mdindex 24b63865cb..1b38e95bf3 100644--- a/docs/source/contributor-guide/howtos.md+++ b/docs/source/contributor-guide/howtos.md@@ -64,10 +64,10 @@ function types (e.g. scalar, nested, aggregate) are grouped together in the sing[`partitionevaluator`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/trait.PartitionEvaluator.html[`tablefunctionimpl`]: https://docs.rs/datafusion/latest/datafusion/catalog/trait.TableFunctionImpl.html[`tableprovider`]: https://docs.rs/datafusion/latest/datafusion/catalog/trait.TableProvider.html-[`advanced_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udf.rs-[`advanced_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udaf.rs-[`advanced_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udwf.rs-[`simple_udtf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/simple_udtf.rs+[`advanced_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udf.rs+[`advanced_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udaf.rs+[`advanced_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udwf.rs+[`simple_udtf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/simple_udtf.rs[rust feature]: https://doc.rust-lang.org/cargo/reference/features.html**Testing**diff --git a/docs/source/library-user-guide/custom-table-providers.md b/docs/source/library-user-guide/custom-table-providers.mdindex 695cb16ac8..8e1dee9e84 100644--- a/docs/source/library-user-guide/custom-table-providers.md+++ b/docs/source/library-user-guide/custom-table-providers.md@@ -569,6 +569,6 @@ More abstractly, see the following traits for more information on how to impleme- `FileFormat` - a trait for reading a file format- `ListingTableProvider` - a useful trait for implementing a `TableProvider` that lists files in a directory-[ex]: https://github.com/apache/datafusion/blob/a5e86fae3baadbd99f8fd0df83f45fde22f7b0c6/datafusion-examples/examples/custom_datasource.rs#L214C1-L276+[ex]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/custom_data_source/custom_datasource.rs[csv]: https://github.com/apache/datafusion/blob/a5e86fae3baadbd99f8fd0df83f45fde22f7b0c6/datafusion/core/src/datasource/physical_plan/csv.rs#L57-L70[parquet]: https://github.com/apache/datafusion/blob/a5e86fae3baadbd99f8fd0df83f45fde22f7b0c6/datafusion/core/src/datasource/physical_plan/parquet.rs#L77-L104diff --git a/docs/source/library-user-guide/functions/adding-udfs.md b/docs/source/library-user-guide/functions/adding-udfs.mdindex e56790a4b7..d710a40732 100644--- a/docs/source/library-user-guide/functions/adding-udfs.md+++ b/docs/source/library-user-guide/functions/adding-udfs.md@@ -31,14 +31,14 @@ This page covers how to add UDFs to DataFusion. In particular, it covers how to| Table | A function that takes parameters and returns a `TableProvider` to be used in an query plan. | [simple_udtf.rs] || Scalar (async) | A scalar function for performing `async` operations (such as network or I/O calls) within the UDF. | [async_udf.rs] |-[simple_udf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/simple_udf.rs-[advanced_udf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udf.rs-[simple_udwf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/simple_udwf.rs-[advanced_udwf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udwf.rs-[simple_udaf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/simple_udaf.rs-[advanced_udaf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udaf.rs-[simple_udtf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/simple_udtf.rs-[async_udf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/async_udf.rs+[simple_udf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/simple_udf.rs+[advanced_udf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udf.rs+[simple_udwf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/simple_udwf.rs+[advanced_udwf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udwf.rs+[simple_udaf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/simple_udaf.rs+[advanced_udaf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udaf.rs+[simple_udtf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/simple_udtf.rs+[async_udf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/async_udf.rsFirst we'll talk about adding an Scalar UDF end-to-end, then we'll talk about the differences between the differenttypes of UDFs.@@ -579,12 +579,12 @@ After registration, you can use these async UDFs directly in SQL queries, for exSELECT async_upper('datafusion');```-For async UDF implementation details, see [`async_udf.rs`](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/async_udf.rs).+For async UDF implementation details, see [`async_udf.rs`](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/async_udf.rs).[`scalarudf`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/struct.ScalarUDF.html[`create_udf`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/fn.create_udf.html[`process_scalar_func_inputs`]: https://docs.rs/datafusion/latest/datafusion/physical_expr/functions/fn.process_scalar_func_inputs.html-[`advanced_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udf.rs+[`advanced_udf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udf.rs## Named Arguments@@ -820,7 +820,7 @@ let smooth_it = create_udwf([`windowudf`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/struct.WindowUDF.html[`create_udwf`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/fn.create_udwf.html-[`advanced_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udwf.rs+[`advanced_udwf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udwf.rsThe `create_udwf` has five arguments to check:@@ -1348,7 +1348,7 @@ async fn main() -> Result<()> {[`aggregateudf`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/struct.AggregateUDF.html[`create_udaf`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/fn.create_udaf.html-[`advanced_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udaf.rs+[`advanced_udaf.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/udf/advanced_udaf.rs## Adding a Table UDFdiff --git a/docs/source/library-user-guide/query-optimizer.md b/docs/source/library-user-guide/query-optimizer.mdindex 877ff8c754..651e147a76 100644--- a/docs/source/library-user-guide/query-optimizer.md+++ b/docs/source/library-user-guide/query-optimizer.md@@ -68,7 +68,7 @@ fn observer(plan: &LogicalPlan, rule: &dyn OptimizerRule) {## Writing Optimization RulesPlease refer to the-[optimizer_rule.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/optimizer_rule.rs)+[optimizer_rule.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/optimizer_rule.rs)example to learn more about the general approach to writing optimizer rules andthen move onto studying the existing rules.diff --git a/docs/source/library-user-guide/upgrading.md b/docs/source/library-user-guide/upgrading.mdindex 1770ad41a8..7a827847dd 100644--- a/docs/source/library-user-guide/upgrading.md+++ b/docs/source/library-user-guide/upgrading.md@@ -1015,7 +1015,7 @@ By default if you do not use a custom `SchemaAdapterFactory` we will use expressIf you do set a custom `SchemaAdapterFactory` we will continue to use it but emit a warning about that code path being deprecated.To resolve this you need to implement a custom `PhysicalExprAdapterFactory` and use that instead of a `SchemaAdapterFactory`.-See the [default values](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/default_column_values.rs) for an example of how to do this.+See the [default values](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/custom_data_source/default_column_values.rs) for an example of how to do this.Opting into the new APIs will set you up for future changes since we plan to expand use of `PhysicalExprAdapterFactory` to other areas of DataFusion.See [#16800] for details.diff --git a/docs/source/library-user-guide/using-the-dataframe-api.md b/docs/source/library-user-guide/using-the-dataframe-api.mdindex 7f3e28c255..024eff5d20 100644--- a/docs/source/library-user-guide/using-the-dataframe-api.md+++ b/docs/source/library-user-guide/using-the-dataframe-api.md@@ -198,7 +198,7 @@ async fn main() -> Result<()> {}```-[`custom_file_format.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/custom_file_format.rs+[`custom_file_format.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/custom_data_source/custom_file_format.rsThe output file will look like (Example Output):diff --git a/docs/source/library-user-guide/working-with-exprs.md b/docs/source/library-user-guide/working-with-exprs.mdindex bdcaaeae0a..472ab24813 100644--- a/docs/source/library-user-guide/working-with-exprs.md+++ b/docs/source/library-user-guide/working-with-exprs.md@@ -71,7 +71,7 @@ From DFSchema to Schema: Since the `Into` trait has been implemented for DFSchem## Creating and Evaluating `Expr`s-Please see [expr_api.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/expr_api.rs) for well commented code for creating, evaluating, simplifying, and analyzing `Expr`s.+Please see [expr_api.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/expr_api.rs) for well commented code for creating, evaluating, simplifying, and analyzing `Expr`s.## A Scalar UDF Example@@ -123,9 +123,9 @@ If you'd like to learn more about `Expr`s, before we get into the details of creThere are several examples of rewriting and working with `Expr`s:-- [expr_api.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/expr_api.rs)-- [analyzer_rule.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/analyzer_rule.rs)-- [optimizer_rule.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/optimizer_rule.rs)+- [expr_api.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/expr_api.rs)+- [analyzer_rule.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/analyzer_rule.rs)+- [optimizer_rule.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/query_planning/optimizer_rule.rs)Rewriting Expressions is the process of taking an `Expr` and transforming it into another `Expr`. This is useful for a number of reasons, including:diff --git a/docs/source/user-guide/expressions.md b/docs/source/user-guide/expressions.mdindex 929f8b2e46..56d78ac473 100644--- a/docs/source/user-guide/expressions.md+++ b/docs/source/user-guide/expressions.md@@ -313,7 +313,7 @@ select log(-1), log(0), sqrt(-1);You can also use the `ExprFunctionExt` trait to more easily build Aggregate arguments `Expr`.-See `datafusion-examples/examples/expr_api.rs` for example usage.+See `datafusion-examples/examples/query_planning/expr_api.rs` for example usage.| Syntax | Equivalent to || ----------------------------------------------------------------------- | ----------------------------------- |diff --git a/docs/source/user-guide/sql/scalar_functions.md b/docs/source/user-guide/sql/scalar_functions.mdindex 7c88d1fd9c..863bf6f9b6 100644--- a/docs/source/user-guide/sql/scalar_functions.md+++ b/docs/source/user-guide/sql/scalar_functions.md@@ -2294,7 +2294,7 @@ SELECT regexp_like('aBc', '(b|d)', 'i');+--------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/regexp.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/regexp.rs)### `regexp_match`@@ -2333,7 +2333,7 @@ regexp_match(str, regexp[, flags])+---------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/regexp.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/regexp.rs)### `regexp_replace`@@ -2374,7 +2374,7 @@ SELECT regexp_replace('aBc', '(b|d)', 'Ab\\1a', 'i');+-------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/regexp.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/regexp.rs)## Time and Date Functions@@ -2625,7 +2625,7 @@ make_date(year, month, day)+-----------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)### `now`@@ -2666,7 +2666,7 @@ to_char(expression, format)+----------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)#### Aliases@@ -2710,7 +2710,7 @@ to_date('2017-05-31', '%Y-%m-%d')+---------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)### `to_local_time`@@ -2805,7 +2805,7 @@ to_timestamp(expression[, ..., format_n])+--------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)### `to_timestamp_micros`@@ -2837,7 +2837,7 @@ to_timestamp_micros(expression[, ..., format_n])+---------------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)### `to_timestamp_millis`@@ -2869,7 +2869,7 @@ to_timestamp_millis(expression[, ..., format_n])+---------------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)### `to_timestamp_nanos`@@ -2901,7 +2901,7 @@ to_timestamp_nanos(expression[, ..., format_n])+---------------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)### `to_timestamp_seconds`@@ -2933,7 +2933,7 @@ to_timestamp_seconds(expression[, ..., format_n])+----------------------------------------------------------------------------------------------------------------+```-Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/date_time_functions.rs)+Additional examples can be found [here](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/builtin_functions/date_time.rs)### `to_unixtime`