流式传输、序列化和IPC#

写入和读取流#

Arrow定义了两种用于序列化记录批次的二进制格式

  • 流式传输格式:用于发送任意长度的记录批次序列。该格式必须从头到尾处理,并且不支持随机访问

  • 文件或随机访问格式:用于序列化固定数量的记录批次。支持随机访问,因此与内存映射一起使用时非常有用

要学习本节,请确保首先阅读内存和IO这一节。

使用流#

首先,让我们创建一个小的记录批次

In [1]: import pyarrow as pa

In [2]: data = [
   ...:     pa.array([1, 2, 3, 4]),
   ...:     pa.array(['foo', 'bar', 'baz', None]),
   ...:     pa.array([True, None, False, True])
   ...: ]
   ...: 

In [3]: batch = pa.record_batch(data, names=['f0', 'f1', 'f2'])

In [4]: batch.num_rows
Out[4]: 4

In [5]: batch.num_columns
Out[5]: 3

现在,我们可以开始编写包含一些这些批次的流。为此,我们使用RecordBatchStreamWriter,它可以写入可写NativeFile对象或可写的Python对象。为方便起见,可以使用new_stream()来创建它

In [6]: sink = pa.BufferOutputStream()

In [7]: with pa.ipc.new_stream(sink, batch.schema) as writer:
   ...:    for i in range(5):
   ...:       writer.write_batch(batch)
   ...: 

这里我们使用了一个内存中的Arrow缓冲区流(sink),但也可以是一个套接字或其他IO接收器。

创建StreamWriter时,我们传递了schema,因为schema(列名和类型)对于此特定流中发送的所有批次必须相同。现在我们可以这样做

In [8]: buf = sink.getvalue()

In [9]: buf.size
Out[9]: 1984

现在buf包含作为内存字节缓冲区的完整流。我们可以使用RecordBatchStreamReader或方便函数pyarrow.ipc.open_stream读取这样的流

In [10]: with pa.ipc.open_stream(buf) as reader:
   ....:       schema = reader.schema
   ....:       batches = [b for b in reader]
   ....: 

In [11]: schema
Out[11]: 
f0: int64
f1: string
f2: bool

In [12]: len(batches)
Out[12]: 5

我们可以检查返回的批次是否与原始输入相同

In [13]: batches[0].equals(batch)
Out[13]: True

重要的一点是,如果输入源支持零拷贝读取(例如,像内存映射或pyarrow.BufferReader),那么返回的批次也是零拷贝的,并且在读取时不会分配任何新内存。

写入和读取随机访问文件#

RecordBatchFileWriter具有与RecordBatchStreamWriter相同的API。您可以使用new_file()创建一个

In [14]: sink = pa.BufferOutputStream()

In [15]: with pa.ipc.new_file(sink, batch.schema) as writer:
   ....:    for i in range(10):
   ....:       writer.write_batch(batch)
   ....: 

In [16]: buf = sink.getvalue()

In [17]: buf.size
Out[17]: 4226

RecordBatchFileReaderRecordBatchStreamReader之间的区别在于,输入源必须具有用于随机访问的seek方法。流读取器仅需要读取操作。我们也可以使用open_file()方法打开文件

In [18]: with pa.ipc.open_file(buf) as reader:
   ....:    num_record_batches = reader.num_record_batches
   ....: 

In [19]: b = reader.get_batch(3)

因为我们可以访问整个有效负载,所以我们知道文件中的记录批次数,并且可以随机读取任何一个。

In [20]: num_record_batches
Out[20]: 10

In [21]: b.equals(batch)
Out[21]: True

从流和文件格式读取pandas#

流和文件读取器类有一个特殊的read_pandas方法,以简化读取多个记录批次并将其转换为单个DataFrame输出

In [22]: with pa.ipc.open_file(buf) as reader:
   ....:    df = reader.read_pandas()
   ....: 

In [23]: df[:5]
Out[23]: 
   f0    f1     f2
0   1   foo   True
1   2   bar   None
2   3   baz  False
3   4  None   True
4   1   foo   True

高效地写入和读取Arrow数据#

Arrow针对零拷贝和内存映射数据进行了优化,可以轻松读取和写入数组,从而消耗最少的驻留内存。

在写入和读取原始Arrow数据时,我们可以使用Arrow文件格式或Arrow流式传输格式。

要将数组转储到文件,可以使用new_file(),它将提供一个新的RecordBatchFileWriter实例,该实例可用于将数据批次写入该文件。

例如,要写入一个包含10M个整数的数组,我们可以将其写入1000个包含10000个条目的块中

In [24]: BATCH_SIZE = 10000

In [25]: NUM_BATCHES = 1000

In [26]: schema = pa.schema([pa.field('nums', pa.int32())])

In [27]: with pa.OSFile('bigfile.arrow', 'wb') as sink:
   ....:    with pa.ipc.new_file(sink, schema) as writer:
   ....:       for row in range(NUM_BATCHES):
   ....:             batch = pa.record_batch([pa.array(range(BATCH_SIZE), type=pa.int32())], schema)
   ....:             writer.write(batch)
   ....: 

记录批次支持多个列,因此在实践中,我们总是写入等效于Table的数据。

按批次写入是有效的,因为从理论上讲,我们只需要将当前正在写入的批次保存在内存中。但是在读取回时,我们可以通过直接映射磁盘中的数据来更有效,并避免在读取时分配任何新内存。

在正常情况下,读取回我们的文件将消耗数百兆字节的内存

In [28]: with pa.OSFile('bigfile.arrow', 'rb') as source:
   ....:    loaded_array = pa.ipc.open_file(source).read_all()
   ....: 

In [29]: print("LEN:", len(loaded_array))
LEN: 10000000

In [30]: print("RSS: {}MB".format(pa.total_allocated_bytes() >> 20))
RSS: 38MB

为了更有效地从磁盘读取大数据,我们可以对文件进行内存映射,以便Arrow可以直接引用从磁盘映射的数据,并避免分配自己的内存。在这种情况下,操作系统将能够惰性地分页映射的内存,并在压力下将其分页出去而无需任何写回成本,从而可以更轻松地读取大于总内存的数组。

In [31]: with pa.memory_map('bigfile.arrow', 'rb') as source:
   ....:    loaded_array = pa.ipc.open_file(source).read_all()
   ....: 

In [32]: print("LEN:", len(loaded_array))
LEN: 10000000

In [33]: print("RSS: {}MB".format(pa.total_allocated_bytes() >> 20))
RSS: 0MB

注意

其他高级API,如read_table()也提供一个memory_map选项。但在这些情况下,内存映射不能帮助减少驻留内存消耗。有关详细信息,请参阅读取 Parquet 和内存映射