Docs.rs
  • datafusion-datasource-48.0.0
    • datafusion-datasource 48.0.0
    • Permalink
    • Docs.rs crate page
    • Apache-2.0
    • Links
    • Homepage
    • Repository
    • crates.io
    • Source
    • Owners
    • andygrove
    • alamb
    • xudong963
    • Dependencies
      • arrow ^55.1.0 normal
      • async-compression ^0.4.19 normal optional
      • async-trait ^0.1.88 normal
      • bytes ^1.10 normal
      • bzip2 ^0.5.2 normal optional
      • chrono ^0.4.41 normal
      • datafusion-common ^48.0.0 normal
      • datafusion-common-runtime ^48.0.0 normal
      • datafusion-execution ^48.0.0 normal
      • datafusion-expr ^48.0.0 normal
      • datafusion-physical-expr ^48.0.0 normal
      • datafusion-physical-expr-common ^48.0.0 normal
      • datafusion-physical-plan ^48.0.0 normal
      • datafusion-session ^48.0.0 normal
      • flate2 ^1.1.1 normal optional
      • futures ^0.3 normal
      • glob ^0.3.0 normal
      • itertools ^0.14 normal
      • log ^0.4 normal
      • object_store ^0.12.0 normal
      • parquet ^55.1.0 normal optional
      • rand ^0.9 normal
      • tempfile ^3 normal optional
      • tokio ^1.45 normal
      • tokio-util ^0.7.15 normal optional
      • url ^2.5.4 normal
      • xz2 ^0.1 normal optional
      • zstd ^0.13 normal optional
      • criterion ^0.5.1 dev
      • tempfile ^3 dev
    • Versions
    • 88.02% of the crate is documented
  • Platform
    • i686-unknown-linux-gnu
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate datafusion_datasource

logo

datafusion_datasource48.0.0

  • All Items

Crate Items

  • Re-exports
  • Modules
  • Structs
  • Enums
  • Functions
  • Type Aliases

Crates

  • datafusion_datasource

Crate datafusion_datasource

Source
Expand description

A table that uses the ObjectStore listing capability to get the list of files to process.

Re-exports§

pub use self::file::as_file_source;
pub use self::url::ListingTableUrl;

Modules§

decoder
Module containing helper methods for the various file formats See write.rs for write related helper methods
display
file
Common behaviors that every file format needs to implement
file_compression_type
File Compression type abstraction
file_format
Module containing helper methods for the various file formats See write.rs for write related helper methods
file_groups
Logic for managing groups of PartitionedFiles in DataFusion
file_meta
file_scan_config
FileScanConfig to configure scanning of possibly partitioned file sources.
file_sink_config
file_stream
A generic stream over file format readers that can be used by any file format that read its files from start to end.
memory
schema_adapter
SchemaAdapter and SchemaAdapterFactory to adapt file-level record batches to a table schema.
sink
Execution plan for writing data to DataSinks
source
DataSource and DataSourceExec
url
write
Module containing helper methods/traits related to enabling write support for the various file formats

Structs§

FileRange
Only scan a subset of Row Groups from the Parquet file whose data “midpoint” lies within the [start, end) byte offsets. This option can be used to scan non-overlapping sections of a Parquet file in parallel.
PartitionedFile
A single file or part of a file that should be read, along with its schema, statistics and partition column values that need to be appended to each row.

Enums§

RangeCalculation
Represents the possible outcomes of a range calculation.

Functions§

add_row_statsDeprecated
calculate_range
Calculates an appropriate byte range for reading from an object based on the provided metadata.
compute_all_files_statistics
Computes statistics for all files across multiple file groups.
generate_test_files
Generates test files with min-max statistics in different overlap patterns.
verify_sort_integrity
Used by tests and benchmarks

Type Aliases§

PartitionedFileStream
Stream of files get listed from object store

Results

