This is an automated email from the ASF dual-hosted git repository.
jayzhan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new e24a5dd5a5 Improve function documentation (#11996)
e24a5dd5a5 is described below
commit e24a5dd5a508ba605686206c853c914a2d0cc095
Author: Andrew Lamb <[email protected]>
AuthorDate: Wed Aug 14 19:59:28 2024 -0400
Improve function documentation (#11996)
---
datafusion/functions/src/core/mod.rs | 8 ++++++++
datafusion/functions/src/crypto/mod.rs | 1 +
datafusion/functions/src/datetime/mod.rs | 2 +-
datafusion/functions/src/encoding/mod.rs | 1 +
datafusion/functions/src/math/mod.rs | 1 +
datafusion/functions/src/regex/mod.rs | 2 +-
datafusion/functions/src/string/mod.rs | 2 +-
datafusion/functions/src/unicode/mod.rs | 2 +-
8 files changed, 15 insertions(+), 4 deletions(-)
diff --git a/datafusion/functions/src/core/mod.rs
b/datafusion/functions/src/core/mod.rs
index 062a4a104d..af340930ea 100644
--- a/datafusion/functions/src/core/mod.rs
+++ b/datafusion/functions/src/core/mod.rs
@@ -86,6 +86,7 @@ pub mod expr_fn {
}
}
+/// Returns all DataFusion functions defined in this package
pub fn functions() -> Vec<Arc<ScalarUDF>> {
vec![
nullif(),
@@ -94,6 +95,13 @@ pub fn functions() -> Vec<Arc<ScalarUDF>> {
nvl2(),
arrow_typeof(),
named_struct(),
+ // Note: most users invoke `get_field` indirectly via field access
+ // syntax like `my_struct_col['field_name']`, which results in a call
to
+ // `get_field(my_struct_col, "field_name")`.
+ //
+ // However, it is also exposed directly for use cases such as
+ // serializing / deserializing plans with the field access desugared
to
+ // calls to `get_field`
get_field(),
coalesce(),
]
diff --git a/datafusion/functions/src/crypto/mod.rs
b/datafusion/functions/src/crypto/mod.rs
index 497c1af62a..46177fc22b 100644
--- a/datafusion/functions/src/crypto/mod.rs
+++ b/datafusion/functions/src/crypto/mod.rs
@@ -62,6 +62,7 @@ pub mod expr_fn {
));
}
+/// Returns all DataFusion functions defined in this package
pub fn functions() -> Vec<Arc<ScalarUDF>> {
vec![digest(), md5(), sha224(), sha256(), sha384(), sha512()]
}
diff --git a/datafusion/functions/src/datetime/mod.rs
b/datafusion/functions/src/datetime/mod.rs
index a7e9827d6c..db4e365267 100644
--- a/datafusion/functions/src/datetime/mod.rs
+++ b/datafusion/functions/src/datetime/mod.rs
@@ -272,7 +272,7 @@ pub mod expr_fn {
}
}
-/// Return a list of all functions in this package
+/// Returns all DataFusion functions defined in this package
pub fn functions() -> Vec<Arc<ScalarUDF>> {
vec![
current_date(),
diff --git a/datafusion/functions/src/encoding/mod.rs
b/datafusion/functions/src/encoding/mod.rs
index 24e11e5d63..48171370ad 100644
--- a/datafusion/functions/src/encoding/mod.rs
+++ b/datafusion/functions/src/encoding/mod.rs
@@ -37,6 +37,7 @@ pub mod expr_fn {
));
}
+/// Returns all DataFusion functions defined in this package
pub fn functions() -> Vec<Arc<ScalarUDF>> {
vec![encode(), decode()]
}
diff --git a/datafusion/functions/src/math/mod.rs
b/datafusion/functions/src/math/mod.rs
index 1e41fff289..b221fb900c 100644
--- a/datafusion/functions/src/math/mod.rs
+++ b/datafusion/functions/src/math/mod.rs
@@ -276,6 +276,7 @@ pub mod expr_fn {
);
}
+/// Returns all DataFusion functions defined in this package
pub fn functions() -> Vec<Arc<ScalarUDF>> {
vec![
abs(),
diff --git a/datafusion/functions/src/regex/mod.rs
b/datafusion/functions/src/regex/mod.rs
index 884db24d9e..4ac162290d 100644
--- a/datafusion/functions/src/regex/mod.rs
+++ b/datafusion/functions/src/regex/mod.rs
@@ -65,7 +65,7 @@ pub mod expr_fn {
}
}
-#[doc = r" Return a list of all functions in this package"]
+/// Returns all DataFusion functions defined in this package
pub fn functions() -> Vec<std::sync::Arc<datafusion_expr::ScalarUDF>> {
vec![regexp_match(), regexp_like(), regexp_replace()]
}
diff --git a/datafusion/functions/src/string/mod.rs
b/datafusion/functions/src/string/mod.rs
index 9a19151a85..622802f014 100644
--- a/datafusion/functions/src/string/mod.rs
+++ b/datafusion/functions/src/string/mod.rs
@@ -167,7 +167,7 @@ pub mod expr_fn {
}
}
-/// Return a list of all functions in this package
+/// Returns all DataFusion functions defined in this package
pub fn functions() -> Vec<Arc<ScalarUDF>> {
vec![
ascii(),
diff --git a/datafusion/functions/src/unicode/mod.rs
b/datafusion/functions/src/unicode/mod.rs
index 9e8c07cd36..40915bc9ef 100644
--- a/datafusion/functions/src/unicode/mod.rs
+++ b/datafusion/functions/src/unicode/mod.rs
@@ -125,7 +125,7 @@ pub mod expr_fn {
}
}
-/// Return a list of all functions in this package
+/// Returns all DataFusion functions defined in this package
pub fn functions() -> Vec<Arc<ScalarUDF>> {
vec![
character_length(),
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
