跳过内容

安装详情

来源：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 builds 仓库，然后从 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 仓库的 checkout 中，从而在那里拥有 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 源代码。有关更多信息，请参阅开发者设置文档。