1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
use ahash::AHashMap;
use std::io::Read;
use arrow_format;
use arrow_format::ipc::planus::ReadAsRoot;
use crate::array::Array;
use crate::chunk::Chunk;
use crate::datatypes::Schema;
use crate::error::{Error, Result};
use crate::io::ipc::IpcSchema;
use super::super::CONTINUATION_MARKER;
use super::common::*;
use super::schema::deserialize_stream_metadata;
use super::Dictionaries;
use super::OutOfSpecKind;
/// Metadata of an Arrow IPC stream, written at the start of the stream
#[derive(Debug, Clone)]
pub struct StreamMetadata {
/// The schema that is read from the stream's first message
pub schema: Schema,
/// The IPC version of the stream
pub version: arrow_format::ipc::MetadataVersion,
/// The IPC fields tracking dictionaries
pub ipc_schema: IpcSchema,
}
/// Reads the metadata of the stream
pub fn read_stream_metadata<R: Read>(reader: &mut R) -> Result<StreamMetadata> {
// determine metadata length
let mut meta_size: [u8; 4] = [0; 4];
reader.read_exact(&mut meta_size)?;
let meta_length = {
// If a continuation marker is encountered, skip over it and read
// the size from the next four bytes.
if meta_size == CONTINUATION_MARKER {
reader.read_exact(&mut meta_size)?;
}
i32::from_le_bytes(meta_size)
};
let length: usize = meta_length
.try_into()
.map_err(|_| Error::from(OutOfSpecKind::NegativeFooterLength))?;
let mut buffer = vec![];
buffer.try_reserve(length)?;
reader
.by_ref()
.take(length as u64)
.read_to_end(&mut buffer)?;
deserialize_stream_metadata(&buffer)
}
/// Encodes the stream's status after each read.
///
/// A stream is an iterator, and an iterator returns `Option<Item>`. The `Item`
/// type in the [`StreamReader`] case is `StreamState`, which means that an Arrow
/// stream may yield one of three values: (1) `None`, which signals that the stream
/// is done; (2) [`StreamState::Some`], which signals that there was
/// data waiting in the stream and we read it; and finally (3)
/// [`Some(StreamState::Waiting)`], which means that the stream is still "live", it
/// just doesn't hold any data right now.
pub enum StreamState {
/// A live stream without data
Waiting,
/// Next item in the stream
Some(Chunk<Box<dyn Array>>),
}
impl StreamState {
/// Return the data inside this wrapper.
///
/// # Panics
///
/// If the `StreamState` was `Waiting`.
pub fn unwrap(self) -> Chunk<Box<dyn Array>> {
if let StreamState::Some(batch) = self {
batch
} else {
panic!("The batch is not available")
}
}
}
/// Reads the next item, yielding `None` if the stream is done,
/// and a [`StreamState`] otherwise.
fn read_next<R: Read>(
reader: &mut R,
metadata: &StreamMetadata,
dictionaries: &mut Dictionaries,
message_buffer: &mut Vec<u8>,
data_buffer: &mut Vec<u8>,
projection: &Option<(Vec<usize>, AHashMap<usize, usize>, Schema)>,
scratch: &mut Vec<u8>,
) -> Result<Option<StreamState>> {
// determine metadata length
let mut meta_length: [u8; 4] = [0; 4];
match reader.read_exact(&mut meta_length) {
Ok(()) => (),
Err(e) => {
return if e.kind() == std::io::ErrorKind::UnexpectedEof {
// Handle EOF without the "0xFFFFFFFF 0x00000000"
// valid according to:
// https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format
Ok(Some(StreamState::Waiting))
} else {
Err(Error::from(e))
};
}
}
let meta_length = {
// If a continuation marker is encountered, skip over it and read
// the size from the next four bytes.
if meta_length == CONTINUATION_MARKER {
reader.read_exact(&mut meta_length)?;
}
i32::from_le_bytes(meta_length)
};
let meta_length: usize = meta_length
.try_into()
.map_err(|_| Error::from(OutOfSpecKind::NegativeFooterLength))?;
if meta_length == 0 {
// the stream has ended, mark the reader as finished
return Ok(None);
}
message_buffer.clear();
message_buffer.try_reserve(meta_length)?;
reader
.by_ref()
.take(meta_length as u64)
.read_to_end(message_buffer)?;
let message = arrow_format::ipc::MessageRef::read_as_root(message_buffer.as_ref())
.map_err(|err| Error::from(OutOfSpecKind::InvalidFlatbufferMessage(err)))?;
let header = message
.header()
.map_err(|err| Error::from(OutOfSpecKind::InvalidFlatbufferHeader(err)))?
.ok_or_else(|| Error::from(OutOfSpecKind::MissingMessageHeader))?;
let block_length: usize = message
.body_length()
.map_err(|err| Error::from(OutOfSpecKind::InvalidFlatbufferBodyLength(err)))?
.try_into()
.map_err(|_| Error::from(OutOfSpecKind::UnexpectedNegativeInteger))?;
match header {
arrow_format::ipc::MessageHeaderRef::RecordBatch(batch) => {
data_buffer.clear();
data_buffer.try_reserve(block_length)?;
reader
.by_ref()
.take(block_length as u64)
.read_to_end(data_buffer)?;
let file_size = data_buffer.len() as u64;
let mut reader = std::io::Cursor::new(data_buffer);
let chunk = read_record_batch(
batch,
&metadata.schema.fields,
&metadata.ipc_schema,
projection.as_ref().map(|x| x.0.as_ref()),
None,
dictionaries,
metadata.version,
&mut reader,
0,
file_size,
scratch,
);
if let Some((_, map, _)) = projection {
// re-order according to projection
chunk
.map(|chunk| apply_projection(chunk, map))
.map(|x| Some(StreamState::Some(x)))
} else {
chunk.map(|x| Some(StreamState::Some(x)))
}
}
arrow_format::ipc::MessageHeaderRef::DictionaryBatch(batch) => {
data_buffer.clear();
data_buffer.try_reserve(block_length)?;
reader
.by_ref()
.take(block_length as u64)
.read_to_end(data_buffer)?;
let file_size = data_buffer.len() as u64;
let mut dict_reader = std::io::Cursor::new(&data_buffer);
read_dictionary(
batch,
&metadata.schema.fields,
&metadata.ipc_schema,
dictionaries,
&mut dict_reader,
0,
file_size,
scratch,
)?;
// read the next message until we encounter a RecordBatch message
read_next(
reader,
metadata,
dictionaries,
message_buffer,
data_buffer,
projection,
scratch,
)
}
_ => Err(Error::from(OutOfSpecKind::UnexpectedMessageType)),
}
}
/// Arrow Stream reader.
///
/// An [`Iterator`] over an Arrow stream that yields a result of [`StreamState`]s.
/// This is the recommended way to read an arrow stream (by iterating over its data).
///
/// For a more thorough walkthrough consult [this example](https://github.com/jorgecarleitao/arrow2/tree/main/examples/ipc_pyarrow).
pub struct StreamReader<R: Read> {
reader: R,
metadata: StreamMetadata,
dictionaries: Dictionaries,
finished: bool,
data_buffer: Vec<u8>,
message_buffer: Vec<u8>,
projection: Option<(Vec<usize>, AHashMap<usize, usize>, Schema)>,
scratch: Vec<u8>,
}
impl<R: Read> StreamReader<R> {
/// Try to create a new stream reader
///
/// The first message in the stream is the schema, the reader will fail if it does not
/// encounter a schema.
/// To check if the reader is done, use `is_finished(self)`
pub fn new(reader: R, metadata: StreamMetadata, projection: Option<Vec<usize>>) -> Self {
let projection = projection.map(|projection| {
let (p, h, fields) = prepare_projection(&metadata.schema.fields, projection);
let schema = Schema {
fields,
metadata: metadata.schema.metadata.clone(),
};
(p, h, schema)
});
Self {
reader,
metadata,
dictionaries: Default::default(),
finished: false,
data_buffer: Default::default(),
message_buffer: Default::default(),
projection,
scratch: Default::default(),
}
}
/// Return the schema of the stream
pub fn metadata(&self) -> &StreamMetadata {
&self.metadata
}
/// Return the schema of the file
pub fn schema(&self) -> &Schema {
self.projection
.as_ref()
.map(|x| &x.2)
.unwrap_or(&self.metadata.schema)
}
/// Check if the stream is finished
pub fn is_finished(&self) -> bool {
self.finished
}
fn maybe_next(&mut self) -> Result<Option<StreamState>> {
if self.finished {
return Ok(None);
}
let batch = read_next(
&mut self.reader,
&self.metadata,
&mut self.dictionaries,
&mut self.message_buffer,
&mut self.data_buffer,
&self.projection,
&mut self.scratch,
)?;
if batch.is_none() {
self.finished = true;
}
Ok(batch)
}
}
impl<R: Read> Iterator for StreamReader<R> {
type Item = Result<StreamState>;
fn next(&mut self) -> Option<Self::Item> {
self.maybe_next().transpose()
}
}