store_api/
data_source.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::sync::Arc;
16
17use common_error::ext::BoxedError;
18use common_recordbatch::SendableRecordBatchStream;
19use datafusion_physical_plan::ExecutionPlan;
20
21use crate::storage::ScanRequest;
22
23/// This trait represents a common data source abstraction which provides an interface
24/// for retrieving data in the form of a stream of record batches.
25pub trait DataSource {
26    /// Retrieves a stream of record batches based on the provided scan request.
27    fn get_stream(&self, request: ScanRequest) -> Result<SendableRecordBatchStream, BoxedError>;
28
29    /// Builds a physical plan for the scan request if the data source needs to
30    /// expose its execution semantics to DataFusion.
31    fn get_physical_plan(
32        &self,
33        _request: ScanRequest,
34    ) -> Result<Option<Arc<dyn ExecutionPlan>>, BoxedError> {
35        Ok(None)
36    }
37}
38
39pub type DataSourceRef = Arc<dyn DataSource + Send + Sync>;
store_api/data_source.rs

store_api/
data_source.rs
