risingwave_frontend/optimizer/plan_node/
batch_file_scan.rs

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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
// Copyright 2025 RisingWave Labs
//
// 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 pretty_xmlish::XmlNode;
use risingwave_pb::batch_plan::file_scan_node::{FileFormat, StorageType};
use risingwave_pb::batch_plan::plan_node::NodeBody;
use risingwave_pb::batch_plan::{AzblobFileScanNode, FileScanNode, GcsFileScanNode};

use super::batch::prelude::*;
use super::utils::{childless_record, column_names_pretty, Distill};
use super::{
    generic, ExprRewritable, PlanBase, PlanRef, ToBatchPb, ToDistributedBatch, ToLocalBatch,
};
use crate::error::Result;
use crate::optimizer::plan_node::expr_visitable::ExprVisitable;
use crate::optimizer::property::{Distribution, Order};

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct BatchFileScan {
    pub base: PlanBase<Batch>,
    pub core: generic::FileScanBackend,
}

impl BatchFileScan {
    pub fn new(core: generic::FileScanBackend) -> Self {
        let base = PlanBase::new_batch_with_core(&core, Distribution::Single, Order::any());

        Self { base, core }
    }

    pub fn column_names(&self) -> Vec<&str> {
        self.schema().names_str()
    }

    pub fn clone_with_dist(&self) -> Self {
        let base = self
            .base
            .clone_with_new_distribution(Distribution::SomeShard);
        Self {
            base,
            core: self.core.clone(),
        }
    }
}

impl_plan_tree_node_for_leaf! { BatchFileScan }

impl Distill for BatchFileScan {
    fn distill<'a>(&self) -> XmlNode<'a> {
        let fields = vec![("columns", column_names_pretty(self.schema()))];
        childless_record("BatchFileScan", fields)
    }
}

impl ToLocalBatch for BatchFileScan {
    fn to_local(&self) -> Result<PlanRef> {
        Ok(self.clone_with_dist().into())
    }
}

impl ToDistributedBatch for BatchFileScan {
    fn to_distributed(&self) -> Result<PlanRef> {
        Ok(self.clone_with_dist().into())
    }
}

impl ToBatchPb for BatchFileScan {
    fn to_batch_prost_body(&self) -> NodeBody {
        match &self.core {
            generic::FileScanBackend::FileScan(file_scan) => NodeBody::FileScan(FileScanNode {
                columns: file_scan
                    .columns()
                    .into_iter()
                    .map(|col| col.to_protobuf())
                    .collect(),
                file_format: match file_scan.file_format {
                    generic::FileFormat::Parquet => FileFormat::Parquet as i32,
                },
                storage_type: StorageType::S3 as i32,

                s3_region: file_scan.s3_region.clone(),
                s3_access_key: file_scan.s3_access_key.clone(),
                s3_secret_key: file_scan.s3_secret_key.clone(),
                file_location: file_scan.file_location.clone(),
                s3_endpoint: file_scan.s3_endpoint.clone(),
            }),
            generic::FileScanBackend::GcsFileScan(gcs_file_scan) => {
                NodeBody::GcsFileScan(GcsFileScanNode {
                    columns: gcs_file_scan
                        .columns()
                        .into_iter()
                        .map(|col| col.to_protobuf())
                        .collect(),
                    file_format: match gcs_file_scan.file_format {
                        generic::FileFormat::Parquet => FileFormat::Parquet as i32,
                    },
                    credential: gcs_file_scan.credential.clone(),
                    file_location: gcs_file_scan.file_location.clone(),
                })
            }

            generic::FileScanBackend::AzblobFileScan(azblob_file_scan) => {
                NodeBody::AzblobFileScan(AzblobFileScanNode {
                    columns: azblob_file_scan
                        .columns()
                        .into_iter()
                        .map(|col| col.to_protobuf())
                        .collect(),
                    file_format: match azblob_file_scan.file_format {
                        generic::FileFormat::Parquet => FileFormat::Parquet as i32,
                    },
                    account_name: azblob_file_scan.account_name.clone(),
                    account_key: azblob_file_scan.account_key.clone(),
                    endpoint: azblob_file_scan.endpoint.clone(),
                    file_location: azblob_file_scan.file_location.clone(),
                })
            }
        }
    }
}

impl ExprRewritable for BatchFileScan {}

impl ExprVisitable for BatchFileScan {}