exon 0.32.4

A platform for scientific data processing and analysis.
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

// Copyright 2023 WHERE TRUE Technologies.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::sync::Arc;

use arrow::datatypes::{Field, SchemaRef};
use datafusion::{
    datasource::{listing::PartitionedFile, physical_plan::FileScanConfig},
    execution::object_store::ObjectStoreUrl,
    physical_expr::LexOrdering,
    physical_plan::Statistics,
};

/// A builder for `FileScanConfig`.
pub struct FileScanConfigBuilder {
    object_store_url: ObjectStoreUrl,
    file_schema: SchemaRef,
    file_groups: Vec<Vec<PartitionedFile>>,
    statistics: Statistics,
    projection: Option<Vec<usize>>,
    limit: Option<usize>,
    output_ordering: Vec<LexOrdering>,
    table_partition_cols: Vec<Field>,
}

impl FileScanConfigBuilder {
    /// Create a new builder.
    pub fn new(
        object_store_url: ObjectStoreUrl,
        file_schema: SchemaRef,
        file_groups: Vec<Vec<PartitionedFile>>,
    ) -> Self {
        let statistics = Statistics::new_unknown(&Arc::clone(&file_schema));

        Self {
            object_store_url,
            file_schema,
            file_groups,
            statistics,
            projection: None,
            limit: None,
            output_ordering: Vec::new(),
            table_partition_cols: Vec::new(),
        }
    }

    /// Set the projection from an Option.
    pub fn projection_option(mut self, projection: Option<Vec<usize>>) -> Self {
        self.projection = projection;
        self
    }

    /// Set from the limit from an Option.
    pub fn limit_option(mut self, limit: Option<usize>) -> Self {
        self.limit = limit;
        self
    }

    /// Set the table partition columns.
    pub fn table_partition_cols(mut self, table_partition_cols: Vec<Field>) -> Self {
        self.table_partition_cols = table_partition_cols;
        self
    }

    /// Build a `FileScanConfig` from the current state of the builder.
    pub fn build(self) -> FileScanConfig {
        FileScanConfig {
            object_store_url: self.object_store_url,
            file_schema: self.file_schema,
            file_groups: self.file_groups,
            statistics: self.statistics,
            projection: self.projection,
            limit: self.limit,
            output_ordering: self.output_ordering,
            table_partition_cols: self.table_partition_cols,
        }
    }
}