datu 0.3.4

datu - a data file utility
Documentation
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
use arrow::array::RecordBatchReader;
use arrow::datatypes::SchemaRef;
use arrow::error::ArrowError;
use arrow::record_batch::RecordBatch;
use async_trait::async_trait;
use indicatif::ProgressBar;

use crate::Error;
use crate::FileType;
use crate::cli::DisplayOutputFormat;
use crate::pipeline::DisplaySlice;
use crate::pipeline::Producer;
use crate::pipeline::ProgressRecordBatchReader;
use crate::pipeline::RecordBatchReaderSource;
use crate::pipeline::SelectSpec;
use crate::pipeline::Step;
use crate::pipeline::VecRecordBatchReaderSource;
use crate::pipeline::block_on_pipeline_future;
use crate::pipeline::count_rows;
use crate::pipeline::display::apply_select_and_display;
use crate::pipeline::orc::OrcRecordBatchReader;
use crate::pipeline::read::ReadArgs;
use crate::pipeline::sample_from_reader;
use crate::pipeline::schema::get_schema_fields;
use crate::pipeline::schema::print_schema_fields;
use crate::pipeline::schema::schema_fields_from_arrow;
use crate::pipeline::tail_batches;
use crate::pipeline::write::write_record_batches_from_reader;

/// A Source that wraps a single RecordBatchReader and yields it on get().
struct RecordBatchReaderHolder {
    reader: Option<Box<dyn RecordBatchReader + 'static>>,
}

#[async_trait(?Send)]
impl Producer<dyn RecordBatchReader + 'static> for RecordBatchReaderHolder {
    async fn get(&mut self) -> crate::Result<Box<dyn RecordBatchReader + 'static>> {
        std::mem::take(&mut self.reader)
            .ok_or_else(|| Error::GenericError("Reader already taken".to_string()))
    }
}

/// Pipeline step that filters record batches to only the specified columns.
pub struct RecordBatchSelect {
    pub select: SelectSpec,
}

#[async_trait(?Send)]
impl Step for RecordBatchSelect {
    type Input = RecordBatchReaderSource;
    type Output = RecordBatchReaderSource;

    async fn execute(self, mut input: Self::Input) -> crate::Result<Self::Output> {
        let reader = input.get().await?;
        let schema = reader.schema();
        let column_names = self.select.resolve_names(&schema)?;
        let indices: Vec<usize> = column_names
            .iter()
            .map(|col| {
                schema
                    .index_of(col)
                    .map_err(|e| Error::GenericError(format!("Column '{col}' not found: {e}")))
            })
            .collect::<crate::Result<Vec<_>>>()?;
        let projected_schema = reader.schema().project(&indices)?;
        let projected_reader = SelectColumnRecordBatchReader {
            reader,
            schema: std::sync::Arc::new(projected_schema),
            indices,
        };
        Ok(Box::new(RecordBatchReaderHolder {
            reader: Some(Box::new(projected_reader)),
        }))
    }
}

/// Record batch reader that projects only the selected column indices.
pub struct SelectColumnRecordBatchReader {
    reader: Box<dyn RecordBatchReader>,
    schema: arrow::datatypes::SchemaRef,
    indices: Vec<usize>,
}

impl RecordBatchReader for SelectColumnRecordBatchReader {
    fn schema(&self) -> arrow::datatypes::SchemaRef {
        self.schema.clone()
    }
}

impl Iterator for SelectColumnRecordBatchReader {
    type Item = arrow::error::Result<arrow::record_batch::RecordBatch>;

    fn next(&mut self) -> Option<Self::Item> {
        self.reader
            .next()
            .map(|batch| batch.and_then(|b| b.project(&self.indices)))
    }
}

/// Builds a [`RecordBatchSelect`] from a resolved [`SelectSpec`].
/// Returns None when no selection is requested.
pub fn parse_select_step(select: Option<SelectSpec>) -> Option<RecordBatchSelect> {
    select.as_ref()?;
    select.map(|columns| RecordBatchSelect { select: columns })
}

