pub struct FileReaderBuilder { /* private fields */ }
Expand description
Build an Arrow FileReader
with custom options.
Implementations§
source§impl FileReaderBuilder
impl FileReaderBuilder
sourcepub fn new() -> FileReaderBuilder
pub fn new() -> FileReaderBuilder
Options for creating a new FileReader
.
To convert a builder into a reader, call FileReaderBuilder::build
.
sourcepub fn with_projection(self, projection: Vec<usize>) -> FileReaderBuilder
pub fn with_projection(self, projection: Vec<usize>) -> FileReaderBuilder
Optional projection for which columns to load (zero-based column indices).
Flatbuffers option for parsing the footer. Controls the max number of fields and metadata key-value pairs that can be parsed from the schema of the footer.
By default this is set to 1_000_000
which roughly translates to a schema with
no metadata key-value pairs but 499,999 fields.
This default limit is enforced to protect against malicious files with a massive amount of flatbuffer tables which could cause a denial of service attack.
If you need to ingest a trusted file with a massive number of fields and/or
metadata key-value pairs and are facing the error "Unable to get root as footer: TooManyTables"
then increase this parameter as necessary.
Flatbuffers option for parsing the footer. Controls the max depth for schemas with nested fields parsed from the footer.
By default this is set to 64
which roughly translates to a schema with
a field nested 60 levels down through other struct fields.
This default limit is enforced to protect against malicious files with a extremely deep flatbuffer structure which could cause a denial of service attack.
If you need to ingest a trusted file with a deeply nested field and are facing the
error "Unable to get root as footer: DepthLimitReached"
then increase this
parameter as necessary.
sourcepub fn build<R>(self, reader: R) -> Result<FileReader<R>, ArrowError>
pub fn build<R>(self, reader: R) -> Result<FileReader<R>, ArrowError>
Build FileReader
with given reader.
Trait Implementations§
source§impl Debug for FileReaderBuilder
impl Debug for FileReaderBuilder
source§impl Default for FileReaderBuilder
impl Default for FileReaderBuilder
source§fn default() -> FileReaderBuilder
fn default() -> FileReaderBuilder
Auto Trait Implementations§
impl Freeze for FileReaderBuilder
impl RefUnwindSafe for FileReaderBuilder
impl Send for FileReaderBuilder
impl Sync for FileReaderBuilder
impl Unpin for FileReaderBuilder
impl UnwindSafe for FileReaderBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more