paimon 0.1.0

The rust implementation of Apache Paimon
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

// 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 std::fmt::{Display, Formatter};

use indexmap::IndexMap;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct DeletionVectorMeta {
    pub offset: i32,
    pub length: i32,
    pub cardinality: Option<i64>,
}

/// Metadata for a global index entry within an index file.
///
/// Reference: [org.apache.paimon.index.GlobalIndexMeta](https://github.com/apache/paimon/blob/master/paimon-core/src/main/java/org/apache/paimon/index/GlobalIndexMeta.java)
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct GlobalIndexMeta {
    #[serde(rename = "_ROW_RANGE_START")]
    pub row_range_start: i64,

    #[serde(rename = "_ROW_RANGE_END")]
    pub row_range_end: i64,

    #[serde(rename = "_INDEX_FIELD_ID")]
    pub index_field_id: i32,

    #[serde(default, rename = "_EXTRA_FIELD_IDS")]
    pub extra_field_ids: Option<Vec<i32>>,

    #[serde(default, rename = "_INDEX_META", with = "serde_bytes")]
    pub index_meta: Option<Vec<u8>>,
}

/// Metadata of index file.
///
/// Impl Reference: <https://github.com/apache/paimon/blob/release-0.8.2/paimon-core/src/main/java/org/apache/paimon/index/IndexFileMeta.java>
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct IndexFileMeta {
    #[serde(rename = "_INDEX_TYPE")]
    pub index_type: String,

    #[serde(rename = "_FILE_NAME")]
    pub file_name: String,

    #[serde(rename = "_FILE_SIZE")]
    pub file_size: i32,

    #[serde(rename = "_ROW_COUNT")]
    pub row_count: i32,

    // use Indexmap to ensure the order of deletion_vectors_ranges is consistent.
    #[serde(
        default,
        with = "map_serde",
        rename = "_DELETIONS_VECTORS_RANGES",
        alias = "_DELETION_VECTORS_RANGES"
    )]
    pub deletion_vectors_ranges: Option<IndexMap<String, DeletionVectorMeta>>,

    #[serde(
        default,
        rename = "_GLOBAL_INDEX",
        skip_serializing_if = "Option::is_none"
    )]
    pub global_index_meta: Option<GlobalIndexMeta>,
}

impl Display for IndexFileMeta {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "IndexFileMeta{{index_type={}, fileName={}, fileSize={}, rowCount={}, deletion_vectors_ranges={:?}, global_index_meta={:?}}}",
            self.index_type,
            self.file_name,
            self.file_size,
            self.row_count,
            self.deletion_vectors_ranges,
            self.global_index_meta,
        )
    }
}

mod map_serde {
    use indexmap::IndexMap;
    use serde::{Deserialize, Deserializer, Serialize, Serializer};

    use super::DeletionVectorMeta;

    #[derive(Deserialize, Serialize)]
    struct Temp {
        f0: String,
        f1: i32,
        f2: i32,
        #[serde(default, rename = "_CARDINALITY")]
        cardinality: Option<i64>,
    }

    pub fn serialize<S>(
        data: &Option<IndexMap<String, DeletionVectorMeta>>,
        s: S,
    ) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match data {
            None => s.serialize_none(),
            Some(d) => s.collect_seq(d.iter().map(|(path, meta)| Temp {
                f0: path.clone(),
                f1: meta.offset,
                f2: meta.length,
                cardinality: meta.cardinality,
            })),
        }
    }

    #[allow(clippy::type_complexity)]
    pub fn deserialize<'de, D>(
        deserializer: D,
    ) -> Result<Option<IndexMap<String, DeletionVectorMeta>>, D::Error>
    where
        D: Deserializer<'de>,
    {
        match Option::deserialize(deserializer)? {
            None => Ok(None),
            Some::<Vec<Temp>>(s) => Ok(Some(
                s.into_iter()
                    .map(|t| {
                        (
                            t.f0,
                            DeletionVectorMeta {
                                offset: t.f1,
                                length: t.f2,
                                cardinality: t.cardinality,
                            },
                        )
                    })
                    .collect::<IndexMap<_, _>>(),
            )),
        }
    }
}