/// Skips the first `offset_remaining` logical rows from an underlying [`RecordBatchReader`].
pub(crate) struct SkipRowsRecordBatchReader {
    reader: Box<dyn RecordBatchReader + 'static>,
    offset_remaining: usize,
}

impl RecordBatchReader for SkipRowsRecordBatchReader {
    fn schema(&self) -> SchemaRef {
        self.reader.schema()
    }
}

impl Iterator for SkipRowsRecordBatchReader {
    type Item = std::result::Result<RecordBatch, ArrowError>;

    fn next(&mut self) -> Option<Self::Item> {
        loop {
            let batch = self.reader.next()?;
            let batch = match batch {
                Ok(b) => b,
                Err(e) => return Some(Err(e)),
            };
            let batch_rows = batch.num_rows();
            if batch_rows == 0 {
                continue;
            }
            if self.offset_remaining == 0 {
                return Some(Ok(batch));
            }
            if batch_rows <= self.offset_remaining {
                self.offset_remaining -= batch_rows;
                continue;
            }
            let start = self.offset_remaining;
            self.offset_remaining = 0;
            return Some(Ok(batch.slice(start, batch_rows - start)));
        }
    }
}

/// Yields at most `remaining` rows from an underlying [`RecordBatchReader`].
/// Used by [`RecordBatchHead`] and by [`apply_offset_limit`] for record-batch read limits.
pub(crate) struct TakeRowsRecordBatchReader {
    reader: Box<dyn RecordBatchReader + 'static>,
    remaining: usize,
}

impl RecordBatchReader for TakeRowsRecordBatchReader {
    fn schema(&self) -> SchemaRef {
        self.reader.schema()
    }
}

impl Iterator for TakeRowsRecordBatchReader {
    type Item = std::result::Result<RecordBatch, ArrowError>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.remaining == 0 {
            return None;
        }
        loop {
            match self.reader.next() {
                None => return None,
                Some(Err(e)) => return Some(Err(e)),
                Some(Ok(batch)) => {
                    let rows = batch.num_rows();
                    if rows == 0 {
                        continue;
                    }
                    if rows <= self.remaining {
                        self.remaining -= rows;
                        return Some(Ok(batch));
                    }
                    let slice = batch.slice(0, self.remaining);
                    self.remaining = 0;
                    return Some(Ok(slice));
                }
            }
        }
    }
}

/// Applies SQL-style `OFFSET` / `LIMIT` across record batches: skip `offset` rows, then take at most
/// `limit` rows when `limit` is `Some`.
pub(crate) fn apply_offset_limit(
    reader: Box<dyn RecordBatchReader + 'static>,
    offset: usize,
    limit: Option<usize>,
) -> Box<dyn RecordBatchReader + 'static> {
    let mut r = reader;
    if offset > 0 {
        r = Box::new(SkipRowsRecordBatchReader {
            reader: r,
            offset_remaining: offset,
        });
    }
    if let Some(n) = limit {
        r = Box::new(TakeRowsRecordBatchReader {
            reader: r,
            remaining: n,
        });
    }
    r
}

/// Keeps the first `n` rows across batches (same streaming cap as record-batch read `limit` after any skip).
pub struct RecordBatchHead {
    pub n: usize,
}

#[async_trait(?Send)]
impl Step for RecordBatchHead {
    type Input = RecordBatchReaderSource;
    type Output = RecordBatchReaderSource;

    async fn execute(self, mut input: Self::Input) -> crate::Result<Self::Output> {
        let reader = input.get().await?;
        let wrapped = Box::new(TakeRowsRecordBatchReader {
            reader,
            remaining: self.n,
        });
        Ok(Box::new(RecordBatchReaderHolder {
            reader: Some(wrapped),
        }))
    }
}

