datafusion_python/unparser/
mod.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18mod dialect;
19
20use std::sync::Arc;
21
22use datafusion::sql::unparser::Unparser;
23use datafusion::sql::unparser::dialect::Dialect;
24use dialect::PyDialect;
25use pyo3::exceptions::PyValueError;
26use pyo3::prelude::*;
27
28use crate::sql::logical::PyLogicalPlan;
29
30#[pyclass(
31    from_py_object,
32    frozen,
33    name = "Unparser",
34    module = "datafusion.unparser",
35    subclass
36)]
37#[derive(Clone)]
38pub struct PyUnparser {
39    dialect: Arc<dyn Dialect>,
40    pretty: bool,
41}
42
43#[pymethods]
44impl PyUnparser {
45    #[new]
46    pub fn new(dialect: PyDialect) -> Self {
47        Self {
48            dialect: dialect.dialect.clone(),
49            pretty: false,
50        }
51    }
52
53    pub fn plan_to_sql(&self, plan: &PyLogicalPlan) -> PyResult<String> {
54        let mut unparser = Unparser::new(self.dialect.as_ref());
55        unparser = unparser.with_pretty(self.pretty);
56        let sql = unparser
57            .plan_to_sql(&plan.plan())
58            .map_err(|e| PyValueError::new_err(e.to_string()))?;
59        Ok(sql.to_string())
60    }
61
62    pub fn with_pretty(&self, pretty: bool) -> Self {
63        Self {
64            dialect: self.dialect.clone(),
65            pretty,
66        }
67    }
68}
69
70pub(crate) fn init_module(m: &Bound<'_, PyModule>) -> PyResult<()> {
71    m.add_class::<PyUnparser>()?;
72    m.add_class::<PyDialect>()?;
73    Ok(())
74}
datafusion_python/unparser/mod.rs

datafusion_python/unparser/
mod.rs
