Struct UnifiedScanArgs
pub struct UnifiedScanArgs {Show 24 fields
pub schema: Option<Arc<Schema<DataType, ()>>>,
pub cloud_options: Option<CloudOptions>,
pub hive_options: HiveOptions,
pub rechunk: bool,
pub cache: bool,
pub glob: bool,
pub expand_paths: bool,
pub hidden_file_prefix: Option<Arc<[PlSmallStr]>>,
pub projection: Option<Arc<[PlSmallStr]>>,
pub field_selection: Option<Arc<ScanFieldSelection>>,
pub column_mapping: Option<ColumnMapping>,
pub default_values: Option<DefaultFieldValues>,
pub row_index: Option<RowIndex>,
pub pre_slice: Option<Slice>,
pub cast_columns_policy: CastColumnsPolicy,
pub missing_columns_policy: MissingColumnsPolicy,
pub extra_columns_policy: ExtraColumnsPolicy,
pub include_file_paths: Option<PlSmallStr>,
pub deletion_files: Option<DeletionFilesList>,
pub table_statistics: Option<TableStatistics>,
pub hive_partitions: Option<HivePartitions>,
pub row_count: Option<(u64, u64)>,
pub source_sizes: Option<Buffer<u64>>,
pub resolve_heavy_sources: Option<NonZero<u32>>,
}lazy only.Expand description
Scan arguments shared across different scan types.
Fields§
§schema: Option<Arc<Schema<DataType, ()>>>User-provided schema of the file. Will be inferred during IR conversion if None.
cloud_options: Option<CloudOptions>§hive_options: HiveOptions§rechunk: bool§cache: bool§glob: bool§expand_paths: boolFiles with these prefixes will not be read.
projection: Option<Arc<[PlSmallStr]>>§field_selection: Option<Arc<ScanFieldSelection>>The struct fields to read of the projected columns not read whole. Set by projection
pushdown; output_schema then holds the pruned dtypes.
column_mapping: Option<ColumnMapping>§default_values: Option<DefaultFieldValues>Default values for missing columns.
row_index: Option<RowIndex>§pre_slice: Option<Slice>Slice applied before predicates
cast_columns_policy: CastColumnsPolicy§missing_columns_policy: MissingColumnsPolicy§extra_columns_policy: ExtraColumnsPolicy§include_file_paths: Option<PlSmallStr>§deletion_files: Option<DeletionFilesList>§table_statistics: Option<TableStatistics>§hive_partitions: Option<HivePartitions>Used instead of parsing hive partitions from the source paths.
row_count: Option<(u64, u64)>Stores (physical, deleted) row counts of the table if known upfront (e.g. for Iceberg). This allows for row-count queries to succeed without scanning all files.
Note, intentionally store u64 instead of IdxSize to avoid erroring if it’s unused.
source_sizes: Option<Buffer<u64>>§resolve_heavy_sources: Option<NonZero<u32>>For N partitions, prioritize footers of sources containing at least 1 / N
of the total bytes. Requires known sizes; selects largest first within the budget.
Implementations§
§impl UnifiedScanArgs
impl UnifiedScanArgs
pub fn has_row_index_or_slice(&self) -> bool
Trait Implementations§
§impl Clone for UnifiedScanArgs
impl Clone for UnifiedScanArgs
§fn clone(&self) -> UnifiedScanArgs
fn clone(&self) -> UnifiedScanArgs
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more§impl Debug for UnifiedScanArgs
impl Debug for UnifiedScanArgs
§impl Default for UnifiedScanArgs
impl Default for UnifiedScanArgs
§fn default() -> UnifiedScanArgs
fn default() -> UnifiedScanArgs
§impl<'de> Deserialize<'de> for UnifiedScanArgs
impl<'de> Deserialize<'de> for UnifiedScanArgs
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<UnifiedScanArgs, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<UnifiedScanArgs, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
impl Eq for UnifiedScanArgs
§impl Hash for UnifiedScanArgs
impl Hash for UnifiedScanArgs
§impl PartialEq for UnifiedScanArgs
impl PartialEq for UnifiedScanArgs
§impl Serialize for UnifiedScanArgs
impl Serialize for UnifiedScanArgs
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl StructuralPartialEq for UnifiedScanArgs
Auto Trait Implementations§
impl !RefUnwindSafe for UnifiedScanArgs
impl !UnwindSafe for UnifiedScanArgs
impl Freeze for UnifiedScanArgs
impl Send for UnifiedScanArgs
impl Sync for UnifiedScanArgs
impl Unpin for UnifiedScanArgs
impl UnsafeUnpin for UnifiedScanArgs
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> 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