/// Keeps the last `n` rows (materializes all batches). Orthogonal to [`ReadArgs`] offset/limit from
/// the start of the file; use for tail/slice display, not for SQL-style `OFFSET`/`LIMIT`.
pub struct RecordBatchTail {
    pub n: usize,
}

#[async_trait(?Send)]
impl Step for RecordBatchTail {
    type Input = RecordBatchReaderSource;
    type Output = RecordBatchReaderSource;

    async fn execute(self, mut input: Self::Input) -> crate::Result<Self::Output> {
        let reader = input.get().await?;
        let batches: Vec<RecordBatch> = reader
            .collect::<std::result::Result<Vec<_>, _>>()
            .map_err(Error::ArrowError)?;
        let batches = tail_batches(batches, self.n);
        Ok(Box::new(VecRecordBatchReaderSource::new(batches)))
    }
}

/// Random sample of `n` rows (uses ORC row count from `input_path`).
pub struct RecordBatchSample {
    pub input_path: String,
    pub n: usize,
}

#[async_trait(?Send)]
impl Step for RecordBatchSample {
    type Input = RecordBatchReaderSource;
    type Output = RecordBatchReaderSource;

    async fn execute(self, mut input: Self::Input) -> crate::Result<Self::Output> {
        let total_rows = crate::get_total_rows_result(&self.input_path, FileType::Orc)?;
        let reader = input.get().await?;
        let sampled = sample_from_reader(reader, total_rows, self.n);
        Ok(Box::new(VecRecordBatchReaderSource::new(sampled)))
    }
}

/// File output vs stdout display; tail of [`RecordBatchPipeline`] after ORC read/select/slice.
pub enum RecordBatchSink {
    Write {
        output_path: String,
        output_file_type: FileType,
        json_pretty: bool,
        progress: Option<ProgressBar>,
    },
    Display {
        output_format: DisplayOutputFormat,
        csv_stdout_headers: bool,
    },
    Schema {
        output_format: DisplayOutputFormat,
        sparse: bool,
    },
    Count,
}

/// ORC read, then optional column select (schema/count with projection, and base for write/display).
async fn orc_source_after_select(
    input_path: String,
    select: Option<SelectSpec>,
) -> crate::Result<RecordBatchReaderSource> {
    let read_args = ReadArgs::new(input_path, FileType::Orc);
    let mut source: RecordBatchReaderSource = Box::new(OrcRecordBatchReader { args: read_args });
    if let Some(select_step) = parse_select_step(select) {
        source = select_step.execute(source).await?;
    }
    Ok(source)
}

/// [`orc_source_after_select`] plus optional head/tail/sample (write/display path).
async fn orc_source_after_select_and_slice(
    input_path: String,
    select: Option<SelectSpec>,
    slice: Option<DisplaySlice>,
) -> crate::Result<RecordBatchReaderSource> {
    let mut source = orc_source_after_select(input_path.clone(), select).await?;
    if let Some(slice) = slice {
        source = match slice {
            DisplaySlice::Head(n) => RecordBatchHead { n }.execute(source).await?,
            DisplaySlice::Tail(n) => RecordBatchTail { n }.execute(source).await?,
            DisplaySlice::Sample(n) => RecordBatchSample { input_path, n }.execute(source).await?,
        };
    }
    Ok(source)
}

/// ORC input via record-batch steps (see `PIPELINE.mermaid` RecordBatch branch).
pub struct RecordBatchPipeline {
    pub(crate) input_path: String,
    pub(crate) input_file_type: FileType,
    pub(crate) select: Option<SelectSpec>,
    pub(crate) slice: Option<DisplaySlice>,
    pub(crate) sparse: bool,
    pub(crate) sink: RecordBatchSink,
}

