Skip to content

User guide

APIs

API Returns Best for
scan_avro() LazyFrame Query optimization, large files
read_avro() DataFrame Simple eager loading
AvroReader Iterator Streaming, progress tracking
MultiAvroReader Iterator Multi-file streaming control

All APIs share the same Rust core and support local files and S3.

Topics

  • Data sources — Paths, S3 configuration, supported codecs
  • Query optimization — Projection pushdown, predicate pushdown, early stopping
  • Streaming — Memory-efficient batch processing, buffer tuning
  • Error handling — Strict vs skip mode, error inspection
  • Schemas — Type mapping, schema inspection