Add Spark raise_error function

velox/docs/functions/spark/misc.rst

@@ -13,6 +13,10 @@ Miscellaneous Functions
     The function relies on partition IDs, which are provided by the framework
     via the configuration 'spark.partition_id'.
 
+.. spark:function:: raise_error(str) -> void
+
+    Throws an runtime exception with ``str``.
+
 .. spark:function:: spark_partition_id() -> integer
 
     Returns the current partition id.

velox/functions/sparksql/RaiseError.h

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#pragma once
+
+#include "velox/functions/Macros.h"
+namespace facebook::velox::functions::sparksql {
+
+template <typename T>
+struct RaiseErrorFunction {
+  VELOX_DEFINE_FUNCTION_TYPES(T);
+
+  FOLLY_ALWAYS_INLINE void call(
+      UnknownValue& result,
+      const arg_type<Varchar>& input) {
+    throw std::runtime_error(input);
+  }
+};
+} // namespace facebook::velox::functions::sparksql

velox/functions/sparksql/Register.cpp

@@ -39,6 +39,7 @@
 #include "velox/functions/sparksql/LeastGreatest.h"
 #include "velox/functions/sparksql/MightContain.h"
 #include "velox/functions/sparksql/MonotonicallyIncreasingId.h"
+#include "velox/functions/sparksql/RaiseError.h"
 #include "velox/functions/sparksql/RegexFunctions.h"
 #include "velox/functions/sparksql/RegisterArithmetic.h"
 #include "velox/functions/sparksql/RegisterCompare.h"
@@ -460,6 +461,9 @@ void registerFunctions(const std::string& prefix) {
       Array<Array<Generic<T1>>>>({prefix + "flatten"});
 
   registerFunction<SoundexFunction, Varchar, Varchar>({prefix + "soundex"});
+
+  registerFunction<RaiseErrorFunction, UnknownValue, Varchar>(
+      {prefix + "raise_error"});
 }
 
 } // namespace sparksql

velox/functions/sparksql/tests/CMakeLists.txt

@@ -39,6 +39,7 @@ add_executable(
   MapTest.cpp
   MightContainTest.cpp
   MonotonicallyIncreasingIdTest.cpp
+  RaiseErrorTest.cpp
   RandTest.cpp
   RegexFunctionsTest.cpp
   SizeTest.cpp

velox/functions/sparksql/tests/RaiseErrorTest.cpp

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "velox/common/base/tests/GTestUtils.h"
+#include "velox/functions/sparksql/tests/SparkFunctionBaseTest.h"
+
+namespace facebook::velox::functions::sparksql::test {
+namespace {
+
+class RaiseErrorTest : public SparkFunctionBaseTest {
+ protected:
+  void raiseError(const std::optional<std::string>& errMsg) {
+    evaluateOnce<UnknownValue>("raise_error(c0)", errMsg);
+  }
+};
+
+TEST_F(RaiseErrorTest, basic) {
+  VELOX_ASSERT_THROW(raiseError(""), "");
+  VELOX_ASSERT_THROW(raiseError("0 > 1 is not true"), "0 > 1 is not true");
+}
+} // namespace
+} // namespace facebook::velox::functions::sparksql::test