impl RecordBatchPipeline {
    /// ORC read, optional column select, optional head/tail/sample, then [`RecordBatchSink`].
    pub fn execute(&mut self) -> crate::Result<()> {
        if self.input_file_type != FileType::Orc {
            return Err(Error::GenericError(format!(
                "RecordBatchPipeline only supports ORC input, got {}",
                self.input_file_type
            )));
        }

        let input_path = self.input_path.clone();
        let select = self.select.clone();
        let slice = self.slice;
        let sparse = self.sparse;
        let sink = match &self.sink {
            RecordBatchSink::Write {
                output_path,
                output_file_type,
                json_pretty,
                progress,
            } => RecordBatchSink::Write {
                output_path: output_path.clone(),
                output_file_type: *output_file_type,
                json_pretty: *json_pretty,
                progress: progress.clone(),
            },
            RecordBatchSink::Display {
                output_format,
                csv_stdout_headers,
            } => RecordBatchSink::Display {
                output_format: *output_format,
                csv_stdout_headers: *csv_stdout_headers,
            },
            RecordBatchSink::Schema {
                output_format,
                sparse: schema_sparse,
            } => RecordBatchSink::Schema {
                output_format: *output_format,
                sparse: *schema_sparse,
            },
            RecordBatchSink::Count => RecordBatchSink::Count,
        };

        let fut = async move {
            match sink {
                RecordBatchSink::Schema {
                    output_format,
                    sparse: schema_sparse,
                } => {
                    if select.is_none() {
                        let fields = get_schema_fields(&input_path, FileType::Orc, None)
                            .map_err(|e| Error::GenericError(e.to_string()))?;
                        print_schema_fields(&fields, output_format, schema_sparse)
                            .map_err(|e| Error::GenericError(e.to_string()))?;
                    } else {
                        let mut source =
                            orc_source_after_select(input_path.clone(), select).await?;
                        let reader = source.get().await?;
                        let fields = schema_fields_from_arrow(reader.schema().as_ref());
                        print_schema_fields(&fields, output_format, schema_sparse)
                            .map_err(|e| Error::GenericError(e.to_string()))?;
                    }
                    Ok::<(), Error>(())
                }
                RecordBatchSink::Count => {
                    if select.is_none() {
                        let total = count_rows(&input_path, FileType::Orc, None).await?;
                        println!("{total}");
                    } else {
                        let mut source =
                            orc_source_after_select(input_path.clone(), select).await?;
                        let reader = source.get().await?;
                        let mut total = 0usize;
                        for batch in reader {
                            total += batch.map_err(Error::ArrowError)?.num_rows();
                        }
                        println!("{total}");
                    }
                    Ok::<(), Error>(())
                }
                RecordBatchSink::Write {
                    output_path,
                    output_file_type,
                    json_pretty,
                    progress,
                } => {
                    let mut source =
                        orc_source_after_select_and_slice(input_path.clone(), select, slice)
                            .await?;

                    let reader = source.get().await?;
                    if let Some(pb) = progress {
                        let mut wrapped = ProgressRecordBatchReader {
                            inner: reader,
                            progress: pb,
                        };
                        write_record_batches_from_reader(
                            &mut wrapped,
                            output_path.as_str(),
                            output_file_type,
                            sparse,
                            json_pretty,
                        )?;
                    } else {
                        let mut reader = reader;
                        write_record_batches_from_reader(
                            &mut *reader,
                            output_path.as_str(),
                            output_file_type,
                            sparse,
                            json_pretty,
                        )?;
                    }
                    Ok::<(), Error>(())
                }
                RecordBatchSink::Display {
                    output_format,
                    csv_stdout_headers,
                } => {
                    let source =
                        orc_source_after_select_and_slice(input_path.clone(), select, slice)
                            .await?;

                    apply_select_and_display(
                        source,
                        None,
                        output_format,
                        sparse,
                        csv_stdout_headers,
                    )
                    .await?;
                    Ok::<(), Error>(())
                }
            }
        };

        block_on_pipeline_future(fut)
    }
}

