跳到内容

安装详情

来源: vignettes/developers/install_details.Rmd
install_details.Rmd

本文档专门针对希望了解这些脚本的 arrow 开发人员。如果您是 arrow 用户，并且需要有关安装 arrow 的帮助，请参见 安装指南

Arrow R 包需要安装 Arrow C++ 库（也称为 libarrow）才能正常工作。有许多不同的方法可以安装 libarrow

  • 作为 R 包安装过程的一部分
  • 系统包
  • 您自己在安装 R 包之外构建的库

下面，我们将依次讨论这些设置。

在 R 包安装期间安装 libarrow

运行 R CMD INSTALL . 时会触发许多脚本，对于 Arrow 用户来说，这些脚本应该都能正常工作，无需配置即可获取最完整的部分（例如：我们托管的官方二进制文件）。这些脚本的一项工作是判断是否已安装 libarrow，如果没有，则安装它。

下面是这些脚本的概述

  • configure 和 configure.win - 这些脚本分别在非 Windows 和 Windows 平台上运行 R CMD INSTALL . 时被触发。它们负责查找 libarrow，设置必要的构建变量，并编写用于编译 R 包中 C++ 代码的包 Makevars 文件。

  • tools/nixlibs.R - 此脚本由 Linux 和 macOS 上的 configure 调用（或者在任何非 Windows 操作系统上，环境变量 FORCE_BUNDLED_BUILD=true）。在 Windows 上，当环境变量 ARROW_HOME 未设置时，此脚本由 configure.win 调用。它会查找现有的 libarrow 安装，如果找不到，则会下载合适的 libarrow 二进制文件。在非 Windows 上，如果找不到二进制文件，则该脚本会为我们的捆绑构建（这是 Linux 上的默认设置）设置构建过程，并检查依赖项。

  • inst/build_arrow_static.sh - 当需要构建 libarrow 时，由 tools/nixlibs.R 调用。它为捆绑的静态构建构建 libarrow，并镜像 Arrow R 开发人员指南 中描述的步骤。此构建脚本也是用于生成预构建二进制文件的脚本。

这些脚本采取的解决依赖关系和安装正确组件的操作将在下面描述。

R 包如何查找 libarrow

Windows

下图显示了 R 包如何在 Windows 上查找 libarrow 安装。

Flowchart of libarrow installation on Windows systems - find full descriptions in sections 'Checking for existing libarrow installations' and 'Downloading libarrow' below

检查现有的 libarrow 安装

在 Windows 上安装 arrow R 包时，如果未设置 ARROW_HOME 环境变量，则安装脚本会查找现有的 libarrow 安装。如果找不到，则会检查是否已将 R_WINLIB_LOCAL 环境变量设置为指向本地安装。

下载 libarrow

如果找不到现有的 libarrow 安装，则脚本将继续尝试下载所需的 libarrow 版本，首先从 nightly 构建存储库下载，然后从 Rwinlib 下载。该脚本首先尝试找到与大多数组件（根据语义版本控制）匹配的 libarrow 版本，如果失败，则会变得不那么具体（例如，如果找不到版本 0.14.1.1 的二进制文件，则尝试找到版本 0.14.1 的二进制文件）。

非 Windows

在 Linux 和 macOS 上，核心逻辑是

  1. 如果 FORCE_BUNDLED_BUILD=true，跳到步骤 3。
  2. 在系统上查找 libarrow。如果存在，请确保其版本与 R 包兼容。
  3. 如果找不到合适的 libarrow，则下载它（如果允许）或从源代码构建它。
  4. 确定此 libarrow 具有哪些功能以及它需要哪些其他标志，并将它们设置在 src/Makevars 中，以便在编译绑定时使用。
在系统上查找 libarrow

configure 脚本将在三个位置查找 libarrow

  1. 环境变量 ARROW_HOME 中的路径（如果已设置）
  2. pkg-config 找到的任何内容，除非 ARROW_USE_PKG_CONFIG=false
  3. Homebrew，如果您已经运行了 brew install apache-arrow

如果找到 libarrow 构建，它将检查 C++ 库的版本是否与 R 包的版本匹配。如果版本不匹配，例如您已安装系统包以用于发行版本，但您有 R 包的开发版本，则不会使用该 libarrow。如果 C++ 库和 R 包都处于开发版本，您将看到一条警告消息，建议您在遇到问题时，应确保 C++ 库是从与 R 包相同的提交构建的，因为开发版本号不会随每次提交而改变。

预构建的二进制文件

如果在系统上找不到 libarrow，R 包安装脚本将接下来尝试下载与您的本地操作系统、所需依赖项（例如：openssl 版本）和 arrow R 包版本匹配的预构建 libarrow 二进制文件。

这些文件会根据 允许列表 在许多 Linux 发行版（仅 x86_64 架构）上自动使用。如果您的发行版不在列表中，您可以在调用 install.packages() 之前设置 NOT_CRAN 环境变量来选择加入。如果找到，它们将在您的 R 包编译时被下载并捆绑。

从源代码构建

如果找不到合适的 libarrow 二进制文件，它将尝试在本地构建它。首先，它还会查看您是否位于 apache/arrow git 存储库的签出中，因此那里有 libarrow 源文件。否则，它将从包中包含的源文件构建。根据您的系统，从源代码构建 libarrow 可能很慢。如果从源代码构建 libarrow，则会执行 inst/build_arrow_static.sh。

将 R 包与作为系统包安装的 libarrow 一起使用

如果您有权安装系统包，并且正在安装 CRAN 发行版，您可能希望通过软件分发工具（例如：apt 或 yum）使用与 R 包版本相对应的官方 Apache Arrow 发行版包（尽管有一些缺点：参见 “安装文档中的主要故障排除部分”）。参见 Arrow 项目安装页面 以查找一些常见 Linux 发行版（包括 Debian、Ubuntu 和 CentOS）的预编译二进制包。

如果您是为 R 包做出贡献的开发人员，系统 libarrow 包将无用，因为版本将不匹配。

将 R 包与现有的 libarrow 构建一起使用

此设置对于 arrow 开发人员来说更为常见，他们可能需要更改 R 包和 libarrow 源代码。有关更多信息，请参见 开发人员设置文档。