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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
//! A column in a DataFrame
//!
//!
//! # Examples
//! A column instance can be created by
//!
//! ```rust
//! use spark_connect_rs::{SparkSession, SparkSessionBuilder};
//!
//! let spark: SparkSession = SparkSessionBuilder::remote("sc://127.0.0.1:15002/;user_id=example_rs".to_string())
//! .build()
//! .await?;
//!
//! // As a &str representing an unresolved column in the dataframe
//! spark.range(None, 1, 1, Some(1)).select("id");
//!
//! // By using the `col` function
//! spark.range(None, 1, 1, Some(1)).select(col("id"));
//!
//! // By using the `lit` function to return a literal value
//! spark.range(None, 1, 1, Some(1)).select(lit(4.0).alias("num_col"));
//!
//!```
use std::convert::From;
use std::ops::{Add, BitAnd, BitOr, BitXor, Div, Mul, Neg, Rem, Sub};
use crate::spark;
use crate::expressions::ToLiteralExpr;
use crate::functions::lit;
use crate::utils::invoke_func;
/// A Column is composed of a `expressions` which is used as input into
/// a Plan object
#[derive(Clone, Debug)]
pub struct Column {
/// An expression is an unresolved value to be leveraged in a Spark Plan
pub expression: spark::Expression,
}
impl From<spark::Expression> for Column {
fn from(expression: spark::Expression) -> Self {
Self { expression }
}
}
impl From<&str> for Column {
fn from(value: &str) -> Self {
let expression = match value {
"*" => spark::Expression {
expr_type: Some(spark::expression::ExprType::UnresolvedStar(
spark::expression::UnresolvedStar {
unparsed_target: None,
},
)),
},
value if value.ends_with(".*") => spark::Expression {
expr_type: Some(spark::expression::ExprType::UnresolvedStar(
spark::expression::UnresolvedStar {
unparsed_target: Some(value.to_string()),
},
)),
},
_ => spark::Expression {
expr_type: Some(spark::expression::ExprType::UnresolvedAttribute(
spark::expression::UnresolvedAttribute {
unparsed_identifier: value.to_string(),
plan_id: Some(1),
},
)),
},
};
Column::from(expression)
}
}
impl Column {
/// Returns the column with a new name
///
/// # Example:
/// ```rust
/// let cols = vec![
/// col("name").alias("new_name"),
/// col("age").alias("new_age")
/// ];
///
/// df.select(cols);
/// ```
pub fn alias(&mut self, value: &str) -> Column {
let alias = spark::expression::Alias {
expr: Some(Box::new(self.expression.clone())),
name: vec![value.to_string()],
metadata: None,
};
let expression = spark::Expression {
expr_type: Some(spark::expression::ExprType::Alias(Box::new(alias))),
};
Column::from(expression)
}
/// An alias for the function `alias`
pub fn name(&mut self, value: &str) -> Column {
self.alias(value)
}
/// Returns a sorted expression based on the ascending order of the column
///
/// # Example:
/// ```rust
/// let mut df: DataFrame = df.sort(col("id").asc());
///
/// let mut df: DataFrame = df.sort(asc(col("id")));
/// ```
pub fn asc(&mut self) -> Column {
self.asc_nulls_first()
}
pub fn asc_nulls_first(&mut self) -> Column {
let asc = spark::expression::SortOrder {
child: Some(Box::new(self.expression.clone())),
direction: 1,
null_ordering: 1,
};
let expression = spark::Expression {
expr_type: Some(spark::expression::ExprType::SortOrder(Box::new(asc))),
};
Column::from(expression)
}
pub fn asc_nulls_last(&mut self) -> Column {
let asc = spark::expression::SortOrder {
child: Some(Box::new(self.expression.clone())),
direction: 1,
null_ordering: 2,
};
let expression = spark::Expression {
expr_type: Some(spark::expression::ExprType::SortOrder(Box::new(asc))),
};
Column::from(expression)
}
/// Returns a sorted expression based on the ascending order of the column
///
/// # Example:
/// ```rust
/// let mut df: DataFrame = df.sort(col("id").desc());
///
/// let mut df: DataFrame = df.sort(desc(col("id")));
/// ```
pub fn desc(&mut self) -> Column {
self.desc_nulls_first()
}
pub fn desc_nulls_first(&mut self) -> Column {
let asc = spark::expression::SortOrder {
child: Some(Box::new(self.expression.clone())),
direction: 2,
null_ordering: 1,
};
let expression = spark::Expression {
expr_type: Some(spark::expression::ExprType::SortOrder(Box::new(asc))),
};
Column::from(expression)
}
pub fn desc_nulls_last(&mut self) -> Column {
let asc = spark::expression::SortOrder {
child: Some(Box::new(self.expression.clone())),
direction: 2,
null_ordering: 2,
};
let expression = spark::Expression {
expr_type: Some(spark::expression::ExprType::SortOrder(Box::new(asc))),
};
Column::from(expression)
}
/// Casts the column into the Spark type represented as a `&str`
///
/// # Arguments:
///
/// * `to_type` is the string representation of the datatype
///
/// # Example:
/// ```rust
/// let mut df = df.select(vec![
/// col("age").cast("int"),
/// col("name").cast("string")
/// ])
/// .collect()
/// .await?;
/// ```
pub fn cast(&mut self, to_type: &str) -> Column {
let type_str = spark::expression::cast::CastToType::TypeStr(to_type.to_string());
let cast = spark::expression::Cast {
expr: Some(Box::new(self.expression.clone())),
cast_to_type: Some(type_str),
};
let expression = spark::Expression {
expr_type: Some(spark::expression::ExprType::Cast(Box::new(cast))),
};
Column::from(expression)
}
/// A boolean expression that is evaluated to `true` if the value of the expression is
/// contained by the evaluated values of the arguments
///
/// # Arguments:
///
/// * `cols` a value that implements the [ToLiteralExpr] trait
///
/// # Example:
/// ```rust
/// let paths = vec!["/opt/spark/examples/src/main/resources/people.csv".to_string()];
/// let mut df = spark
/// .read()
/// .format("csv")
/// .option("header", "True")
/// .option("delimiter", ";")
/// .load(paths);
///
/// let row = df
/// .filter(col("name").isin(vec!["Jorge", "Bob"]))
/// .select("name");
/// ```
pub fn isin<T: ToLiteralExpr>(&self, cols: Vec<T>) -> Column {
let mut values = cols
.iter()
.map(|col| Column::from(col.to_literal_expr()))
.collect::<Vec<Column>>();
values.insert(0, self.clone());
invoke_func("in", values)
}
/// A boolean expression that is evaluated to `true` if the value is in the Column
///
/// # Arguments:
///
/// * `cols`: a col reference that is translated into an [spark::Expression]
///
/// # Example:
/// ```rust
/// let paths = vec!["/opt/spark/examples/src/main/resources/people.csv".to_string()];
/// let mut df = spark
/// .read()
/// .format("csv")
/// .option("header", "True")
/// .option("delimiter", ";")
/// .load(paths);
///
/// let row = df
/// .filter(col("name").contains("ge"))
/// .select("name");
/// ```
pub fn contains<T: ToLiteralExpr>(&self, other: T) -> Column {
let value = lit(other);
invoke_func("contains", vec![self.clone(), value])
}
/// A filter expression that evaluates if the column startswith a string literal
pub fn startswith<T: ToLiteralExpr>(&self, other: T) -> Column {
let value = lit(other);
invoke_func("startswith", vec![self.clone(), value])
}
/// A filter expression that evaluates if the column endswith a string literal
pub fn endswith<T: ToLiteralExpr>(&self, other: T) -> Column {
let value = lit(other);
invoke_func("endswith", vec![self.clone(), value])
}
/// A SQL LIKE filter expression that evaluates the column based on a case sensitive match
pub fn like<T: ToLiteralExpr>(&self, other: T) -> Column {
let value = lit(other);
invoke_func("like", vec![self.clone(), value])
}
/// A SQL ILIKE filter expression that evaluates the column based on a case insensitive match
pub fn ilike<T: ToLiteralExpr>(&self, other: T) -> Column {
let value = lit(other);
invoke_func("ilike", vec![self.clone(), value])
}
/// A SQL RLIKE filter expression that evaluates the column based on a regex match
pub fn rlike<T: ToLiteralExpr>(&self, other: T) -> Column {
let value = lit(other);
invoke_func("rlike", vec![self.clone(), value])
}
/// Equality comparion. Cannot overload the '==' and return something other
/// than a bool
pub fn eq<T: ToLiteralExpr>(&self, other: T) -> Column {
let value = lit(other);
invoke_func("==", vec![self.clone(), value])
}
/// A filter expression that evaluates to true is the expression is null
#[allow(non_snake_case)]
pub fn isNull(&self) -> Column {
invoke_func("isnull", self.clone())
}
/// A filter expression that evaluates to true is the expression is NOT null
#[allow(non_snake_case)]
pub fn isNotNull(&self) -> Column {
invoke_func("isnotnull", self.clone())
}
#[allow(non_snake_case)]
pub fn isNaN(&self) -> Column {
invoke_func("isNaN", self.clone())
}
}
impl Add for Column {
type Output = Self;
fn add(self, other: Self) -> Self {
invoke_func("+", vec![self, other])
}
}
impl Neg for Column {
type Output = Self;
fn neg(self) -> Self {
invoke_func("negative", self)
}
}
impl Sub for Column {
type Output = Self;
fn sub(self, other: Self) -> Self {
invoke_func("-", vec![self, other])
}
}
impl Mul for Column {
type Output = Self;
fn mul(self, other: Self) -> Self {
invoke_func("*", vec![self, other])
}
}
impl Div for Column {
type Output = Self;
fn div(self, other: Self) -> Self {
invoke_func("/", vec![self, other])
}
}
impl Rem for Column {
type Output = Self;
fn rem(self, other: Self) -> Self {
invoke_func("%", vec![self, other])
}
}
impl BitOr for Column {
type Output = Self;
fn bitor(self, other: Self) -> Self {
invoke_func("|", vec![self, other])
}
}
impl BitAnd for Column {
type Output = Self;
fn bitand(self, other: Self) -> Self {
invoke_func("&", vec![self, other])
}
}
impl BitXor for Column {
type Output = Self;
fn bitxor(self, other: Self) -> Self {
invoke_func("^", vec![self, other])
}
}