nanoarrow#

nanoarrow 的目标是为 Arrow C 数据Arrow C 流 接口提供最小的有用绑定,使用 nanoarrow C 库

安装#

您可以从 CRAN 安装 nanoarrow 的发布版本:

install.packages("nanoarrow")

您可以从 GitHub 安装 nanoarrow 的开发版本:

# install.packages("remotes")
remotes::install_github("apache/arrow-nanoarrow/r")

如果您可以加载该包,那么您就可以开始了!

library(nanoarrow)

示例#

Arrow C 数据和 Arrow C 流接口包含三个结构:ArrowSchema 表示数组的数据类型,ArrowArray 表示数组的值,以及 ArrowArrayStream,表示具有公共 ArrowSchema 的零个或多个 ArrowArray。所有三个都可以使用 nanoarrow R 包由 R 对象包装。

模式#

使用 infer_nanoarrow_schema() 获取对应于给定 R 向量类型的 ArrowSchema 对象;使用 as_nanoarrow_schema() 将对象从其他数据类型表示(例如,arrow R 包中的 DataType,如 arrow::int32())转换;或使用 na_XXX() 函数构建它们。

infer_nanoarrow_schema(1:5)
#> <nanoarrow_schema int32>
#>  $ format    : chr "i"
#>  $ name      : chr ""
#>  $ metadata  : list()
#>  $ flags     : int 2
#>  $ children  : list()
#>  $ dictionary: NULL
as_nanoarrow_schema(arrow::schema(col1 = arrow::float64()))
#> <nanoarrow_schema struct>
#>  $ format    : chr "+s"
#>  $ name      : chr ""
#>  $ metadata  : list()
#>  $ flags     : int 0
#>  $ children  :List of 1
#>   ..$ col1:<nanoarrow_schema double>
#>   .. ..$ format    : chr "g"
#>   .. ..$ name      : chr "col1"
#>   .. ..$ metadata  : list()
#>   .. ..$ flags     : int 2
#>   .. ..$ children  : list()
#>   .. ..$ dictionary: NULL
#>  $ dictionary: NULL
na_int64()
#> <nanoarrow_schema int64>
#>  $ format    : chr "l"
#>  $ name      : chr ""
#>  $ metadata  : list()
#>  $ flags     : int 2
#>  $ children  : list()
#>  $ dictionary: NULL

数组#

使用 as_nanoarrow_array() 将对象转换为 ArrowArray 对象

as_nanoarrow_array(1:5)
#> <nanoarrow_array int32[5]>
#>  $ length    : int 5
#>  $ null_count: int 0
#>  $ offset    : int 0
#>  $ buffers   :List of 2
#>   ..$ :<nanoarrow_buffer validity<bool>[0][0 b]> ``
#>   ..$ :<nanoarrow_buffer data<int32>[5][20 b]> `1 2 3 4 5`
#>  $ dictionary: NULL
#>  $ children  : list()
as_nanoarrow_array(data.frame(col1 = c(1.1, 2.2)))
#> <nanoarrow_array struct[2]>
#>  $ length    : int 2
#>  $ null_count: int 0
#>  $ offset    : int 0
#>  $ buffers   :List of 1
#>   ..$ :<nanoarrow_buffer validity<bool>[0][0 b]> ``
#>  $ children  :List of 1
#>   ..$ col1:<nanoarrow_array double[2]>
#>   .. ..$ length    : int 2
#>   .. ..$ null_count: int 0
#>   .. ..$ offset    : int 0
#>   .. ..$ buffers   :List of 2
#>   .. .. ..$ :<nanoarrow_buffer validity<bool>[0][0 b]> ``
#>   .. .. ..$ :<nanoarrow_buffer data<double>[2][16 b]> `1.1 2.2`
#>   .. ..$ dictionary: NULL
#>   .. ..$ children  : list()
#>  $ dictionary: NULL

您可以使用 as.vector()as.data.frame() 获取对象的 R 表示形式

array <- as_nanoarrow_array(data.frame(col1 = c(1.1, 2.2)))
as.data.frame(array)
#>   col1
#> 1  1.1
#> 2  2.2

