glaredb_ext_iceberg 25.6.3

Iceberg extension for GlareDB
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
use std::str::FromStr;
use std::sync::LazyLock;

use glaredb_core::arrays::datatype::{DataType, DecimalTypeMeta, TimeUnit, TimestampTypeMeta};
use glaredb_core::arrays::field::{ColumnSchema as BulletSchema, Field};
use glaredb_error::{DbError, Result, not_implemented};
use regex::Regex;
use serde::{Deserialize, Deserializer, de};

/// Primitive types supported in iceberg tables.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PrimitiveType {
    Boolean,
    Int,
    Long,
    Float,
    Double,
    Decimal {
        p: u8,
        s: u8,
    },
    /// > Calendar date without timezone or time
    Date,
    /// > Time of day, microsecond precision, without date, timezone
    Time,
    /// > Timestamp, microsecond precision, without timezone
    Timestamp,
    /// > Timestamp, microsecond precision, with timezone
    Timestamptz,
    String,
    Uuid,
    Fixed(usize),
    Binary,
}

impl TryFrom<PrimitiveType> for DataType {
    type Error = DbError;

    fn try_from(value: PrimitiveType) -> Result<Self> {
        Ok(match value {
            PrimitiveType::Boolean => DataType::boolean(),
            PrimitiveType::Int => DataType::int32(),
            PrimitiveType::Long => DataType::int64(),
            PrimitiveType::Float => DataType::float32(),
            PrimitiveType::Double => DataType::float64(),
            PrimitiveType::Decimal { p, s } => DataType::decimal128(DecimalTypeMeta {
                precision: p,
                scale: s as i8,
            }),
            PrimitiveType::Date => DataType::date32(),
            PrimitiveType::Time => {
                DataType::timestamp(TimestampTypeMeta::new(TimeUnit::Microsecond))
            } // TODO: Possibly `Time32` instead?
            PrimitiveType::Timestamp => {
                DataType::timestamp(TimestampTypeMeta::new(TimeUnit::Microsecond))
            }
            PrimitiveType::Timestamptz => not_implemented!("Timestamp with timezone"),
            PrimitiveType::String => DataType::utf8(),
            PrimitiveType::Uuid => DataType::utf8(),
            PrimitiveType::Fixed(_) => not_implemented!("Fixed sized binary"),
            PrimitiveType::Binary => DataType::binary(),
        })
    }
}

impl<'de> Deserialize<'de> for PrimitiveType {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let s: &str = Deserialize::deserialize(deserializer)?;
        PrimitiveType::from_str(s).map_err(de::Error::custom)
    }
}

impl FromStr for PrimitiveType {
    type Err = DbError;

    fn from_str(s: &str) -> Result<Self> {
        Ok(match s {
            "boolean" => PrimitiveType::Boolean,
            "int" => PrimitiveType::Int,
            "long" => PrimitiveType::Long,
            "float" => PrimitiveType::Float,
            "double" => PrimitiveType::Double,
            "date" => PrimitiveType::Date,
            "time" => PrimitiveType::Time,
            "timestamp" => PrimitiveType::Timestamp,
            "timestamptz" => PrimitiveType::Timestamptz,
            "string" => PrimitiveType::String,
            "uuid" => PrimitiveType::Uuid,
            "binary" => PrimitiveType::Binary,
            other if other.starts_with("decimal") => {
                // Regex that matches:
                // decimal(15, 2)
                // decimal(15,2)
                static DECIMAL_RE: LazyLock<Regex> =
                    LazyLock::new(|| Regex::new(r"^decimal\((?P<p>\d+),\s?(?P<s>\d+)\)$").unwrap());

                let captures = DECIMAL_RE
                    .captures(other)
                    .ok_or_else(|| DbError::new(format!("Invalid decimal type: {other}")))?;

                let p: u8 = captures
                    .name("p")
                    .ok_or_else(|| DbError::new(format!("Invalid decimal type: {other}")))?
                    .as_str()
                    .parse()
                    .map_err(|e| DbError::new(format!("Decimal precision not a u8: {e}")))?;

                let s: u8 = captures
                    .name("s")
                    .ok_or_else(|| DbError::new(format!("Invalid decimal type: {other}")))?
                    .as_str()
                    .parse()
                    .map_err(|e| DbError::new(format!("Decimal scale not a u8: {e}")))?;

                PrimitiveType::Decimal { p, s }
            }
            other if other.starts_with("fixed") => {
                // Regex that matches:
                // fixed[16]
                static FIXED_RE: LazyLock<Regex> =
                    LazyLock::new(|| Regex::new(r"^fixed\[(?P<l>\d+)\]$").unwrap());

                let captures = FIXED_RE
                    .captures(other)
                    .ok_or_else(|| DbError::new(format!("Invalid fixed type: {other}")))?;

                let l: usize = captures
                    .name("l")
                    .ok_or_else(|| DbError::new(format!("Invalid fixed type: {other}")))?
                    .as_str()
                    .parse()
                    .map_err(|e| DbError::new(format!("Fixed length not a usize: {e}")))?;

                PrimitiveType::Fixed(l)
            }
            other => return Err(DbError::new(format!("Invalid type: {other}"))),
        })
    }
}

