创建类型对象

在 nanoarrow 中，类型、字段和模式都由 nanoarrow_schema 表示。这些函数是方便的构造函数，用于以可读的方式创建这些对象。使用 na_type() 根据构造函数名称构建类型，该名称也是 nanoarrow_schema_parse() 打印/返回的名称。

用法

na_type(
  type_name,
  byte_width = NULL,
  unit = NULL,
  timezone = NULL,
  column_types = NULL,
  item_type = NULL,
  key_type = NULL,
  value_type = NULL,
  index_type = NULL,
  ordered = NULL,
  list_size = NULL,
  keys_sorted = NULL,
  storage_type = NULL,
  extension_name = NULL,
  extension_metadata = NULL,
  nullable = NULL
)

na_na(nullable = TRUE)

na_bool(nullable = TRUE)

na_int8(nullable = TRUE)

na_uint8(nullable = TRUE)

na_int16(nullable = TRUE)

na_uint16(nullable = TRUE)

na_int32(nullable = TRUE)

na_uint32(nullable = TRUE)

na_int64(nullable = TRUE)

na_uint64(nullable = TRUE)

na_half_float(nullable = TRUE)

na_float(nullable = TRUE)

na_double(nullable = TRUE)

na_string(nullable = TRUE)

na_large_string(nullable = TRUE)

na_string_view(nullable = TRUE)

na_binary(nullable = TRUE)

na_large_binary(nullable = TRUE)

na_fixed_size_binary(byte_width, nullable = TRUE)

na_binary_view(nullable = TRUE)

na_date32(nullable = TRUE)

na_date64(nullable = TRUE)

na_time32(unit = c("ms", "s"), nullable = TRUE)

na_time64(unit = c("us", "ns"), nullable = TRUE)

na_duration(unit = c("ms", "s", "us", "ns"), nullable = TRUE)

na_interval_months(nullable = TRUE)

na_interval_day_time(nullable = TRUE)

na_interval_month_day_nano(nullable = TRUE)

na_timestamp(unit = c("us", "ns", "s", "ms"), timezone = "", nullable = TRUE)

na_decimal128(precision, scale, nullable = TRUE)

na_decimal256(precision, scale, nullable = TRUE)

na_struct(column_types = list(), nullable = FALSE)

na_sparse_union(column_types = list())

na_dense_union(column_types = list())

na_list(item_type, nullable = TRUE)

na_large_list(item_type, nullable = TRUE)

na_fixed_size_list(item_type, list_size, nullable = TRUE)

na_map(key_type, item_type, keys_sorted = FALSE, nullable = TRUE)

na_dictionary(value_type, index_type = na_int32(), ordered = FALSE)

na_extension(storage_type, extension_name, extension_metadata = "")

参数

type_name

类型的名称（例如，“int32”）。这种构造函数形式对于编写循环遍历多种类型的测试很有用。

byte_width

对于 na_fixed_size_binary()，每个项目占用的字节数。

unit

“s”（秒），“ms”（毫秒），“us”（微秒）或“ns”（纳秒）之一。

timezone

表示时区名称的字符串。空字符串 "" 表示一个朴素的时间点（即没有关联时区的时间点）。

column_types

一个 list()，包含 nanoarrow_schema。

item_type

对于 na_list()、na_large_list()、na_fixed_size_list() 和 na_map()，表示项目类型的 nanoarrow_schema。

key_type

表示 na_map() 密钥类型的 nanoarrow_schema。

value_type

表示 na_dictionary() 或 na_map() 值类型的 nanoarrow_schema。

index_type

表示 na_dictionary() 索引类型的 nanoarrow_schema。

ordered

使用 TRUE 断言字典中值的顺序是有意义的。

list_size

na_fixed_size_list() 中每个项目中的元素数量。

keys_sorted

使用 TRUE 断言密钥已排序。

storage_type

对于 na_extension()，底层值类型。

extension_name

对于 na_extension()，扩展名。这通常是用点分隔的命名空间（例如，arrow.r.vctrs）。

extension_metadata

定义扩展元数据的字符串或原始向量。大多数 Arrow 扩展类型将扩展元数据定义为 JSON 对象。

nullable

使用 FALSE 断言此字段不能包含空值。

precision

十进制类型可表示的总位数

scale

十进制类型中小数点后的位数

返回值

一个 nanoarrow_schema

示例

na_int32()
#> <nanoarrow_schema int32>
#>  $ format    : chr "i"
#>  $ name      : chr ""
#>  $ metadata  : list()
#>  $ flags     : int 2
#>  $ children  : list()
#>  $ dictionary: NULL
na_struct(list(col1 = na_int32()))
#> <nanoarrow_schema struct>
#>  $ format    : chr "+s"
#>  $ name      : chr ""
#>  $ metadata  : list()
#>  $ flags     : int 0
#>  $ children  :List of 1
#>   ..$ col1:<nanoarrow_schema int32>
#>   .. ..$ format    : chr "i"
#>   .. ..$ name      : chr "col1"
#>   .. ..$ metadata  : list()
#>   .. ..$ flags     : int 2
#>   .. ..$ children  : list()
#>   .. ..$ dictionary: NULL
#>  $ dictionary: NULL