Skip to main content

datafusion_python/expr/
column.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
18use datafusion::common::Column;
19use pyo3::prelude::*;
20
21#[pyclass(
22    from_py_object,
23    frozen,
24    name = "Column",
25    module = "datafusion.expr",
26    subclass
27)]
28#[derive(Clone)]
29pub struct PyColumn {
30    pub col: Column,
31}
32
33impl PyColumn {
34    pub fn new(col: Column) -> Self {
35        Self { col }
36    }
37}
38
39impl From<Column> for PyColumn {
40    fn from(col: Column) -> PyColumn {
41        PyColumn { col }
42    }
43}
44
45#[pymethods]
46impl PyColumn {
47    /// Get the column name
48    fn name(&self) -> String {
49        self.col.name.clone()
50    }
51
52    /// Get the column relation
53    fn relation(&self) -> Option<String> {
54        self.col.relation.as_ref().map(|r| format!("{r}"))
55    }
56
57    /// Get the fully-qualified column name
58    fn qualified_name(&self) -> String {
59        self.col.flat_name()
60    }
61
62    /// Get a String representation of this column
63    fn __repr__(&self) -> String {
64        self.qualified_name()
65    }
66}