/// Per-format sink adapter for writing record batches.
pub trait BatchWriteSink {
    fn write_batch(&mut self, batch: &RecordBatch) -> crate::Result<()>;
    fn finish(self) -> crate::Result<()>;
}

/// Shared harness for batch-oriented file writers.
pub fn write_record_batches_with_sink<S, BuildSink>(
    path: &str,
    reader: &mut dyn RecordBatchReader,
    build_sink: BuildSink,
) -> crate::Result<()>
where
    S: BatchWriteSink,
    BuildSink: FnOnce(&str, SchemaRef) -> crate::Result<S>,
{
    let schema = reader.schema();
    let mut sink = build_sink(path, schema)?;

    for batch in reader {
        let batch = batch.map_err(Error::ArrowError)?;
        sink.write_batch(&batch)?;
    }

    sink.finish()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::FileType;
    use crate::pipeline::ColumnSpec;
    use crate::pipeline::RecordBatchReaderSource;
    use crate::pipeline::SelectItem;
    use crate::pipeline::SelectSpec;
    use crate::pipeline::parquet::RecordBatchParquetReader;
    use crate::pipeline::read::ReadArgs;

    #[test]
    fn test_parse_select_step_none() {
        assert!(parse_select_step(None).is_none());
    }

    #[test]
    fn test_parse_select_step_some() {
        let select = SelectSpec::from_cli_args(&Some(vec!["one".to_string(), "two".to_string()]));
        let step = parse_select_step(select).expect("should return some");
        assert_eq!(step.select.len(), 2);
        assert_eq!(
            step.select[0],
            SelectItem::Column(ColumnSpec::Exact("one".into()))
        );
        assert_eq!(
            step.select[1],
            SelectItem::Column(ColumnSpec::Exact("two".into()))
        );
    }

    #[test]
    fn test_parse_select_step_comma_separated() {
        let select = SelectSpec::from_cli_args(&Some(vec!["one, two".to_string()]));
        let step = parse_select_step(select).expect("should return some");
        assert_eq!(step.select.len(), 2);
        assert_eq!(
            step.select[0],
            SelectItem::Column(ColumnSpec::Exact("one".into()))
        );
        assert_eq!(
            step.select[1],
            SelectItem::Column(ColumnSpec::Exact("two".into()))
        );
    }

    #[test]
    fn test_parse_select_step_empty_returns_none() {
        let select = SelectSpec::from_cli_args(&Some(vec!["  ,  ".to_string()]));
        assert!(parse_select_step(select).is_none());
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn test_select_columns() {
        // Use the parquet reader to inspect the file and verify column selection
        let args = ReadArgs::new("fixtures/table.parquet", FileType::Parquet);
        let parquet_step = RecordBatchParquetReader { args };

        let source: RecordBatchReaderSource = Box::new(parquet_step);
        let select_step = RecordBatchSelect {
            select: SelectSpec {
                columns: vec![
                    SelectItem::Column(ColumnSpec::Exact("two".to_string())),
                    SelectItem::Column(ColumnSpec::Exact("four".to_string())),
                ],
                group_by: None,
            },
        };
        let mut projected_source = select_step
            .execute(source)
            .await
            .expect("Failed to execute select columns");
        let mut projected_reader = projected_source
            .get()
            .await
            .expect("Failed to get record batch reader");

        // 1. Check Schema
        let projected_schema = projected_reader.schema();
        assert_eq!(projected_schema.fields().len(), 2);
        assert_eq!(projected_schema.field(0).name(), "two");
        assert_eq!(projected_schema.field(1).name(), "four");

        // 2. Check Data
        let batch_result = projected_reader.next().unwrap();
        let projected_batch = batch_result.unwrap();
        let batch_rows = projected_batch.num_rows();

        assert_eq!(projected_batch.num_columns(), 2);
        assert_eq!(projected_batch.column(0).len(), batch_rows);
        assert_eq!(projected_batch.column(1).len(), batch_rows);
    }
}