risingwave_connector/source/mqtt/
mod.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.
14
15pub mod enumerator;
16pub mod source;
17pub use enumerator::MqttSplitEnumerator;
18pub mod split;
19
20use std::collections::HashMap;
21use std::fmt::{Display, Formatter};
22
23use serde_derive::Deserialize;
24use serde_with::{DisplayFromStr, serde_as};
25use thiserror::Error;
26use with_options::WithOptions;
27
28use crate::connector_common::{MqttCommon, MqttQualityOfService};
29use crate::source::SourceProperties;
30use crate::source::mqtt::source::{MqttSplit, MqttSplitReader};
31
32pub const MQTT_CONNECTOR: &str = "mqtt";
33
34#[derive(Debug, Clone, Error)]
35pub struct MqttError(String);
36
37impl Display for MqttError {
38    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
39        write!(f, "{}", self.0)
40    }
41}
42
43#[serde_as]
44#[derive(Clone, Debug, Deserialize, WithOptions)]
45pub struct MqttProperties {
46    #[serde(flatten)]
47    pub common: MqttCommon,
48
49    /// The topic name to subscribe or publish to. When subscribing, it can be a wildcard topic. e.g /topic/#
50    pub topic: String,
51
52    /// The quality of service to use when publishing messages. Defaults to at_most_once.
53    /// Could be at_most_once, at_least_once or exactly_once
54    #[serde_as(as = "Option<DisplayFromStr>")]
55    pub qos: Option<MqttQualityOfService>,
56
57    #[serde(flatten)]
58    pub unknown_fields: HashMap<String, String>,
59}
60
61impl SourceProperties for MqttProperties {
62    type Split = MqttSplit;
63    type SplitEnumerator = MqttSplitEnumerator;
64    type SplitReader = MqttSplitReader;
65
66    const SOURCE_NAME: &'static str = MQTT_CONNECTOR;
67}
68
69impl crate::source::UnknownFields for MqttProperties {
70    fn unknown_fields(&self) -> HashMap<String, String> {
71        self.unknown_fields.clone()
72    }
73}
risingwave_connector/source/mqtt/mod.rs

risingwave_connector/source/mqtt/
mod.rs
