You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by sa...@apache.org on 2022/01/25 11:42:32 UTC
[spark] branch master updated: [SPARK-38016][SQL][DOCS] Fix the API doc for session_window to say it supports TimestampNTZType too as timeColumn
This is an automated email from the ASF dual-hosted git repository.
sarutak pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new 48a440f [SPARK-38016][SQL][DOCS] Fix the API doc for session_window to say it supports TimestampNTZType too as timeColumn
48a440f is described below
commit 48a440fe1fc334134f42a726cc6fb3d98802e0fd
Author: Kousuke Saruta <sa...@oss.nttdata.com>
AuthorDate: Tue Jan 25 20:41:38 2022 +0900
[SPARK-38016][SQL][DOCS] Fix the API doc for session_window to say it supports TimestampNTZType too as timeColumn
### What changes were proposed in this pull request?
This PR fixes the API docs for `session_window` to say it supports `TimestampNTZType` too as `timeColumn`.
### Why are the changes needed?
As of Spark 3.3.0 (e858cd568a74123f7fd8fe4c3d2917a), `session_window` supports not only `TimestampType` but also `TimestampNTZType`.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Built the docs with the following commands.
```
bundle install
SKIP_RDOC=1 SKIP_SQLDOC=1 bundle exec jekyll build
```
Then, confirmed the built doc.
Closes #35312 from sarutak/sessionwindow-timestampntz-doc.
Authored-by: Kousuke Saruta <sa...@oss.nttdata.com>
Signed-off-by: Kousuke Saruta <sa...@oss.nttdata.com>
---
python/pyspark/sql/functions.py | 2 +-
sql/core/src/main/scala/org/apache/spark/sql/functions.scala | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/python/pyspark/sql/functions.py b/python/pyspark/sql/functions.py
index e69c37d..bfee994 100644
--- a/python/pyspark/sql/functions.py
+++ b/python/pyspark/sql/functions.py
@@ -2623,7 +2623,7 @@ def session_window(timeColumn: "ColumnOrName", gapDuration: Union[Column, str])
----------
timeColumn : :class:`~pyspark.sql.Column` or str
The column name or column to use as the timestamp for windowing by time.
- The time column must be of TimestampType.
+ The time column must be of TimestampType or TimestampNTZType.
gapDuration : :class:`~pyspark.sql.Column` or str
A Python string literal or column specifying the timeout of the session. It could be
static value, e.g. `10 minutes`, `1 second`, or an expression/UDF that specifies gap
diff --git a/sql/core/src/main/scala/org/apache/spark/sql/functions.scala b/sql/core/src/main/scala/org/apache/spark/sql/functions.scala
index ec28d8d..f217dad 100644
--- a/sql/core/src/main/scala/org/apache/spark/sql/functions.scala
+++ b/sql/core/src/main/scala/org/apache/spark/sql/functions.scala
@@ -3750,7 +3750,7 @@ object functions {
* processing time.
*
* @param timeColumn The column or the expression to use as the timestamp for windowing by time.
- * The time column must be of TimestampType.
+ * The time column must be of TimestampType or TimestampNTZType.
* @param gapDuration A string specifying the timeout of the session, e.g. `10 minutes`,
* `1 second`. Check `org.apache.spark.unsafe.types.CalendarInterval` for
* valid duration identifiers.
@@ -3787,7 +3787,7 @@ object functions {
* processing time.
*
* @param timeColumn The column or the expression to use as the timestamp for windowing by time.
- * The time column must be of TimestampType.
+ * The time column must be of TimestampType or TimestampNTZType.
* @param gapDuration A column specifying the timeout of the session. It could be static value,
* e.g. `10 minutes`, `1 second`, or an expression/UDF that specifies gap
* duration dynamically based on the input row.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org