Skip to content

Latest commit

 

History

History
251 lines (188 loc) · 11.5 KB

build_system.rst

File metadata and controls

251 lines (188 loc) · 11.5 KB
Raw
.. default-domain:: cpp

Using Arrow C++ in your own project

This section assumes you already have the Arrow C++ libraries on your system, either after installing them using a package manager or after :ref:`building them yourself <building-arrow-cpp>`.

The recommended way to integrate the Arrow C++ libraries in your own C++ project is to use CMake's find_package function for locating and integrating dependencies. If you don't use CMake as a build system, you can use pkg-config to find installed the Arrow C++ libraries.

CMake

Basic usage

This minimal CMakeLists.txt file compiles a my_example.cc source file into an executable linked with the Arrow C++ shared library:

cmake_minimum_required(VERSION 3.16)

project(MyExample)

find_package(Arrow REQUIRED)

add_executable(my_example my_example.cc)
target_link_libraries(my_example PRIVATE Arrow::arrow_shared)

Available variables and targets

The directive find_package(Arrow REQUIRED) asks CMake to find an Arrow C++ installation on your system. When it returns, it will have set a few CMake variables:

  • ${Arrow_FOUND} is true if the Arrow C++ libraries have been found
  • ${ARROW_VERSION} contains the Arrow version string
  • ${ARROW_FULL_SO_VERSION} contains the Arrow DLL version string

In addition, it will have created some targets that you can link against (note these are plain strings, not variables):

  • Arrow::arrow_shared links to the Arrow shared libraries
  • Arrow::arrow_static links to the Arrow static libraries

For backwards compatibility purposes the arrow_shared and arrow_static targets are also available but we recommend using Arrow::arrow_shared and Arrow::arrow_static respectively.

In most cases, it is recommended to use the Arrow shared libraries.

If Arrow is installed on a custom path instead of a common system one you will have to add the path where Arrow is installed to CMAKE_PREFIX_PATH.

CMAKE_PREFIX_PATH can be defined as a CMake variable or an environment variable.

Your system might already have a CMAKE_PREFIX_PATH environment variable defined, use the following to expand it with the path to your Arrow installation. In this case ARROW_ROOT is expected to contain the path to your Arrow installation:

export CMAKE_PREFIX_PATH=${ARROW_ROOT}${CMAKE_PREFIX_PATH:+:${CMAKE_PREFIX_PATH}}

In the case of using a CMake variable you can add it when configuring the project like the following to contain the possible existing CMAKE_PREFIX_PATH environment variable:

cmake ... -DCMAKE_PREFIX_PATH=${ARROW_ROOT}${CMAKE_PREFIX_PATH:+:${CMAKE_PREFIX_PATH}}

Note

The usage of COMPONENTS on our find_package implementation is currently not supported.

Other available packages

There are other available packages, they can also be used with the find_package directive. This is the list of available ones and the respective targets created:

find_package usage shared target static target
find_package(ArrowCUDA REQUIRED) ArrowCUDA::arrow_cuda_shared ArrowCUDA::arrow_cuda_static
find_package(ArrowDataset REQUIRED) ArrowDataset::arrow_dataset_shared ArrowDataset::arrow_dataset_static
find_package(ArrowFlight REQUIRED) ArrowFlight::arrow_flight_shared ArrowFlight::arrow_flight_static
find_package(ArrowFlightSql REQUIRED) ArrowFlightSql::arrow_flight_sql_shared ArrowFlightSql::arrow_flight_sql_static
find_package(ArrowFlightTesting REQUIRED) ArrowFlightTesting::arrow_flight_testing_shared ArrowFlightTesting::arrow_flight_testing_static
find_package(ArrowSubstrait REQUIRED) ArrowSubstrait::arrow_substrait_shared ArrowSubstrait::arrow_substrait_static
find_package(ArrowTesting REQUIRED) ArrowTesting::arrow_testing_shared ArrowTesting::arrow_testing_static
find_package(Gandiva REQUIRED) Gandiva::gandiva_shared Gandiva::gandiva_static
find_package(Parquet REQUIRED) Parquet::parquet_shared Parquet::parquet_static

Note

CMake is case-sensitive. The names and variables listed above have to be spelt exactly that way!

.. seealso::
   A Docker-based :doc:`minimal build example <examples/cmake_minimal_build>`.

pkg-config

Basic usage

You can get suitable build flags by the following command line:

pkg-config --cflags --libs arrow

If you want to link the Arrow C++ static library, you need to add --static option:

pkg-config --cflags --libs --static arrow

This minimal Makefile file compiles a my_example.cc source file into an executable linked with the Arrow C++ shared library:

my_example: my_example.cc
    $(CXX) -o $@ $(CXXFLAGS) $< $$(pkg-config --cflags --libs arrow)

Many build systems support pkg-config. For example:

Available packages

The Arrow C++ provides a pkg-config package for each module. Here are all available packages:

  • arrow-csv
  • arrow-cuda
  • arrow-dataset
  • arrow-filesystem
  • arrow-flight-testing
  • arrow-flight
  • arrow-json
  • arrow-orc
  • arrow-python-flight
  • arrow-python
  • arrow-tensorflow
  • arrow-testing
  • arrow
  • gandiva
  • parquet

A Note on Linking

Some Arrow components have dependencies that you may want to use in your own project. Care must be taken to ensure that your project links the same version of these dependencies in the same way (statically or dynamically) as Arrow, else ODR violations may result and your program may crash or silently corrupt data.

In particular, Arrow Flight and its dependencies Protocol Buffers (Protobuf) and gRPC are likely to cause issues. When using Arrow Flight, note the following guidelines:

  • If statically linking Arrow Flight, Protobuf and gRPC must also be statically linked, and the same goes for dynamic linking.
  • Some platforms (e.g. Ubuntu 20.04 at the time of this writing) may ship a version of Protobuf and/or gRPC that is not recent enough for Arrow Flight. In that case, Arrow Flight bundles these dependencies, so care must be taken not to mix the Arrow Flight library with the platform Protobuf/gRPC libraries (as then you will have two versions of Protobuf and/or gRPC linked into your application).

It may be easiest to depend on a version of Arrow built from source, where you can control the source of each dependency and whether it is statically or dynamically linked. See :doc:`/developers/cpp/building` for instructions. Or alternatively, use Arrow from a package manager such as Conda or vcpkg which will manage consistent versions of Arrow and its dependencies.

Runtime Dependencies

While Arrow uses the OS-provided timezone database on Linux and macOS, it requires a user-provided database on Windows. You must download and extract the text version of the IANA timezone database and add the Windows timezone mapping XML. To download, you can use the following batch script:

.. literalinclude:: ../../../ci/appveyor-cpp-setup.bat
   :language: batch
   :start-after: @rem (Doc section: Download timezone database)
   :end-before: @rem (Doc section: Download timezone database)

By default, the timezone database will be detected at %USERPROFILE%\Downloads\tzdata, but you can set a custom path at runtime in :struct:`arrow::ArrowGlobalOptions`:

arrow::GlobalOptions options;
options.timezone_db_path = "path/to/tzdata";
ARROW_RETURN_NOT_OK(arrow::Initialize(options));