risingwave_connector/source/kinesis/
split.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
15use risingwave_common::types::JsonbVal;
16use serde::{Deserialize, Serialize};
17
18use crate::error::ConnectorResult;
19use crate::source::{SplitId, SplitMetaData};
20
21/// See <https://docs.aws.amazon.com/kinesis/latest/APIReference/API_StartingPosition.html> for more details.
22#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize, Hash)]
23pub enum KinesisOffset {
24    /// Corresponds to `TRIM_HORIZON`. Points the oldest record in the shard.
25    Earliest,
26    /// Corresponds to `LATEST`. Points to the (still-nonexisting) record just after the most recent one in the shard.
27    Latest,
28    /// Corresponds to `AFTER_SEQUENCE_NUMBER`. Points the record just after the one with the given sequence number.
29    #[serde(alias = "SequenceNumber")] // for backward compatibility
30    AfterSequenceNumber(String),
31    /// Corresponds to `AT_TIMESTAMP`. Points to the (first) record right at or after the given timestamp.
32    Timestamp(i64),
33
34    None,
35}
36
37#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Hash)]
38pub struct KinesisSplit {
39    pub(crate) shard_id: SplitId,
40
41    #[serde(alias = "start_position")] // for backward compatibility
42    pub(crate) next_offset: KinesisOffset,
43    #[serde(alias = "end_position")] // for backward compatibility
44    pub(crate) end_offset: KinesisOffset,
45}
46
47impl SplitMetaData for KinesisSplit {
48    fn id(&self) -> SplitId {
49        self.shard_id.clone()
50    }
51
52    fn restore_from_json(value: JsonbVal) -> ConnectorResult<Self> {
53        serde_json::from_value(value.take()).map_err(Into::into)
54    }
55
56    fn encode_to_json(&self) -> JsonbVal {
57        serde_json::to_value(self.clone()).unwrap().into()
58    }
59
60    fn update_offset(&mut self, last_seen_offset: String) -> ConnectorResult<()> {
61        self.next_offset = KinesisOffset::AfterSequenceNumber(last_seen_offset);
62        Ok(())
63    }
64}
65
66impl KinesisSplit {
67    pub fn new(
68        shard_id: SplitId,
69        next_offset: KinesisOffset,
70        end_offset: KinesisOffset,
71    ) -> KinesisSplit {
72        KinesisSplit {
73            shard_id,
74            next_offset,
75            end_offset,
76        }
77    }
78}
risingwave_connector/source/kinesis/split.rs

risingwave_connector/source/kinesis/
split.rs
