ARROW-16158: [C++][R] Rename ARROW_ENGINE to ARROW_SUBSTRAIT

At the moment there is not enough non-Substrait functionality to justify a dedicated engine module. In the future there likely will be and so I have some of the general structure around in the C++ (e.g. `ARROW_ENGINE_EXPORT`) but removed any external facing references. Closes apache#12915 from westonpace/feature/ARROW-16158--rename-engine-to-substrait Lead-authored-by: Weston Pace <[email protected]> Co-authored-by: Neal Richardson <[email protected]> Signed-off-by: Krisztián Szűcs <[email protected]>
davidhao3300 · Apr 24, 2022 · d21f8b1 · d21f8b1
1 parent 0b06870
commit d21f8b1
Show file tree

Hide file tree

Showing 34 changed files with 216 additions and 190 deletions.
diff --git a/ci/appveyor-cpp-build.bat b/ci/appveyor-cpp-build.bat
@@ -99,13 +99,13 @@ cmake -G "%GENERATOR%" %CMAKE_ARGS% ^
       -DARROW_CXXFLAGS="%ARROW_CXXFLAGS%" ^
       -DARROW_DATASET=ON ^
       -DARROW_ENABLE_TIMING_TESTS=OFF ^
-      -DARROW_ENGINE=ON ^
       -DARROW_FLIGHT=%ARROW_BUILD_FLIGHT% ^
       -DARROW_GANDIVA=%ARROW_BUILD_GANDIVA% ^
       -DARROW_MIMALLOC=ON ^
       -DARROW_PARQUET=ON ^
       -DARROW_PYTHON=ON ^
       -DARROW_S3=%ARROW_S3% ^
+      -DARROW_SUBSTRAIT=ON ^
       -DARROW_VERBOSE_THIRDPARTY_BUILD=OFF ^
       -DARROW_WITH_BROTLI=ON ^
       -DARROW_WITH_LZ4=ON ^

diff --git a/ci/scripts/cpp_build.sh b/ci/scripts/cpp_build.sh
@@ -85,7 +85,6 @@ cmake \
   -DARROW_DATASET=${ARROW_DATASET:-ON} \
   -DARROW_DEPENDENCY_SOURCE=${ARROW_DEPENDENCY_SOURCE:-AUTO} \
   -DARROW_ENABLE_TIMING_TESTS=${ARROW_ENABLE_TIMING_TESTS:-ON} \
-  -DARROW_ENGINE=${ARROW_ENGINE:-ON} \
   -DARROW_EXTRA_ERROR_CONTEXT=${ARROW_EXTRA_ERROR_CONTEXT:-OFF} \
   -DARROW_FILESYSTEM=${ARROW_FILESYSTEM:-ON} \
   -DARROW_FLIGHT=${ARROW_FLIGHT:-OFF} \
@@ -112,6 +111,7 @@ cmake \
   -DARROW_RUNTIME_SIMD_LEVEL=${ARROW_RUNTIME_SIMD_LEVEL:-MAX} \
   -DARROW_S3=${ARROW_S3:-OFF} \
   -DARROW_SKYHOOK=${ARROW_SKYHOOK:-OFF} \
+  -DARROW_SUBSTRAIT=${ARROW_SUBSTRAIT:-ON} \
   -DARROW_TEST_LINKAGE=${ARROW_TEST_LINKAGE:-shared} \
   -DARROW_TEST_MEMCHECK=${ARROW_TEST_MEMCHECK:-OFF} \
   -DARROW_USE_ASAN=${ARROW_USE_ASAN:-OFF} \

