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