risingwave_connector/sink/file_sink/
azblob.rs

1// Copyright 2025 RisingWave Labs
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.
14use std::collections::{BTreeMap, HashMap};
15
16use anyhow::anyhow;
17use opendal::Operator;
18use opendal::layers::{LoggingLayer, RetryLayer};
19use opendal::services::Azblob;
20use serde::Deserialize;
21use serde_with::serde_as;
22use with_options::WithOptions;
23
24use super::opendal_sink::{BatchingStrategy, FileSink};
25use crate::sink::file_sink::opendal_sink::OpendalSinkBackend;
26use crate::sink::{Result, SINK_TYPE_APPEND_ONLY, SINK_TYPE_OPTION, SINK_TYPE_UPSERT, SinkError};
27use crate::source::UnknownFields;
28#[derive(Deserialize, Debug, Clone, WithOptions)]
29pub struct AzblobCommon {
30    #[serde(rename = "azblob.container_name")]
31    pub container_name: String,
32    /// The directory where the sink file is located.
33    #[serde(rename = "azblob.path")]
34    pub path: String,
35    #[serde(rename = "azblob.credentials.account_name", default)]
36    pub account_name: Option<String>,
37    #[serde(rename = "azblob.credentials.account_key", default)]
38    pub account_key: Option<String>,
39    #[serde(rename = "azblob.endpoint_url")]
40    pub endpoint_url: String,
41}
42
43#[serde_as]
44#[derive(Clone, Debug, Deserialize, WithOptions)]
45pub struct AzblobConfig {
46    #[serde(flatten)]
47    pub common: AzblobCommon,
48
49    #[serde(flatten)]
50    pub batching_strategy: BatchingStrategy,
51
52    pub r#type: String, // accept "append-only"
53
54    #[serde(flatten)]
55    pub unknown_fields: HashMap<String, String>,
56}
57
58pub const AZBLOB_SINK: &str = "azblob";
59
60impl<S: OpendalSinkBackend> FileSink<S> {
61    pub fn new_azblob_sink(config: AzblobConfig) -> Result<Operator> {
62        // Create azblob builder.
63        let mut builder = Azblob::default();
64        builder = builder
65            .container(&config.common.container_name)
66            .endpoint(&config.common.endpoint_url);
67
68        if let Some(account_name) = config.common.account_name {
69            builder = builder.account_name(&account_name);
70        } else {
71            tracing::warn!(
72                "account_name azblob is not set, container  {}",
73                config.common.container_name
74            );
75        }
76
77        if let Some(account_key) = config.common.account_key {
78            builder = builder.account_key(&account_key);
79        } else {
80            tracing::warn!(
81                "account_key azblob is not set, container  {}",
82                config.common.container_name
83            );
84        }
85        let operator: Operator = Operator::new(builder)?
86            .layer(LoggingLayer::default())
87            .layer(RetryLayer::default())
88            .finish();
89
90        Ok(operator)
91    }
92}
93
94#[derive(Debug, Clone, Copy, PartialEq, Eq)]
95pub struct AzblobSink;
96
97impl UnknownFields for AzblobConfig {
98    fn unknown_fields(&self) -> HashMap<String, String> {
99        self.unknown_fields.clone()
100    }
101}
102
103impl OpendalSinkBackend for AzblobSink {
104    type Properties = AzblobConfig;
105
106    const SINK_NAME: &'static str = AZBLOB_SINK;
107
108    fn from_btreemap(btree_map: BTreeMap<String, String>) -> Result<Self::Properties> {
109        let config =
110            serde_json::from_value::<AzblobConfig>(serde_json::to_value(btree_map).unwrap())
111                .map_err(|e| SinkError::Config(anyhow!(e)))?;
112        if config.r#type != SINK_TYPE_APPEND_ONLY && config.r#type != SINK_TYPE_UPSERT {
113            return Err(SinkError::Config(anyhow!(
114                "`{}` must be {}, or {}",
115                SINK_TYPE_OPTION,
116                SINK_TYPE_APPEND_ONLY,
117                SINK_TYPE_UPSERT
118            )));
119        }
120        Ok(config)
121    }
122
123    fn new_operator(properties: AzblobConfig) -> Result<Operator> {
124        FileSink::<AzblobSink>::new_azblob_sink(properties)
125    }
126
127    fn get_path(properties: Self::Properties) -> String {
128        properties.common.path
129    }
130
131    fn get_engine_type() -> super::opendal_sink::EngineType {
132        super::opendal_sink::EngineType::Azblob
133    }
134
135    fn get_batching_strategy(properties: Self::Properties) -> BatchingStrategy {
136        BatchingStrategy {
137            max_row_count: properties.batching_strategy.max_row_count,
138            rollover_seconds: properties.batching_strategy.rollover_seconds,
139            path_partition_prefix: properties.batching_strategy.path_partition_prefix,
140        }
141    }
142}
risingwave_connector/sink/file_sink/azblob.rs

risingwave_connector/sink/file_sink/
azblob.rs