/// Union between primitive and nested types.
#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
#[serde(untagged)]
pub enum AnyType {
    Primitive(PrimitiveType),
    List(ListType),
    Struct(StructType),
    Map(MapType),
}

impl TryFrom<&AnyType> for DataType {
    type Error = DbError;

    fn try_from(value: &AnyType) -> Result<Self> {
        Ok(match value {
            AnyType::Primitive(t) => (*t).try_into()?,
            AnyType::List(t) => t.try_into()?,
            AnyType::Struct(t) => t.try_into()?,
            AnyType::Map(t) => t.try_into()?,
        })
    }
}

#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
#[serde(tag = "type", rename = "list")]
pub struct ListType {
    pub element_id: i32,
    pub element_required: bool,
    pub element: Box<AnyType>,
}

impl TryFrom<&ListType> for DataType {
    type Error = DbError;

    fn try_from(value: &ListType) -> Result<Self> {
        let typ = DataType::try_from(value.element.as_ref())?;
        Ok(DataType::list(typ))
    }
}

#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
#[serde(tag = "type", rename = "map")]
pub struct MapType {
    pub key_id: i32,
    pub key: Box<AnyType>,
    pub value_id: i32,
    pub value_required: bool,
    pub value: Box<AnyType>,
}

impl TryFrom<&MapType> for DataType {
    type Error = DbError;

    fn try_from(_value: &MapType) -> Result<Self> {
        Err(DbError::new("Iceberg map type not yet implemented"))
        // let key_field = ArrowField::new("key", value.key.as_ref().try_into()?, false);
        // let val_field = ArrowField::new(
        //     "value",
        //     value.value.as_ref().try_into()?,
        //     value.value_required,
        // );
        // let field = ArrowField::new_struct("entryies", vec![key_field, val_field], false);

        // let typ = DataType::Map(Arc::new(field), false);

        // Ok(typ)
    }
}

#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
#[serde(tag = "type", rename = "struct")]
pub struct StructType {
    pub fields: Vec<StructField>,
}

impl TryFrom<&StructType> for DataType {
    type Error = DbError;

    fn try_from(_value: &StructType) -> Result<Self> {
        Err(DbError::new("Iceberg struct type not yet implemented"))
        // let fields = value
        //     .fields
        //     .iter()
        //     .map(|f| {
        //         let typ = &f.r#type;
        //         Ok(ArrowField::new(&f.name, typ.try_into()?, !f.required))
        //     })
        //     .collect::<Result<Vec<_>>>()?;

        // let typ = DataType::Struct(fields.into());
        // Ok(typ)
    }
}

/// Fields on a struct.
#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
pub struct StructField {
    pub id: i32,
    pub name: String,
    pub required: bool,
    pub r#type: AnyType,
    pub doc: Option<String>,
    /// JSON serialized initial value for the field.
    pub initial_default: Option<String>, // TODO
    /// JSON serialized write default value for the field.
    pub write_default: Option<String>, // TODO
}

