-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(spec): Add Snapshot #11
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,3 +17,7 @@ | |
|
||
/target | ||
/Cargo.lock | ||
.idea | ||
.vscode | ||
**/.DS_Store | ||
dist/* |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,3 +20,4 @@ | |
//! All paimon specs types are defined here. | ||
|
||
mod schema; | ||
mod snapshot; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
// 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. | ||
|
||
use serde::{Deserialize, Serialize}; | ||
use typed_builder::TypedBuilder; | ||
|
||
/// Snapshot for paimon. | ||
/// | ||
/// Impl Reference: <https://github.com/apache/paimon/blob/db8bcd7fdd9c2705435d2ab1d2341c52d1f67ee5/paimon-core/src/main/java/org/apache/paimon/Snapshot.java#L68>. | ||
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize, TypedBuilder)] | ||
#[serde(rename_all = "camelCase")] | ||
pub struct Snapshot { | ||
/// version of snapshot | ||
version: i32, | ||
id: i64, | ||
schema_id: i64, | ||
/// a manifest list recording all changes from the previous snapshots | ||
base_manifest_list: String, | ||
/// a manifest list recording all new changes occurred in this snapshot | ||
delta_manifest_list: String, | ||
/// a manifest list recording all changelog produced in this snapshot | ||
#[builder(default = None)] | ||
changelog_manifest_list: Option<String>, | ||
/// a manifest recording all index files of this table | ||
#[builder(default = None)] | ||
index_manifest: Option<String>, | ||
commit_user: String, | ||
/// record count of all changes occurred in this snapshot | ||
#[builder(default = None)] | ||
total_record_count: Option<i64>, | ||
/// record count of all new changes occurred in this snapshot | ||
#[builder(default = None)] | ||
delta_record_count: Option<i64>, | ||
/// record count of all changelog produced in this snapshot | ||
#[builder(default = None)] | ||
changelog_record_count: Option<i64>, | ||
/// watermark for input records | ||
#[builder(default = None)] | ||
watermark: Option<i64>, | ||
/// stats file name for statistics of this table | ||
#[builder(default = None)] | ||
statistics: Option<String>, | ||
} | ||
|
||
impl Snapshot { | ||
/// Get the version of this snapshot. | ||
#[inline] | ||
pub fn version(&self) -> i32 { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Better to provide APIs for our public API. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Do you mean remove There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh sorry, I mean add API docs. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I have updated it, PTAL 👀 |
||
self.version | ||
} | ||
|
||
/// Get the id of this snapshot. | ||
#[inline] | ||
pub fn id(&self) -> i64 { | ||
self.id | ||
} | ||
|
||
/// Get the schema id of this snapshot. | ||
#[inline] | ||
pub fn schema_id(&self) -> i64 { | ||
self.schema_id | ||
} | ||
|
||
/// Get the base manifest list of this snapshot. | ||
#[inline] | ||
pub fn base_manifest_list(&self) -> &str { | ||
&self.base_manifest_list | ||
} | ||
|
||
/// Get the delta manifest list of this snapshot. | ||
#[inline] | ||
pub fn delta_manifest_list(&self) -> &str { | ||
&self.delta_manifest_list | ||
} | ||
|
||
/// Get the changelog manifest list of this snapshot. | ||
#[inline] | ||
pub fn changelog_manifest_list(&self) -> Option<&str> { | ||
self.changelog_manifest_list.as_deref() | ||
} | ||
|
||
/// Get the index manifest of this snapshot. | ||
#[inline] | ||
pub fn index_manifest(&self) -> Option<&str> { | ||
self.index_manifest.as_deref() | ||
} | ||
|
||
/// Get the commit user of this snapshot. | ||
#[inline] | ||
pub fn commit_user(&self) -> &str { | ||
&self.commit_user | ||
} | ||
|
||
/// Get the total record count of this snapshot. | ||
#[inline] | ||
pub fn total_record_count(&self) -> Option<i64> { | ||
self.total_record_count | ||
} | ||
|
||
/// Get the delta record count of this snapshot. | ||
#[inline] | ||
pub fn delta_record_count(&self) -> Option<i64> { | ||
self.delta_record_count | ||
} | ||
|
||
/// Get the changelog record count of this snapshot. | ||
#[inline] | ||
pub fn changelog_record_count(&self) -> Option<i64> { | ||
self.changelog_record_count | ||
} | ||
|
||
/// Get the watermark of this snapshot. | ||
#[inline] | ||
pub fn watermark(&self) -> Option<i64> { | ||
self.watermark | ||
} | ||
|
||
/// Get the statistics of this snapshot. | ||
#[inline] | ||
pub fn statistics(&self) -> Option<&str> { | ||
self.statistics.as_deref() | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we need
serde(rename_all("camelCase"))
?