Column

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

def !==(other: Any): Column

Inequality test.

// Scala:
df.select( df("colA") !== df("colB") )
df.select( !(df("colA") === df("colB")) )

// Java:
import static org.apache.spark.sql.functions.*;
df.filter( col("colA").notEqual(col("colB")) );

final def ##(): Int

def %(other: Any): Column

Modulo (a.

def &&(other: Any): Column

Boolean AND.

// Scala: The following selects people that are in school and employed at the same time.
people.select( people("inSchool") && people("isEmployed") )

// Java:
people.select( people("inSchool").and(people("isEmployed")) );

def *(other: Any): Column

Multiplication of this expression and another expression.

// Scala: The following multiplies a person's height by their weight.
people.select( people("height") * people("weight") )

// Java:
people.select( people("height").multiply(people("weight")) );

def +(other: Any): Column

Sum of this expression and another expression.

// Scala: The following selects the sum of a person's height and weight.
people.select( people("height") + people("weight") )

// Java:
people.select( people("height").plus(people("weight")) );

def -(other: Any): Column

Subtraction.

// Scala: The following selects the difference between people's height and their weight.
people.select( people("height") - people("weight") )

// Java:
people.select( people("height").minus(people("weight")) );

def /(other: Any): Column

Division this expression by another expression.

// Scala: The following divides a person's height by their weight.
people.select( people("height") / people("weight") )

// Java:
people.select( people("height").divide(people("weight")) );

def <(other: Any): Column

Less than.

// Scala: The following selects people younger than 21.
people.select( people("age") < 21 )

// Java:
people.select( people("age").lt(21) );

def <=(other: Any): Column

Less than or equal to.

// Scala: The following selects people age 21 or younger than 21.
people.select( people("age") <= 21 )

// Java:
people.select( people("age").leq(21) );

def <=>(other: Any): Column

Equality test that is safe for null values.

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def ===(other: Any): Column

Equality test.

// Scala:
df.filter( df("colA") === df("colB") )

// Java
import static org.apache.spark.sql.functions.*;
df.filter( col("colA").equalTo(col("colB")) );

def >(other: Any): Column

Greater than.

// Scala: The following selects people older than 21.
people.select( people("age") > 21 )

// Java:
import static org.apache.spark.sql.functions.*;
people.select( people("age").gt(21) );

def >=(other: Any): Column

Greater than or equal to an expression.

// Scala: The following selects people age 21 or older than 21.
people.select( people("age") >= 21 )

// Java:
people.select( people("age").geq(21) )

def alias(alias: String): Column

Gives the column an alias.

// Renames colA to colB in select output.
df.select($"colA".alias("colB"))

def and(other: Column): Column

Boolean AND.

// Scala: The following selects people that are in school and employed at the same time.
people.select( people("inSchool") && people("isEmployed") )

// Java:
people.select( people("inSchool").and(people("isEmployed")) );

def apply(extraction: Any): Column

Extracts a value or values from a complex type.

def as(alias: String, metadata: Metadata): Column

Gives the column an alias with metadata.

val metadata: Metadata = ...
df.select($"colA".as("colB", metadata))

def as(alias: Symbol): Column

Gives the column an alias.

// Renames colA to colB in select output.
df.select($"colA".as('colB))

def as(aliases: Array[String]): Column

Assigns the given aliases to the results of a table generating function.

// Renames colA to colB in select output.
df.select(explode($"myMap").as("key" :: "value" :: Nil))

def as(aliases: Seq[String]): Column

(Scala-specific) Assigns the given aliases to the results of a table generating function.

// Renames colA to colB in select output.
df.select(explode($"myMap").as("key" :: "value" :: Nil))

def as(alias: String): Column

Gives the column an alias.

// Renames colA to colB in select output.
df.select($"colA".as("colB"))

final def asInstanceOf[T0]: T0

def asc: Column

Returns an ordering used in sorting.

// Scala: sort a DataFrame by age column in ascending order.
df.sort(df("age").asc)

// Java
df.sort(df.col("age").asc());

def between(lowerBound: Any, upperBound: Any): Column

True if the current column is between the lower bound and upper bound, inclusive.

def bitwiseAND(other: Any): Column

Compute bitwise AND of this expression with another expression.

df.select($"colA".bitwiseAND($"colB"))

def bitwiseOR(other: Any): Column

Compute bitwise OR of this expression with another expression.

df.select($"colA".bitwiseOR($"colB"))

def bitwiseXOR(other: Any): Column

Compute bitwise XOR of this expression with another expression.

df.select($"colA".bitwiseXOR($"colB"))

def cast(to: String): Column

Casts the column to a different data type, using the canonical string representation of the type.

// Casts colA to integer.
df.select(df("colA").cast("int"))

def cast(to: DataType): Column

Casts the column to a different data type.

// Casts colA to IntegerType.
import org.apache.spark.sql.types.IntegerType
df.select(df("colA").cast(IntegerType))

// equivalent to
df.select(df("colA").cast("int"))

def clone(): AnyRef

def contains(other: Any): Column

Contains the other element.

def desc: Column

Returns an ordering used in sorting.

// Scala: sort a DataFrame by age column in descending order.
df.sort(df("age").desc)

// Java
df.sort(df.col("age").desc());

def divide(other: Any): Column

Division this expression by another expression.

// Scala: The following divides a person's height by their weight.
people.select( people("height") / people("weight") )

// Java:
people.select( people("height").divide(people("weight")) );

def endsWith(literal: String): Column

String ends with another string literal.

def endsWith(other: Column): Column

String ends with.

final def eq(arg0: AnyRef): Boolean

def eqNullSafe(other: Any): Column

Equality test that is safe for null values.

def equalTo(other: Any): Column

Equality test.

// Scala:
df.filter( df("colA") === df("colB") )

// Java
import static org.apache.spark.sql.functions.*;
df.filter( col("colA").equalTo(col("colB")) );

def equals(that: Any): Boolean

def explain(extended: Boolean): Unit

Prints the expression to the console for debugging purpose.

val expr: Expression

def finalize(): Unit

def geq(other: Any): Column

Greater than or equal to an expression.

// Scala: The following selects people age 21 or older than 21.
people.select( people("age") >= 21 )

// Java:
people.select( people("age").geq(21) )

final def getClass(): Class[_]

def getField(fieldName: String): Column

An expression that gets a field by name in a StructType.

def getItem(key: Any): Column

An expression that gets an item at position ordinal out of an array, or gets a value by key key in a MapType.

def gt(other: Any): Column

Greater than.

// Scala: The following selects people older than 21.
people.select( people("age") > lit(21) )

// Java:
import static org.apache.spark.sql.functions.*;
people.select( people("age").gt(21) );

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isNaN: Column

True if the current expression is NaN.

def isNotNull: Column

True if the current expression is NOT null.

def isNull: Column

True if the current expression is null.

def isTraceEnabled(): Boolean

def isin(list: Any*): Column

A boolean expression that is evaluated to true if the value of this expression is contained by the evaluated values of the arguments.

def leq(other: Any): Column

Less than or equal to.

// Scala: The following selects people age 21 or younger than 21.
people.select( people("age") <= 21 )

// Java:
people.select( people("age").leq(21) );

def like(literal: String): Column

SQL like expression.

def log: Logger

def logDebug(msg: ⇒ String, throwable: Throwable): Unit

def logDebug(msg: ⇒ String): Unit

def logError(msg: ⇒ String, throwable: Throwable): Unit

def logError(msg: ⇒ String): Unit

def logInfo(msg: ⇒ String, throwable: Throwable): Unit

def logInfo(msg: ⇒ String): Unit

def logName: String

def logTrace(msg: ⇒ String, throwable: Throwable): Unit

def logTrace(msg: ⇒ String): Unit

def logWarning(msg: ⇒ String, throwable: Throwable): Unit

def logWarning(msg: ⇒ String): Unit

def lt(other: Any): Column

Less than.

// Scala: The following selects people younger than 21.
people.select( people("age") < 21 )

// Java:
people.select( people("age").lt(21) );

def minus(other: Any): Column

Subtraction.

// Scala: The following selects the difference between people's height and their weight.
people.select( people("height") - people("weight") )

// Java:
people.select( people("height").minus(people("weight")) );

def mod(other: Any): Column

Modulo (a.

def multiply(other: Any): Column

Multiplication of this expression and another expression.

// Scala: The following multiplies a person's height by their weight.
people.select( people("height") * people("weight") )

// Java:
people.select( people("height").multiply(people("weight")) );

final def ne(arg0: AnyRef): Boolean

def notEqual(other: Any): Column

Inequality test.

// Scala:
df.select( df("colA") !== df("colB") )
df.select( !(df("colA") === df("colB")) )

// Java:
import static org.apache.spark.sql.functions.*;
df.filter( col("colA").notEqual(col("colB")) );

final def notify(): Unit

final def notifyAll(): Unit

def or(other: Column): Column

Boolean OR.

// Scala: The following selects people that are in school or employed.
people.filter( people("inSchool") || people("isEmployed") )

// Java:
people.filter( people("inSchool").or(people("isEmployed")) );

def otherwise(value: Any): Column

Evaluates a list of conditions and returns one of multiple possible result expressions.

// Example: encoding gender string column into integer.

// Scala:
people.select(when(people("gender") === "male", 0)
  .when(people("gender") === "female", 1)
  .otherwise(2))

// Java:
people.select(when(col("gender").equalTo("male"), 0)
  .when(col("gender").equalTo("female"), 1)
  .otherwise(2))

def over(window: WindowSpec): Column

Define a windowing column.

val w = Window.partitionBy("name").orderBy("id")
df.select(
  sum("price").over(w.rangeBetween(Long.MinValue, 2)),
  avg("price").over(w.rowsBetween(0, 4))
)

def plus(other: Any): Column

Sum of this expression and another expression.

// Scala: The following selects the sum of a person's height and weight.
people.select( people("height") + people("weight") )

// Java:
people.select( people("height").plus(people("weight")) );

def rlike(literal: String): Column

SQL RLIKE expression (LIKE with Regex).

def startsWith(literal: String): Column

String starts with another string literal.

def startsWith(other: Column): Column

String starts with.

def substr(startPos: Int, len: Int): Column

An expression that returns a substring.

def substr(startPos: Column, len: Column): Column

An expression that returns a substring.

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unary_!: Column

Inversion of boolean expression, i.

// Scala: select rows that are not active (isActive === false)
df.filter( !df("isActive") )

// Java:
import static org.apache.spark.sql.functions.*;
df.filter( not(df.col("isActive")) );

def unary_-: Column

Unary minus, i.

// Scala: select the amount column and negates all values.
df.select( -df("amount") )

// Java:
import static org.apache.spark.sql.functions.*;
df.select( negate(col("amount") );

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def when(condition: Column, value: Any): Column

Evaluates a list of conditions and returns one of multiple possible result expressions.

// Example: encoding gender string column into integer.

// Scala:
people.select(when(people("gender") === "male", 0)
  .when(people("gender") === "female", 1)
  .otherwise(2))

// Java:
people.select(when(col("gender").equalTo("male"), 0)
  .when(col("gender").equalTo("female"), 1)
  .otherwise(2))

def ||(other: Any): Column

Boolean OR.

// Scala: The following selects people that are in school or employed.
people.filter( people("inSchool") || people("isEmployed") )

// Java:
people.filter( people("inSchool").or(people("isEmployed")) );

def in(list: Any*): Column

A boolean expression that is evaluated to true if the value of this expression is contained by the evaluated values of the arguments.