即使在 C 层面上,ArrowArray 与 ArrowSchema 是不同的,但在 R 层面上,我们尽可能地附加模式。您可以使用 infer_nanoarrow_schema() 访问附加的模式

infer_nanoarrow_schema(array)
#> <nanoarrow_schema struct>
#>  $ format    : chr "+s"
#>  $ name      : chr ""
#>  $ metadata  : list()
#>  $ flags     : int 0
#>  $ children  :List of 1
#>   ..$ col1:<nanoarrow_schema double>
#>   .. ..$ format    : chr "g"
#>   .. ..$ name      : chr "col1"
#>   .. ..$ metadata  : list()
#>   .. ..$ flags     : int 2
#>   .. ..$ children  : list()
#>   .. ..$ dictionary: NULL
#>  $ dictionary: NULL

数组流#

创建 ArrowArrayStream 最简单的方法是从数组列表或可以使用 as_nanoarrow_array() 转换为数组的对象创建。

stream <- basic_array_stream(
  list(
    data.frame(col1 = c(1.1, 2.2)),
    data.frame(col1 = c(3.3, 4.4))
  )
)

您可以使用 $get_next() 方法从流中提取批次。最后一个批次将返回 NULL

stream$get_next()
#> <nanoarrow_array struct[2]>
#>  $ length    : int 2
#>  $ null_count: int 0
#>  $ offset    : int 0
#>  $ buffers   :List of 1
#>   ..$ :<nanoarrow_buffer validity<bool>[0][0 b]> ``
#>  $ children  :List of 1
#>   ..$ col1:<nanoarrow_array double[2]>
#>   .. ..$ length    : int 2
#>   .. ..$ null_count: int 0
#>   .. ..$ offset    : int 0
#>   .. ..$ buffers   :List of 2
#>   .. .. ..$ :<nanoarrow_buffer validity<bool>[0][0 b]> ``
#>   .. .. ..$ :<nanoarrow_buffer data<double>[2][16 b]> `1.1 2.2`
#>   .. ..$ dictionary: NULL
#>   .. ..$ children  : list()
#>  $ dictionary: NULL
stream$get_next()
#> <nanoarrow_array struct[2]>
#>  $ length    : int 2
#>  $ null_count: int 0
#>  $ offset    : int 0
#>  $ buffers   :List of 1
#>   ..$ :<nanoarrow_buffer validity<bool>[0][0 b]> ``
#>  $ children  :List of 1
#>   ..$ col1:<nanoarrow_array double[2]>
#>   .. ..$ length    : int 2
#>   .. ..$ null_count: int 0
#>   .. ..$ offset    : int 0
#>   .. ..$ buffers   :List of 2
#>   .. .. ..$ :<nanoarrow_buffer validity<bool>[0][0 b]> ``
#>   .. .. ..$ :<nanoarrow_buffer data<double>[2][16 b]> `3.3 4.4`
#>   .. ..$ dictionary: NULL
#>   .. ..$ children  : list()
#>  $ dictionary: NULL
stream$get_next()
#> NULL

您可以通过调用 as.data.frame()as.vector() 将所有批次提取到 data.frame() 中。

stream <- basic_array_stream(
  list(
    data.frame(col1 = c(1.1, 2.2)),
    data.frame(col1 = c(3.3, 4.4))
  )
)

as.data.frame(stream)
#>   col1
#> 1  1.1
#> 2  2.2
#> 3  3.3
#> 4  4.4

使用流后,您应该尽快调用释放方法。这使流的实现能够以比等待垃圾回收器清理对象更可预测的方式释放其可能持有的任何资源(如打开的文件)。

与 arrow 包集成#

nanoarrow 包为大多数 arrow 包类型实现了 as_nanoarrow_schema()as_nanoarrow_array()as_nanoarrow_array_stream()。类似地,它为 nanoarrow 对象实现了 arrow::as_arrow_array()arrow::as_record_batch()arrow::as_arrow_table()arrow::as_record_batch_reader()arrow::infer_type()arrow::as_data_type()arrow::as_schema(),这样您就可以将等效的 nanoarrow 对象传递到许多 arrow 函数中,反之亦然。