chore: added sql example to datetime docs

Author: buraksenn

datafusion/functions/src/datetime/current_date.rs

@@ -39,7 +39,24 @@ The `current_date()` return value is determined at query time and will return th
 "#,
     syntax_example = r#"current_date()
     (optional) SET datafusion.execution.time_zone = '+00:00';
-    SELECT current_date();"#
+    SELECT current_date();"#,
+    sql_example = r#"```sql
+> SELECT current_date();
++----------------+
+| current_date() |
++----------------+
+| 2024-12-23     |
++----------------+
+
+-- The current date is based on the session time zone (UTC by default)
+> SET datafusion.execution.time_zone = 'Asia/Tokyo';
+> SELECT current_date();
++----------------+
+| current_date() |
++----------------+
+| 2024-12-24     |
++----------------+
+```"#
 )]
 #[derive(Debug, PartialEq, Eq, Hash)]
 pub struct CurrentDateFunc {

datafusion/functions/src/datetime/current_time.rs

@@ -39,9 +39,24 @@ The `current_time()` return value is determined at query time and will return th
 
 The session time zone can be set using the statement 'SET datafusion.execution.time_zone = desired time zone'. The time zone can be a value like +00:00, 'Europe/London' etc.
 "#,
-    syntax_example = r#"current_time()
-    (optional) SET datafusion.execution.time_zone = '+00:00';
-    SELECT current_time();"#
+    syntax_example = "current_time()",
+    sql_example = r#"```sql
+> SELECT current_time();
++--------------------+
+| current_time()     |
++--------------------+
+| 06:30:00.123456789 |
++--------------------+
+
+-- The current time is based on the session time zone (UTC by default)
+> SET datafusion.execution.time_zone = 'Europe/London';
+> SELECT current_time();
++--------------------+
+| current_time()     |
++--------------------+
+| 07:30:00.123456789 |
++--------------------+
+```"#
 )]
 #[derive(Debug, PartialEq, Eq, Hash)]
 pub struct CurrentTimeFunc {

datafusion/functions/src/datetime/date_part.rs

@@ -87,7 +87,21 @@ use datafusion_macros::user_doc;
     argument(
         name = "expression",
         description = "Time expression to operate on. Can be a constant, column, or function."
-    )
+    ),
+    sql_example = r#"```sql
+> SELECT date_part('year', '2024-05-01T00:00:00');
++---------------------------------------------+
+| date_part(Utf8("year"),Utf8("2024-05-01T00:00:00")) |
++---------------------------------------------+
+| 2024.0                                      |
++---------------------------------------------+
+> SELECT extract(day FROM timestamp '2024-05-01T00:00:00');
++---------------------------------------------+
+| date_part(Utf8("day"),Utf8("2024-05-01T00:00:00")) |
++---------------------------------------------+
+| 1.0                                         |
++---------------------------------------------+
+```"#
 )]
 #[derive(Debug, PartialEq, Eq, Hash)]
 pub struct DatePartFunc {

datafusion/functions/src/datetime/date_trunc.rs

@@ -167,7 +167,21 @@ impl DateTruncGranularity {
     argument(
         name = "expression",
         description = "Timestamp or time expression to operate on. Can be a constant, column, or function."
-    )
+    ),
+    sql_example = r#"```sql
+> SELECT date_trunc('month', '2024-05-15T10:30:00');
++-----------------------------------------------+
+| date_trunc(Utf8("month"),Utf8("2024-05-15T10:30:00")) |
++-----------------------------------------------+
+| 2024-05-01T00:00:00                           |
++-----------------------------------------------+
+> SELECT date_trunc('hour', '2024-05-15T10:30:00');
++----------------------------------------------+
+| date_trunc(Utf8("hour"),Utf8("2024-05-15T10:30:00")) |
++----------------------------------------------+
+| 2024-05-15T10:00:00                          |
++----------------------------------------------+
+```"#
 )]
 #[derive(Debug, PartialEq, Eq, Hash)]
 pub struct DateTruncFunc {

datafusion/functions/src/datetime/now.rs

@@ -37,7 +37,24 @@ Returns the current timestamp in the system configured timezone (None by default
 
 The `now()` return value is determined at query time and will return the same timestamp, no matter when in the query plan the function executes.
 "#,
-    syntax_example = "now()"
+    syntax_example = "now()",
+    sql_example = r#"```sql
+> SELECT now();
++----------------------------------+
+| now()                            |
++----------------------------------+
+| 2024-12-23T06:30:00.123456789Z   |
++----------------------------------+
+
+-- The timezone of the returned timestamp depends on the session time zone
+> SET datafusion.execution.time_zone = 'America/New_York';
+> SELECT now();
++----------------------------------+
+| now()                            |
++----------------------------------+
+| 2024-12-23T01:30:00.123456789Z   |
++----------------------------------+
+```"#
 )]
 #[derive(Debug, PartialEq, Eq, Hash)]
 pub struct NowFunc {

docs/source/user-guide/sql/scalar_functions.md

@@ -2411,8 +2411,26 @@ The `current_date()` return value is determined at query time and will return th
 
 ```sql
 current_date()
