cloud-fan commented on code in PR #51555:
URL: https://github.com/apache/spark/pull/51555#discussion_r2215554413
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -11344,6 +11344,62 @@ def to_date(col: "ColumnOrName", format: Optional[str]
= None) -> Column:
return _invoke_function("to_date", _to_java_column(col),
_enum_to_value(format))
+@_try_remote_functions
+def try_to_date(col: "ColumnOrName", format: Optional[str] = None) -> Column:
+ """This is a special version of `try_to_date` that performs the same
operation, but returns a
+ NULL value instead of raising an error if date cannot be created.
+
+ .. _datetime pattern:
https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html
+
+ .. versionadded:: 4.0.0
+
+ Parameters
+ ----------
+ col : :class:`~pyspark.sql.Column` or column name
+ input column of values to convert.
+ format: literal string, optional
+ format to use to convert date values.
+
+ Returns
+ -------
+ :class:`~pyspark.sql.Column`
+ date value as :class:`pyspark.sql.types.DateType` type.
+
+ See Also
+ --------
+ :meth:`pyspark.sql.functions.to_timestamp`
+ :meth:`pyspark.sql.functions.to_timestamp_ltz`
+ :meth:`pyspark.sql.functions.to_timestamp_ntz`
+ :meth:`pyspark.sql.functions.to_utc_timestamp`
+ :meth:`pyspark.sql.functions.try_to_timestamp`
+ :meth:`pyspark.sql.functions.date_format`
+
+ Examples
+ --------
+ >>> import pyspark.sql.functions as sf
+ >>> df = spark.createDataFrame([('1997-02-28 10:30:00',)], ['ts'])
+ >>> df.select('*', sf.try_to_date(df.ts)).show()
Review Comment:
shall we use a null result example?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
