spark-instrumented-optimizer/python/docs/source/reference
Karen Feng 39510b0e9b [SPARK-32793][SQL] Add raise_error function, adds error message parameter to assert_true
## What changes were proposed in this pull request?

Adds a SQL function `raise_error` which underlies the refactored `assert_true` function. `assert_true` now also (optionally) accepts a custom error message field.
`raise_error` is exposed in SQL, Python, Scala, and R.
`assert_true` was previously only exposed in SQL; it is now also exposed in Python, Scala, and R.

### Why are the changes needed?

Improves usability of `assert_true` by clarifying error messaging, and adds the useful helper function `raise_error`.

### Does this PR introduce _any_ user-facing change?

Yes:
- Adds `raise_error` function to the SQL, Python, Scala, and R APIs.
- Adds `assert_true` function to the SQL, Python and R APIs.

### How was this patch tested?

Adds unit tests in SQL, Python, Scala, and R for `assert_true` and `raise_error`.

Closes #29947 from karenfeng/spark-32793.

Lead-authored-by: Karen Feng <karen.feng@databricks.com>
Co-authored-by: Hyukjin Kwon <gurwls223@gmail.com>
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
2020-10-08 12:05:39 +09:00
..
index.rst [SPARK-32179][SPARK-32188][PYTHON][DOCS] Replace and redesign the documentation base 2020-07-27 17:49:21 +09:00
pyspark.ml.rst [MINOR][DOCS] Add KMeansSummary and InheritableThread to documentation 2020-08-19 14:30:07 +09:00
pyspark.mllib.rst [SPARK-32179][SPARK-32188][PYTHON][DOCS] Replace and redesign the documentation base 2020-07-27 17:49:21 +09:00
pyspark.resource.rst [SPARK-32179][SPARK-32188][PYTHON][DOCS] Replace and redesign the documentation base 2020-07-27 17:49:21 +09:00
pyspark.rst [SPARK-33017][PYTHON][DOCS][FOLLOW-UP] Add getCheckpointDir into API documentation 2020-10-07 13:00:59 +09:00
pyspark.sql.rst [SPARK-32793][SQL] Add raise_error function, adds error message parameter to assert_true 2020-10-08 12:05:39 +09:00
pyspark.ss.rst [SPARK-32179][SPARK-32188][PYTHON][DOCS] Replace and redesign the documentation base 2020-07-27 17:49:21 +09:00
pyspark.streaming.rst [SPARK-32179][SPARK-32188][PYTHON][DOCS] Replace and redesign the documentation base 2020-07-27 17:49:21 +09:00