diff --git a/cpp/CMakeLists.txt b/cpp/CMakeLists.txt
@@ -353,7 +353,7 @@ if(ARROW_CUDA
   set(ARROW_IPC ON)
 endif()
 
-if(ARROW_ENGINE)
+if(ARROW_SUBSTRAIT)
   set(ARROW_PARQUET ON)
   set(ARROW_IPC ON)
   set(ARROW_COMPUTE ON)

diff --git a/cpp/CMakePresets.json b/cpp/CMakePresets.json
@@ -70,7 +70,7 @@
       "inherits": "features-basic",
       "hidden": true,
       "cacheVariables": {
-        "ARROW_ENGINE": "ON",
+        "ARROW_SUBSTRAIT": "ON",
         "ARROW_MIMALLOC": "ON",
         "ARROW_PARQUET": "ON",
         "ARROW_WITH_BROTLI": "ON",
@@ -127,9 +127,14 @@
     },
     {
       "name": "features-maximal",
-      "inherits": ["features-main", "features-cuda",
-                   "features-filesystems", "features-flight",
-                   "features-gandiva", "features-python"],
+      "inherits": [
+        "features-main",
+        "features-cuda",
+        "features-filesystems",
+        "features-flight",
+        "features-gandiva",
+        "features-python"
+      ],
       "hidden": true,
       "displayName": "Debug build with everything enabled (except benchmarks and CUDA)",
       "cacheVariables": {

diff --git a/cpp/cmake_modules/DefineOptions.cmake b/cpp/cmake_modules/DefineOptions.cmake
@@ -225,7 +225,7 @@ if("${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_SOURCE_DIR}")
 
   define_option(ARROW_DATASET "Build the Arrow Dataset Modules" OFF)
 
-  define_option(ARROW_ENGINE "Build the Arrow Query Engine Module" OFF)
+  define_option(ARROW_SUBSTRAIT "Build the Arrow Substrait Consumer Module" OFF)
 
   define_option(ARROW_FILESYSTEM "Build the Arrow Filesystem Layer" OFF)
 

diff --git a/cpp/cmake_modules/FindArrowEngine.cmake b/cpp/cmake_modules/FindArrowEngine.cmake
diff --git a/cpp/cmake_modules/FindArrowSubstrait.cmake b/cpp/cmake_modules/FindArrowSubstrait.cmake
@@ -0,0 +1,92 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+# - Find Arrow Substrait (libarrow_substrait.so)
+#
+# This module requires Arrow from which it uses
+#  arrow_find_package()
+#
+# This module defines
+#  ARROW_SUBSTRAIT_FOUND, whether Arrow Substrait has been found
+#  ARROW_SUBSTRAIT_IMPORT_LIB,
+#    path to libarrow_substrait's import library (Windows only)
+#  ARROW_SUBSTRAIT_INCLUDE_DIR, directory containing headers
+#  ARROW_SUBSTRAIT_LIB_DIR, directory containing Arrow Substrait libraries
+#  ARROW_SUBSTRAIT_SHARED_LIB, path to libarrow_substrait's shared library
+#  ARROW_SUBSTRAIT_STATIC_LIB, path to libarrow_substrait.a
+
+if(DEFINED ARROW_SUBSTRAIT_FOUND)
+  return()
+endif()
+
+set(find_package_arguments)
+if(${CMAKE_FIND_PACKAGE_NAME}_FIND_VERSION)
+  list(APPEND find_package_arguments "${${CMAKE_FIND_PACKAGE_NAME}_FIND_VERSION}")
+endif()
+if(${CMAKE_FIND_PACKAGE_NAME}_FIND_REQUIRED)
+  list(APPEND find_package_arguments REQUIRED)
+endif()
+if(${CMAKE_FIND_PACKAGE_NAME}_FIND_QUIETLY)
+  list(APPEND find_package_arguments QUIET)
+endif()
+find_package(Arrow ${find_package_arguments})
+find_package(Parquet ${find_package_arguments})
+
+if(ARROW_FOUND AND PARQUET_FOUND)
+  arrow_find_package(ARROW_SUBSTRAIT
+                     "${ARROW_HOME}"
+                     arrow_substrait
+                     arrow/engine/substrait/api.h
+                     ArrowSubstrait
+                     arrow-substrait)
+  if(NOT ARROW_SUBSTRAIT_VERSION)
+    set(ARROW_SUBSTRAIT_VERSION "${ARROW_VERSION}")
+  endif()
+endif()
+
+if("${ARROW_SUBSTRAIT_VERSION}" VERSION_EQUAL "${ARROW_VERSION}")
+  set(ARROW_SUBSTRAIT_VERSION_MATCH TRUE)
+else()
+  set(ARROW_SUBSTRAIT_VERSION_MATCH FALSE)
+endif()
+
+mark_as_advanced(ARROW_SUBSTRAIT_IMPORT_LIB
+                 ARROW_SUBSTRAIT_INCLUDE_DIR
+                 ARROW_SUBSTRAIT_LIBS
+                 ARROW_SUBSTRAIT_LIB_DIR
+                 ARROW_SUBSTRAIT_SHARED_IMP_LIB
+                 ARROW_SUBSTRAIT_SHARED_LIB
+                 ARROW_SUBSTRAIT_STATIC_LIB
+                 ARROW_SUBSTRAIT_VERSION
+                 ARROW_SUBSTRAIT_VERSION_MATCH)
+
+find_package_handle_standard_args(
+  ArrowSubstrait
+  REQUIRED_VARS ARROW_SUBSTRAIT_INCLUDE_DIR ARROW_SUBSTRAIT_LIB_DIR
+                ARROW_SUBSTRAIT_VERSION_MATCH
+  VERSION_VAR ARROW_SUBSTRAIT_VERSION)
+set(ARROW_SUBSTRAIT_FOUND ${ArrowSubstrait_FOUND})
+
+if(ArrowSubstrait_FOUND AND NOT ArrowSubstrait_FIND_QUIETLY)
+  message(STATUS "Found the Arrow Substrait by ${ARROW_SUBSTRAIT_FIND_APPROACH}")
+  message(STATUS "Found the Arrow Substrait shared library: ${ARROW_SUBSTRAIT_SHARED_LIB}"
+  )
+  message(STATUS "Found the Arrow Substrait import library: ${ARROW_SUBSTRAIT_IMPORT_LIB}"
+  )
+  message(STATUS "Found the Arrow Substrait static library: ${ARROW_SUBSTRAIT_STATIC_LIB}"
+  )
+endif()
diff --git a/cpp/cmake_modules/ThirdpartyToolchain.cmake b/cpp/cmake_modules/ThirdpartyToolchain.cmake
@@ -322,11 +322,7 @@ if(ARROW_ORC
   set(ARROW_WITH_PROTOBUF ON)
 endif()
 
-if(ARROW_ENGINE)
-  set(ARROW_WITH_SUBSTRAIT ON)
-endif()
-
-if(ARROW_WITH_SUBSTRAIT)
+if(ARROW_SUBSTRAIT)
   set(ARROW_WITH_PROTOBUF ON)
 endif()
 
@@ -1554,7 +1550,7 @@ if(ARROW_WITH_PROTOBUF)
     # google::protobuf::MessageLite::ByteSize() is deprecated since
     # Protobuf 3.4.0.
     set(ARROW_PROTOBUF_REQUIRED_VERSION "3.4.0")
-  elseif(ARROW_ENGINE)
+  elseif(ARROW_SUBSTRAIT)
     # Substrait protobuf files use proto3 syntax
     set(ARROW_PROTOBUF_REQUIRED_VERSION "3.0.0")
   else()
@@ -1705,7 +1701,7 @@ macro(build_substrait)
   list(APPEND ARROW_BUNDLED_STATIC_LIBS substrait)
 endmacro()
 
-if(ARROW_WITH_SUBSTRAIT)
+if(ARROW_SUBSTRAIT)
   # Currently, we can only build Substrait from source.
   set(Substrait_SOURCE "BUNDLED")
   resolve_dependency(Substrait)

diff --git a/cpp/examples/arrow/CMakeLists.txt b/cpp/examples/arrow/CMakeLists.txt
@@ -21,8 +21,8 @@ if(ARROW_COMPUTE)
   add_arrow_example(compute_register_example)
 endif()
 
-if(ARROW_ENGINE)
-  add_arrow_example(engine_substrait_consumption EXTRA_LINK_LIBS arrow_engine_shared)
+if(ARROW_SUBSTRAIT)
+  add_arrow_example(engine_substrait_consumption EXTRA_LINK_LIBS arrow_substrait_shared)
 endif()
 
 if(ARROW_COMPUTE AND ARROW_CSV)

diff --git a/cpp/src/arrow/CMakeLists.txt b/cpp/src/arrow/CMakeLists.txt
@@ -731,7 +731,7 @@ if(ARROW_COMPUTE)
   add_subdirectory(compute)
 endif()
 
-if(ARROW_ENGINE)
+if(ARROW_SUBSTRAIT)
   add_subdirectory(engine)
 endif()
 

diff --git a/...c/arrow/engine/ArrowEngineConfig.cmake.in → ...rrow/engine/ArrowSubstraitConfig.cmake.in b/...c/arrow/engine/ArrowEngineConfig.cmake.in → ...rrow/engine/ArrowSubstraitConfig.cmake.in
@@ -17,12 +17,12 @@
 #
 # This config sets the following variables in your project::
 #
-#   ArrowEngine_FOUND - true if Arrow Engine found on the system
+#   ArrowSubstrait_FOUND - true if Arrow Substrait found on the system
 #
 # This config sets the following targets in your project::
 #
-#   arrow_engine_shared - for linked as shared library if shared library is built
-#   arrow_engine_static - for linked as static library if static library is built
+#   arrow_substrait_shared - for linked as shared library if shared library is built
+#   arrow_substrait_static - for linked as static library if static library is built
 
 @PACKAGE_INIT@
 
@@ -33,6 +33,6 @@ find_dependency(Parquet)
 
 # Load targets only once. If we load targets multiple times, CMake reports
 # already existent target error.
-if(NOT (TARGET arrow_engine_shared OR TARGET arrow_engine_static))
-  include("${CMAKE_CURRENT_LIST_DIR}/ArrowEngineTargets.cmake")
+if(NOT (TARGET arrow_substrait_shared OR TARGET arrow_substrait_static))
+  include("${CMAKE_CURRENT_LIST_DIR}/ArrowSubstraitTargets.cmake")
 endif()