Skip to content

Apache DataFusion SQL Query Engine

fix: document empty() as returning a boolean, not 1/0 (#25697)

jackylee9951f0b351b7
diff --git a/datafusion/functions-nested/src/empty.rs b/datafusion/functions-nested/src/empty.rs
index 6db412d29b..855b793953 100644
--- a/datafusion/functions-nested/src/empty.rs
+++ b/datafusion/functions-nested/src/empty.rs
@@ -43,14 +43,14 @@ make_udf_expr_and_func!(
#[user_doc(
doc_section(label = "Array Functions"),
- description = "Returns 1 for an empty array or 0 for a non-empty array.",
+ description = "Returns true for an empty array or false for a non-empty array.",
syntax_example = "empty(array)",
sql_example = r#"```sql
> select empty([1]);
+------------------+
| empty(List([1])) |
+------------------+
-| 0 |
+| false |
+------------------+
```"#,
argument(
diff --git a/docs/source/user-guide/sql/scalar_functions.md b/docs/source/user-guide/sql/scalar_functions.md
index d1a9f37fc9..1ba1e8c820 100644
--- a/docs/source/user-guide/sql/scalar_functions.md
+++ b/docs/source/user-guide/sql/scalar_functions.md
@@ -4858,7 +4858,7 @@ _Alias of [inner_product](#inner_product)._
### `empty`
-Returns 1 for an empty array or 0 for a non-empty array.
+Returns true for an empty array or false for a non-empty array.
```sql
empty(array)
@@ -4875,7 +4875,7 @@ empty(array)
+------------------+
| empty(List([1])) |
+------------------+
-| 0 |
+| false |
+------------------+
```