-
Notifications
You must be signed in to change notification settings - Fork 591
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(sink): introduce file sink in PARQUET format (#17311)
Co-authored-by: William Wen <william123.wen@gmail.com>
- Loading branch information
Showing
19 changed files
with
943 additions
and
25 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
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
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
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
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
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
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,102 @@ | ||
// Copyright 2024 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 std::collections::{BTreeMap, HashMap}; | ||
|
||
use anyhow::anyhow; | ||
use opendal::layers::{LoggingLayer, RetryLayer}; | ||
use opendal::services::Fs; | ||
use opendal::Operator; | ||
use serde::Deserialize; | ||
use serde_with::serde_as; | ||
use with_options::WithOptions; | ||
|
||
use crate::sink::file_sink::opendal_sink::{FileSink, OpendalSinkBackend}; | ||
use crate::sink::{Result, SinkError, SINK_TYPE_APPEND_ONLY, SINK_TYPE_OPTION, SINK_TYPE_UPSERT}; | ||
use crate::source::UnknownFields; | ||
|
||
#[derive(Deserialize, Debug, Clone, WithOptions)] | ||
pub struct FsCommon { | ||
/// The directory where the sink file is located. | ||
#[serde(rename = "fs.path")] | ||
pub path: String, | ||
} | ||
|
||
#[serde_as] | ||
#[derive(Clone, Debug, Deserialize, WithOptions)] | ||
pub struct FsConfig { | ||
#[serde(flatten)] | ||
pub common: FsCommon, | ||
|
||
pub r#type: String, // accept "append-only" | ||
|
||
#[serde(flatten)] | ||
pub unknown_fields: HashMap<String, String>, | ||
} | ||
|
||
impl UnknownFields for FsConfig { | ||
fn unknown_fields(&self) -> HashMap<String, String> { | ||
self.unknown_fields.clone() | ||
} | ||
} | ||
|
||
pub const FS_SINK: &str = "fs"; | ||
|
||
impl<S: OpendalSinkBackend> FileSink<S> { | ||
pub fn new_fs_sink(config: FsConfig) -> Result<Operator> { | ||
// Create fs builder. | ||
let mut builder = Fs::default(); | ||
// Create fs backend builder. | ||
builder.root(&config.common.path); | ||
let operator: Operator = Operator::new(builder)? | ||
.layer(LoggingLayer::default()) | ||
.layer(RetryLayer::default()) | ||
.finish(); | ||
Ok(operator) | ||
} | ||
} | ||
|
||
#[derive(Debug, Clone, Copy, PartialEq, Eq)] | ||
pub struct FsSink; | ||
|
||
impl OpendalSinkBackend for FsSink { | ||
type Properties = FsConfig; | ||
|
||
const SINK_NAME: &'static str = FS_SINK; | ||
|
||
fn from_btreemap(btree_map: BTreeMap<String, String>) -> Result<Self::Properties> { | ||
let config = serde_json::from_value::<FsConfig>(serde_json::to_value(btree_map).unwrap()) | ||
.map_err(|e| SinkError::Config(anyhow!(e)))?; | ||
if config.r#type != SINK_TYPE_APPEND_ONLY && config.r#type != SINK_TYPE_UPSERT { | ||
return Err(SinkError::Config(anyhow!( | ||
"`{}` must be {}, or {}", | ||
SINK_TYPE_OPTION, | ||
SINK_TYPE_APPEND_ONLY, | ||
SINK_TYPE_UPSERT | ||
))); | ||
} | ||
Ok(config) | ||
} | ||
|
||
fn new_operator(properties: FsConfig) -> Result<Operator> { | ||
FileSink::<FsSink>::new_fs_sink(properties) | ||
} | ||
|
||
fn get_path(properties: Self::Properties) -> String { | ||
properties.common.path | ||
} | ||
|
||
fn get_engine_type() -> super::opendal_sink::EngineType { | ||
super::opendal_sink::EngineType::Fs | ||
} | ||
} |
Oops, something went wrong.