Settings
Help
    trait
    datafusion_datasource::file::FileSource
    file format specific behaviors for elements in DataSource
    trait method
    datafusion_datasource::file_format::FileFormat::file_source
    Return the related FileSource such as CsvSource, JsonSource…
    method
    datafusion_datasource::file_scan_config::FileScanConfig::file_source
    Returns the file_source
    struct field
    datafusion_datasource::file_scan_config::FileScanConfig::file_source
    File source such as ParquetSource, CsvSource, JsonSource, …
    function
    datafusion_datasource::file::as_file_source
    Helper function to convert any type implementing …
    method
    datafusion_datasource::source::DataSourceExec::downcast_to_file_source
    Downcast the DataSourceExec’s data_source to a specific …
    trait method
    datafusion_datasource::file::FileSource::as_any
    &FileSource -> &Any
    Any
    trait method
    datafusion_datasource::file::FileSource::metrics
    &FileSource -> &ExecutionPlanMetricsSet
    Return execution plan metrics
    trait method
    datafusion_datasource::file::FileSource::file_type
    &FileSource -> &str
    String representation of file source such as “csv”, “…
    trait method
    datafusion_datasource::file::FileSource::statistics
    &FileSource -> Result<Statistics>
    Return projected statistics
    method
    datafusion_datasource::file_scan_config::FileScanConfigBuilder::with_source
    FileScanConfigBuilder, Arc<FileSource> -> FileScanConfigBuilder
    Set the file source for scanning files.
    function
    datafusion_datasource::file::as_file_source
    T -> Arc<FileSource>
    where
    T: FileSource
    Helper function to convert any type implementing …
    method
    datafusion_datasource::file_scan_config::FileScanConfig::with_source
    FileScanConfig, Arc<FileSource> -> FileScanConfig
    Set the file source
    method
    datafusion_datasource::file_scan_config::FileScanConfig::new
    ObjectStoreUrl, SchemaRef, Arc<FileSource> -> FileScanConfig
    Create a new FileScanConfig with default settings for …
    method
    datafusion_datasource::file_scan_config::FileScanConfigBuilder::new
    ObjectStoreUrl, SchemaRef, Arc<FileSource> -> FileScanConfigBuilder
    Create a new FileScanConfigBuilder with default settings …
    trait method
    datafusion_datasource::file::FileSource::with_schema
    &FileSource, SchemaRef -> Arc<FileSource>
    Initialize new instance with a new schema
    trait method
    datafusion_datasource::file::FileSource::with_batch_size
    &FileSource, usize -> Arc<FileSource>
    Initialize new type with batch size configuration
    trait method
    datafusion_datasource::file::FileSource::with_statistics
    &FileSource, Statistics -> Arc<FileSource>
    Initialize new instance with projected statistics
    method
    datafusion_datasource::file::FileSource::schema_adapter_factory
    &FileSource -> Option<Arc<SchemaAdapterFactory>>
    Returns the current schema adapter factory if set
    trait method
    datafusion_datasource::file::FileSource::with_projection
    &FileSource, &FileScanConfig -> Arc<FileSource>
    Initialize new instance with projection information
    method
    datafusion_datasource::file::FileSource::fmt_extra
    &FileSource, DisplayFormatType, &mut Formatter -> Result
    Format FileType specific information
    method
    datafusion_datasource::file::FileSource::with_schema_adapter_factory
    &FileSource, Arc<SchemaAdapterFactory> -> Result<Arc<FileSource>>
    Set optional schema adapter factory.
    trait method
    datafusion_datasource::file::FileSource::create_file_opener
    &FileSource, Arc<ObjectStore>, &FileScanConfig, usize -> Arc<FileOpener>
    Creates a dyn FileOpener based on given parameters
    method
    datafusion_datasource::file::FileSource::repartitioned
    &FileSource, usize, usize, Option<LexOrdering>, &FileScanConfig -> Result<Option<FileScanConfig>>
    If supported by the FileSource, redistribute files across …
    method
    datafusion_datasource::file::FileSource::try_pushdown_filters
    &FileSource, Vec<Arc<PhysicalExpr>>, &ConfigOptions -> Result<FilterPushdownPropagation<Arc<FileSource>>>
    Try to push down filters into this FileSource. See …
    trait method
    datafusion_datasource::file_format::FileFormat::file_source
    &FileFormat -> Arc<FileSource>
    Return the related FileSource such as CsvSource, JsonSource…
    method
    datafusion_datasource::file_scan_config::FileScanConfig::file_source
    &FileScanConfig -> &Arc<FileSource>
    Returns the file_source
    function
    datafusion_datasource::file::as_file_source
    T -> Arc<FileSource>
    Helper function to convert any type implementing …
    trait method
    datafusion_datasource::file::FileSource::with_schema
    &FileSource, SchemaRef -> Arc<FileSource>
    Initialize new instance with a new schema
    trait method
    datafusion_datasource::file::FileSource::with_batch_size
    &FileSource, usize -> Arc<FileSource>
    Initialize new type with batch size configuration
    trait method
    datafusion_datasource::file::FileSource::with_statistics
    &FileSource, Statistics -> Arc<FileSource>
    Initialize new instance with projected statistics
    trait method
    datafusion_datasource::file::FileSource::with_projection
    &FileSource, &FileScanConfig -> Arc<FileSource>
    Initialize new instance with projection information