-
Notifications
You must be signed in to change notification settings - Fork 189
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: init file writer interface (#168)
* init file writer interface * refine --------- Co-authored-by: ZENOTME <[email protected]>
- Loading branch information
Showing
3 changed files
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -51,3 +51,5 @@ mod scan; | |
pub mod expr; | ||
pub mod transaction; | ||
pub mod transform; | ||
|
||
pub mod writer; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
// Licensed to the Apache Software Foundation (ASF) under one | ||
// or more contributor license agreements. See the NOTICE file | ||
// distributed with this work for additional information | ||
// regarding copyright ownership. The ASF licenses this file | ||
// to you 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. | ||
|
||
//! This module contains the writer for data file format supported by iceberg: parquet, orc. | ||
use super::{CurrentFileStatus, DefaultOutput}; | ||
use crate::Result; | ||
use arrow_array::RecordBatch; | ||
use futures::Future; | ||
|
||
/// File writer builder trait. | ||
pub trait FileWriterBuilder<O = DefaultOutput>: Send + Clone + 'static { | ||
/// The associated file writer type. | ||
type R: FileWriter<O>; | ||
/// Build file writer. | ||
fn build(self) -> impl Future<Output = Result<Self::R>> + Send; | ||
} | ||
|
||
/// File writer focus on writing record batch to different physical file format.(Such as parquet. orc) | ||
pub trait FileWriter<O = DefaultOutput>: Send + CurrentFileStatus + 'static { | ||
/// Write record batch to file. | ||
fn write(&mut self, batch: &RecordBatch) -> impl Future<Output = Result<()>> + Send; | ||
/// Close file writer. | ||
fn close(self) -> impl Future<Output = Result<O>> + Send; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
// Licensed to the Apache Software Foundation (ASF) under one | ||
// or more contributor license agreements. See the NOTICE file | ||
// distributed with this work for additional information | ||
// regarding copyright ownership. The ASF licenses this file | ||
// to you 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. | ||
|
||
//! The iceberg writer module. | ||
use crate::spec::DataFileBuilder; | ||
|
||
pub mod file_writer; | ||
|
||
type DefaultOutput = Vec<DataFileBuilder>; | ||
|
||
/// The current file status of iceberg writer. It implement for the writer which write a single | ||
/// file. | ||
pub trait CurrentFileStatus { | ||
/// Get the current file path. | ||
fn current_file_path(&self) -> String; | ||
/// Get the current file row number. | ||
fn current_row_num(&self) -> usize; | ||
/// Get the current file written size. | ||
fn current_written_size(&self) -> usize; | ||
} |