-    (optional) SET datafusion.execution.time_zone = '+00:00';
-    SELECT current_date();
+```
+
+#### Example
+
+```sql
+> SELECT current_date();
++----------------+
+| current_date() |
++----------------+
+| 2024-12-23     |
++----------------+
+
+-- The current date is based on the session time zone (UTC by default)
+> SET datafusion.execution.time_zone = 'Asia/Tokyo';
+> SELECT current_date();
++----------------+
+| current_date() |
++----------------+
+| 2024-12-24     |
++----------------+
 ```
 
 #### Aliases
@@ -2429,8 +2447,26 @@ The session time zone can be set using the statement 'SET datafusion.execution.t
 
 ```sql
 current_time()
-    (optional) SET datafusion.execution.time_zone = '+00:00';
-    SELECT current_time();
+```
+
+#### Example
+
+```sql
+> SELECT current_time();
++--------------------+
+| current_time()     |
++--------------------+
+| 06:30:00.123456789 |
++--------------------+
+
+-- The current time is based on the session time zone (UTC by default)
+> SET datafusion.execution.time_zone = 'Europe/London';
+> SELECT current_time();
++--------------------+
+| current_time()     |
++--------------------+
+| 07:30:00.123456789 |
++--------------------+
 ```
 
 ### `current_timestamp`
@@ -2537,6 +2573,23 @@ date_part(part, expression)
 
 - **expression**: Time expression to operate on. Can be a constant, column, or function.
 
+#### Example
+
+```sql
+> SELECT date_part('year', '2024-05-01T00:00:00');
++---------------------------------------------+
+| date_part(Utf8("year"),Utf8("2024-05-01T00:00:00")) |
++---------------------------------------------+
+| 2024.0                                      |
++---------------------------------------------+
+> SELECT extract(day FROM timestamp '2024-05-01T00:00:00');
++---------------------------------------------+
+| date_part(Utf8("day"),Utf8("2024-05-01T00:00:00")) |
++---------------------------------------------+
+| 1.0                                         |
++---------------------------------------------+
+```
+
 #### Alternative Syntax
 
 ```sql
@@ -2582,6 +2635,23 @@ date_trunc(precision, expression)
 
 - **expression**: Timestamp or time expression to operate on. Can be a constant, column, or function.
 
+#### Example
+
+```sql
+> SELECT date_trunc('month', '2024-05-15T10:30:00');
++-----------------------------------------------+
+| date_trunc(Utf8("month"),Utf8("2024-05-15T10:30:00")) |
++-----------------------------------------------+
+| 2024-05-01T00:00:00                           |
++-----------------------------------------------+
+> SELECT date_trunc('hour', '2024-05-15T10:30:00');
++----------------------------------------------+
+| date_trunc(Utf8("hour"),Utf8("2024-05-15T10:30:00")) |
++----------------------------------------------+
+| 2024-05-15T10:00:00                          |
++----------------------------------------------+
+```
+
 #### Aliases
 
 - datetrunc
@@ -2694,6 +2764,26 @@ The `now()` return value is determined at query time and will return the same ti
 now()
 ```
 
+#### Example
+
+```sql
+> SELECT now();
++----------------------------------+
+| now()                            |
++----------------------------------+
+| 2024-12-23T06:30:00.123456789Z   |
++----------------------------------+
+
+-- The timezone of the returned timestamp depends on the session time zone
+> SET datafusion.execution.time_zone = 'America/New_York';
+> SELECT now();
++----------------------------------+
+| now()                            |
++----------------------------------+
+| 2024-12-23T01:30:00.123456789Z   |
++----------------------------------+
+```
+
 #### Aliases
 
 - current_timestamp