读取 JSON 文件#

行分隔的 JSON 文件既可以通过 TableReader 读取为单个 Arrow Table(表),也可以通过 StreamingReader 以 RecordBatch(记录批次)流式读取。

这两种读取器都需要一个表示输入文件的 arrow::io::InputStream 实例。可以通过结合使用 ReadOptionsParseOptions 及其他参数来自定义它们的行为。

TableReader#

TableReader 将整个文件一次性读取为 Table。输入文件中的每个独立 JSON 对象都被转换为输出表中的一行。

#include "arrow/json/api.h"

{
   // ...
   arrow::MemoryPool* pool = default_memory_pool();
   std::shared_ptr<arrow::io::InputStream> input = ...;

   auto read_options = arrow::json::ReadOptions::Defaults();
   auto parse_options = arrow::json::ParseOptions::Defaults();

   // Instantiate TableReader from input stream and options
   auto maybe_reader = arrow::json::TableReader::Make(pool, input, read_options, parse_options);
   if (!maybe_reader.ok()) {
      // Handle TableReader instantiation error...
   }
   auto reader = *maybe_reader;

   // Read table from JSON file
   auto maybe_table = reader->Read();
   if (!maybe_table.ok()) {
      // Handle JSON read error
      // (for example a JSON syntax error or failed type conversion)
   }
   auto table = *maybe_table;
}

StreamingReader#

StreamingReader 以大致相等的字节大小为块,增量式地读取文件,每一块产生一个 RecordBatch。块中的每个独立 JSON 对象被转换为输出批次中的一行。

所有批次都遵循一致的 Schema(模式),该模式派生自第一个加载的批次。或者,也可以通过 ParseOptions 显式传入一个模式。

#include "arrow/json/api.h"

{
   // ...
   auto read_options = arrow::json::ReadOptions::Defaults();
   auto parse_options = arrow::json::ParseOptions::Defaults();

   std::shared_ptr<arrow::io::InputStream> stream;
   auto result = arrow::json::StreamingReader::Make(stream,
                                                    read_options,
                                                    parse_options);
   if (!result.ok()) {
      // Handle instantiation error
   }
   std::shared_ptr<arrow::json::StreamingReader> reader = *result;

   for (arrow::Result<std::shared_ptr<arrow::RecordBatch>> maybe_batch : *reader) {
      if (!maybe_batch.ok()) {
         // Handle read/parse error
      }
      std::shared_ptr<arrow::RecordBatch> batch = *maybe_batch;
      // Operate on each batch...
   }
}

数据类型#

由于 JSON 值具有类型,输出的 Arrow 数据类型取决于输入值的类型。顶级 JSON 值应始终为对象。顶级对象的字段被视为代表 Arrow 数据中的列。对于 JSON 对象中的每个名称/值对,有两种决定输出数据类型的模式:

  • 如果名称在 ParseOptions::explicit_schema 中,则尝试将 JSON 值转换为相应的 Arrow 数据类型;

  • 否则,Arrow 数据类型通过对 JSON 值进行类型推断来确定,并按顺序尝试多种 Arrow 数据类型。

下表展示了这两种模式下可能的组合。

从 JSON 到 Arrow 的显式转换#

JSON 值类型

允许的 Arrow 数据类型

Null

任何(包括 Null)

数字

所有整数类型、Float32、Float64、Date32、Date64、Time32、Time64

Boolean

Boolean

String

Binary、LargeBinary、String、LargeString、Timestamp

数组

列表

对象(嵌套)

结构体

从 JSON 到 Arrow 的隐式类型推断#

JSON 值类型

推断出的 Arrow 数据类型(按顺序)

Null

Null,任何其他类型

数字

Int64、Float64

Boolean

Boolean

String

Timestamp(单位为秒)、String

数组

列表

对象(嵌套)

结构体