impl StructField {
    pub fn to_field(&self) -> Result<Field> {
        let typ = &self.r#type;
        Ok(Field::new(&self.name, typ.try_into()?, !self.required))
    }
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct Schema {
    pub schema_id: i32,
    pub identifier_field_ids: Option<Vec<i32>>,
    pub fields: Vec<StructField>,
}

impl Schema {
    pub fn to_schema(&self) -> Result<BulletSchema> {
        let fields = self
            .fields
            .iter()
            .map(|f| f.to_field())
            .collect::<Result<Vec<_>>>()?;

        Ok(BulletSchema::new(fields))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_deserialize_long_field() {
        let json = r#"
            {
              "id" : 1,
              "name" : "l_orderkey",
              "required" : false,
              "type" : "long"
            }"#;

        let deserialized: StructField = serde_json::from_str(json).unwrap();
        let expected = StructField {
            id: 1,
            name: "l_orderkey".to_string(),
            required: false,
            r#type: AnyType::Primitive(PrimitiveType::Long),
            doc: None,
            initial_default: None,
            write_default: None,
        };
        assert_eq!(expected, deserialized);
    }

    #[test]
    fn test_deserialize_decimal_field() {
        let json = r#"
            {
              "id" : 6,
              "name" : "l_extendedprice",
              "required" : false,
              "type" : "decimal(15, 2)"
            }"#;

        let deserialized: StructField = serde_json::from_str(json).unwrap();
        let expected = StructField {
            id: 6,
            name: "l_extendedprice".to_string(),
            required: false,
            r#type: AnyType::Primitive(PrimitiveType::Decimal { p: 15, s: 2 }),
            doc: None,
            initial_default: None,
            write_default: None,
        };
        assert_eq!(expected, deserialized);
    }

    #[test]
    fn test_deserialize_decimal_no_space_field() {
        // See lack of space after comma in decimal type.
        let json = r#"
            {
              "id" : 6,
              "name" : "l_extendedprice",
              "required" : false,
              "type" : "decimal(15,2)"
            }"#;

        let deserialized: StructField = serde_json::from_str(json).unwrap();
        let expected = StructField {
            id: 6,
            name: "l_extendedprice".to_string(),
            required: false,
            r#type: AnyType::Primitive(PrimitiveType::Decimal { p: 15, s: 2 }),
            doc: None,
            initial_default: None,
            write_default: None,
        };
        assert_eq!(expected, deserialized);
    }

    #[test]
    fn test_deserialize_list_field() {
        let json = r#"
            {
              "id" : 6,
              "name" : "l_extendedprice",
              "required" : false,
              "type" : {
                "type": "list",
                "element-id": 3,
                "element-required": true,
                "element": "string"
              }
            }"#;

        let deserialized: StructField = serde_json::from_str(json).unwrap();
        let expected = StructField {
            id: 6,
            name: "l_extendedprice".to_string(),
            required: false,
            r#type: AnyType::List(ListType {
                element_required: true,
                element_id: 3,
                element: Box::new(AnyType::Primitive(PrimitiveType::String)),
            }),
            doc: None,
            initial_default: None,
            write_default: None,
        };
        assert_eq!(expected, deserialized);
    }

    #[test]
    fn test_deserialize_struct_field() {
        let json = r#"
            {
              "id" : 6,
              "name" : "l_extendedprice",
              "required" : false,
              "type" : {
                "type": "struct",
                "fields": [ {
                  "id": 1,
                  "name": "id",
                  "required": true,
                  "type": "uuid",
                  "initial-default": "0db3e2a8-9d1d-42b9-aa7b-74ebe558dceb",
                  "write-default": "ec5911be-b0a7-458c-8438-c9a3e53cffae"
                }, {
                  "id": 2,
                  "name": "data",
                  "required": false,
                  "type": "string"
                } ]
              }
            }"#;

        let deserialized: StructField = serde_json::from_str(json).unwrap();
        let expected = StructField {
            id: 6,
            name: "l_extendedprice".to_string(),
            required: false,
            r#type: AnyType::Struct(StructType {
                fields: vec![
                    StructField {
                        id: 1,
                        name: "id".to_string(),
                        required: true,
                        r#type: AnyType::Primitive(PrimitiveType::Uuid),
                        initial_default: Some("0db3e2a8-9d1d-42b9-aa7b-74ebe558dceb".to_string()),
                        write_default: Some("ec5911be-b0a7-458c-8438-c9a3e53cffae".to_string()),
                        doc: None,
                    },
                    StructField {
                        id: 2,
                        name: "data".to_string(),
                        required: false,
                        r#type: AnyType::Primitive(PrimitiveType::String),
                        initial_default: None,
                        write_default: None,
                        doc: None,
                    },
                ],
            }),
            doc: None,
            initial_default: None,
            write_default: None,
        };
        assert_eq!(expected, deserialized);
    }

    #[test]
    fn test_deserialize_map_field() {
        let json = r#"
            {
              "id" : 6,
              "name" : "l_extendedprice",
              "required" : false,
              "type" : {
                "type": "map",
                "key-id": 4,
                "key": "string",
                "value-id": 5,
                "value-required": false,
                "value": "double"
              }
            }"#;

        let deserialized: StructField = serde_json::from_str(json).unwrap();
        let expected = StructField {
            id: 6,
            name: "l_extendedprice".to_string(),
            required: false,
            r#type: AnyType::Map(MapType {
                key_id: 4,
                key: Box::new(AnyType::Primitive(PrimitiveType::String)),
                value: Box::new(AnyType::Primitive(PrimitiveType::Double)),
                value_id: 5,
                value_required: false,
            }),
            doc: None,
            initial_default: None,
            write_default: None,
        };
        assert_eq!(expected, deserialized);
    }
}