typed-arrow 0.7.0

Compile-time Arrow schemas for Rust.
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

use arrow_array::Array;
use typed_arrow::{
    Dictionary, LargeBinary, LargeUtf8, arrow_array, arrow_schema, bridge::ArrowBinding,
};

#[test]
fn dict_utf8_value() {
    type D = Dictionary<i32, String>;
    let mut b = <D as ArrowBinding>::new_builder(0);
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new("a".to_string()));
    <D as ArrowBinding>::append_null(&mut b);
    let arr = <D as ArrowBinding>::finish(b);
    assert_eq!(arr.len(), 2);
}

#[test]
fn dict_utf8_roundtrip_values() {
    use arrow_array::cast;
    type D = Dictionary<i32, String>;
    let mut b = <D as ArrowBinding>::new_builder(0);
    // Build values: ["apple", "banana", "apple", null, "banana"]
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new("apple".to_string()));
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new("banana".to_string()));
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new("apple".to_string()));
    <D as ArrowBinding>::append_null(&mut b);
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new("banana".to_string()));
    let arr = <D as ArrowBinding>::finish(b);

    let dict_arr = &arr;
    let keys = dict_arr.keys();
    let values = cast::as_string_array(dict_arr.values().as_ref());
    let expected = [
        Some("apple"),
        Some("banana"),
        Some("apple"),
        None,
        Some("banana"),
    ];
    #[allow(clippy::needless_range_loop)]
    for i in 0..dict_arr.len() {
        match expected[i] {
            None => assert!(dict_arr.is_null(i)),
            Some(s) => {
                assert!(dict_arr.is_valid(i));
                let k = usize::try_from(keys.value(i)).expect("non-negative dictionary key");
                assert_eq!(values.value(k), s);
            }
        }
    }
}

#[test]
fn dict_binary_value() {
    type D = Dictionary<i32, Vec<u8>>;
    let mut b = <D as ArrowBinding>::new_builder(0);
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new(vec![1, 2]));
    <D as ArrowBinding>::append_null(&mut b);
    let arr = <D as ArrowBinding>::finish(b);
    assert_eq!(arr.len(), 2);
}

#[test]
fn dict_primitive_values() {
    macro_rules! check {
        ($t:ty, $v:expr) => {{
            type D = Dictionary<i32, $t>;
            let mut b = <D as ArrowBinding>::new_builder(0);
            <D as ArrowBinding>::append_value(&mut b, &Dictionary::new($v));
            <D as ArrowBinding>::append_null(&mut b);
            let arr = <D as ArrowBinding>::finish(b);
            assert_eq!(arr.len(), 2);
        }};
    }

    check!(i8, 1i8);
    check!(i16, 1i16);
    check!(i32, 1i32);
    check!(i64, 1i64);
    check!(u8, 1u8);
    check!(u16, 1u16);
    check!(u32, 1u32);
    check!(u64, 1u64);
    check!(f32, 1.0f32);
    check!(f64, 1.0f64);
}

#[test]
fn dict_large_binary_value() {
    use arrow_schema::DataType;

    type D = Dictionary<i32, LargeBinary>;
    let mut b = <D as ArrowBinding>::new_builder(0);
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new(LargeBinary::new(vec![1, 2])));
    <D as ArrowBinding>::append_null(&mut b);
    let arr = <D as ArrowBinding>::finish(b);
    assert_eq!(arr.len(), 2);
    assert_eq!(
        <D as ArrowBinding>::data_type(),
        DataType::Dictionary(Box::new(DataType::Int32), Box::new(DataType::LargeBinary))
    );
}

#[test]
fn dict_large_utf8_value() {
    use arrow_schema::DataType;

    type D = Dictionary<i32, LargeUtf8>;
    let mut b = <D as ArrowBinding>::new_builder(0);
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new(LargeUtf8::new("a".into())));
    <D as ArrowBinding>::append_null(&mut b);
    let arr = <D as ArrowBinding>::finish(b);
    assert_eq!(arr.len(), 2);
    assert_eq!(
        <D as ArrowBinding>::data_type(),
        DataType::Dictionary(Box::new(DataType::Int32), Box::new(DataType::LargeUtf8))
    );
}

#[test]
fn dict_fixed_size_binary_value() {
    use arrow_schema::DataType;

    type D = Dictionary<i32, [u8; 4]>;
    assert_eq!(
        <D as ArrowBinding>::data_type(),
        DataType::Dictionary(
            Box::new(DataType::Int32),
            Box::new(DataType::FixedSizeBinary(4))
        )
    );

    let mut b = <D as ArrowBinding>::new_builder(0);
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new([1, 2, 3, 4]));
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new([1, 2, 3, 4]));
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new([9, 9, 9, 9]));
    <D as ArrowBinding>::append_null(&mut b);
    let arr = <D as ArrowBinding>::finish(b);
    assert_eq!(arr.len(), 4);
}

#[test]
fn dict_fixed_size_binary_roundtrip() {
    type D = Dictionary<i16, [u8; 4]>;
    let mut b = <D as ArrowBinding>::new_builder(0);
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new([0xAA, 0xBB, 0xCC, 0xDD]));
    <D as ArrowBinding>::append_null(&mut b);
    <D as ArrowBinding>::append_value(&mut b, &Dictionary::new([0xAA, 0xBB, 0xCC, 0xDD]));
    let arr = <D as ArrowBinding>::finish(b);
    let values = arr
        .values()
        .as_any()
        .downcast_ref::<arrow_array::FixedSizeBinaryArray>()
        .unwrap();
    let keys = arr.keys();
    for &i in &[0usize, 2usize] {
        let k = usize::try_from(keys.value(i)).expect("non-negative dictionary key");
        assert_eq!(values.value(k), &[0xAA, 0xBB, 0xCC, 0xDD]);
    }
}