datafusion_geo/function/
translate.rs

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
use crate::geo::{GeometryArray, GeometryArrayBuilder};
use arrow_array::cast::AsArray;
use arrow_schema::DataType;
use datafusion_common::{DataFusionError, ScalarValue};
use datafusion_expr::{ColumnarValue, ScalarUDFImpl, Signature, TypeSignature, Volatility};
use geo::Translate;
use std::any::Any;
use std::sync::Arc;

#[derive(Debug)]
pub struct TranslateUdf {
    signature: Signature,
    aliases: Vec<String>,
}

impl TranslateUdf {
    pub fn new() -> Self {
        Self {
            signature: Signature::one_of(
                vec![
                    TypeSignature::Exact(vec![
                        DataType::Binary,
                        DataType::Float64,
                        DataType::Float64,
                    ]),
                    TypeSignature::Exact(vec![
                        DataType::LargeBinary,
                        DataType::Float64,
                        DataType::Float64,
                    ]),
                ],
                Volatility::Immutable,
            ),
            aliases: vec!["st_translate".to_string()],
        }
    }
}

impl ScalarUDFImpl for TranslateUdf {
    fn as_any(&self) -> &dyn Any {
        self
    }

    fn name(&self) -> &str {
        "ST_Translate"
    }

    fn signature(&self) -> &Signature {
        &self.signature
    }

    fn return_type(&self, arg_types: &[DataType]) -> datafusion_common::Result<DataType> {
        Ok(arg_types[0].clone())
    }

    fn invoke(&self, args: &[ColumnarValue]) -> datafusion_common::Result<ColumnarValue> {
        let ColumnarValue::Scalar(ScalarValue::Float64(Some(x_offset))) = args[1] else {
            return Err(DataFusionError::Internal(
                "The second arg should be f64 scalar".to_string(),
            ));
        };
        let ColumnarValue::Scalar(ScalarValue::Float64(Some(y_offset))) = args[2] else {
            return Err(DataFusionError::Internal(
                "The third arg should be f64 scalar".to_string(),
            ));
        };

        match args[0].data_type() {
            DataType::Binary => {
                let arr = args[0].clone().into_array(1)?;
                let wkb_arr = arr.as_binary::<i32>();

                let mut geom_vec = vec![];
                for i in 0..wkb_arr.geom_len() {
                    geom_vec.push(
                        wkb_arr
                            .geo_value(i)?
                            .map(|geom| geom.translate(x_offset, y_offset)),
                    );
                }

                let builder: GeometryArrayBuilder<i32> = geom_vec.as_slice().into();
                Ok(ColumnarValue::Array(Arc::new(builder.build())))
            }
            DataType::LargeBinary => {
                let arr = args[0].clone().into_array(0)?;
                let wkb_arr = arr.as_binary::<i64>();

                let mut geom_vec = vec![];
                for i in 0..wkb_arr.geom_len() {
                    geom_vec.push(
                        wkb_arr
                            .geo_value(i)?
                            .map(|geom| geom.translate(x_offset, y_offset)),
                    );
                }
                let builder: GeometryArrayBuilder<i64> = geom_vec.as_slice().into();
                Ok(ColumnarValue::Array(Arc::new(builder.build())))
            }
            _ => unreachable!(),
        }
    }

    fn aliases(&self) -> &[String] {
        &self.aliases
    }
}

impl Default for TranslateUdf {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use crate::function::{AsTextUdf, GeomFromWktUdf, TranslateUdf};
    use arrow::util::pretty::pretty_format_batches;
    use datafusion::logical_expr::ScalarUDF;
    use datafusion::prelude::SessionContext;

    #[tokio::test]
    async fn translate() {
        let ctx = SessionContext::new();
        ctx.register_udf(ScalarUDF::from(GeomFromWktUdf::new()));
        ctx.register_udf(ScalarUDF::from(TranslateUdf::new()));
        ctx.register_udf(ScalarUDF::from(AsTextUdf::new()));
        let df = ctx
            .sql("select ST_AsText(ST_Translate(ST_GeomFromText('POINT(-71.064544 42.28787)'), 1.0, 2.0))")
            .await
            .unwrap();
        assert_eq!(
            pretty_format_batches(&df.collect().await.unwrap())
                .unwrap()
                .to_string(),
            "+----------------------------------------------------------------------------------------------------+
| ST_AsText(ST_Translate(ST_GeomFromText(Utf8(\"POINT(-71.064544 42.28787)\")),Float64(1),Float64(2))) |
+----------------------------------------------------------------------------------------------------+
| POINT(-70.064544 44.28787)                                                                         |
+----------------------------------------------------------------------------------------------------+"
        );
    }
}