Column

Defined in: column.ts:47

A reference to a column expression, typically obtained from col or from methods on a DataFrame such as df.col("name").

Every method on Column returns a new Column that wraps a new expression tree node; the original is never mutated. The combined tree is serialised to a Spark Connect Expression protobuf when the plan is sent to the server.

Examples

Build a filter predicate

import { col, lit } from "@spark-connect-js/core";

const predicate = col("age").gte(lit(18)).and(col("country").eq(lit("NL")));
const adults = df.filter(predicate);

Build a sort key

const sorted = df.orderBy(col("score").desc_nulls_last());

See

Spark source: Column.scala

Constructors

Constructor

new Column(expr): Column;

Defined in: column.ts:51

Parameters

Parameter	Type
expr	Expression

Returns

Column

Methods

alias()

alias(name): Column;

Defined in: column.ts:116

Rename this column expression. Maps to Catalyst’s Alias(expr, name).

Parameters

Parameter	Type
name	string

Returns

Column

---

and()

and(other): Column;

Defined in: column.ts:85

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

as()

as(name): Column;

Defined in: column.ts:120

Parameters

Parameter	Type
name	string

Returns

Column

---

asc()

asc(): Column;

Defined in: column.ts:134

Mark this column as ascending sort order.

Returns

Column

---

asc_nulls_first()

asc_nulls_first(): Column;

Defined in: column.ts:154

Ascending sort, nulls first.

Returns

Column

---

asc_nulls_last()

asc_nulls_last(): Column;

Defined in: column.ts:164

Ascending sort, nulls last.

Returns

Column

---

between()

between(lower, upper): Column;

Defined in: column.ts:309

Test whether this column’s value is between lower and upper (inclusive).

Parameters

Parameter	Type
lower	ColOrLiteral
upper	ColOrLiteral

Returns

Column

---

bitwiseAND()

bitwiseAND(other): Column;

Defined in: column.ts:214

Bitwise AND.

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

bitwiseOR()

bitwiseOR(other): Column;

Defined in: column.ts:223

Bitwise OR.

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

bitwiseXOR()

bitwiseXOR(other): Column;

Defined in: column.ts:232

Bitwise XOR.

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

cast()

cast(targetType): Column;

Defined in: column.ts:127

Cast this column to the given type string (e.g. “string”, “int”, “double”).

Parameters

Parameter	Type
targetType	string

Returns

Column

---

contains()

contains(substr): Column;

Defined in: column.ts:361

Test whether this string column contains the given substring.

Parameters

Parameter	Type
substr	string

Returns

Column

---

desc()

desc(): Column;

Defined in: column.ts:144

Mark this column as descending sort order.

Returns

Column

---

desc_nulls_first()

desc_nulls_first(): Column;

Defined in: column.ts:169

Descending sort, nulls first.

Returns

Column

---

desc_nulls_last()

desc_nulls_last(): Column;

Defined in: column.ts:179

Descending sort, nulls last.

Returns

Column

---

divide()

divide(other): Column;

Defined in: column.ts:107

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

dropFields()

dropFields(...fieldNames): Column;

Defined in: column.ts:285

Drop field(s) from a StructType column.

Parameters

Parameter	Type
…fieldNames	string[]

Returns

Column

---

endsWith()

endsWith(suffix): Column;

Defined in: column.ts:352

Test whether this string column ends with the given suffix.

Parameters

Parameter	Type
suffix	string

Returns

Column

---

eq()

eq(other): Column;

Defined in: column.ts:67

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

eqNullSafe()

eqNullSafe(other): Column;

Defined in: column.ts:203

Null-safe equality comparison (returns true when both sides are null).

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

getField()

getField(fieldName): Column;

Defined in: column.ts:258

Access a field in a StructType column by name.

Parameters

Parameter	Type
fieldName	string

Returns

Column

---

getItem()

getItem(key): Column;

Defined in: column.ts:267

Access an element in an ArrayType or MapType column by key/index.

Parameters

Parameter	Type
key	string | number

Returns

Column

---

gt()

gt(other): Column;

Defined in: column.ts:59

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

gte()

gte(other): Column;

Defined in: column.ts:75

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

ilike()

ilike(pattern): Column;

Defined in: column.ts:325

Case-insensitive LIKE pattern match.

Parameters

Parameter	Type
pattern	string

Returns

Column

---

isin()

isin(...values): Column;

Defined in: column.ts:300

Test whether this column’s value is in the given list.

Parameters

Parameter	Type
…values	(string | number | bigint | boolean | null)[]

Returns

Column

---

isNaN()

isNaN(): Column;

Defined in: column.ts:196

Test whether this column value is NaN.

Returns

Column

---

isNotNull()

isNotNull(): Column;

Defined in: column.ts:191

Test whether this column is not null.

Returns

Column

---

isNull()

isNull(): Column;

Defined in: column.ts:186

Test whether this column is null.

Returns

Column

---

like()

like(pattern): Column;

Defined in: column.ts:316

SQL LIKE pattern match.

Parameters

Parameter	Type
pattern	string

Returns

Column

---

lt()

lt(other): Column;

Defined in: column.ts:63

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

lte()

lte(other): Column;

Defined in: column.ts:79

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

minus()

minus(other): Column;

Defined in: column.ts:99

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

multiply()

multiply(other): Column;

Defined in: column.ts:103

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

neq()

neq(other): Column;

Defined in: column.ts:71

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

or()

or(other): Column;

Defined in: column.ts:89

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

over()

over(windowSpec): Column;

Defined in: column.ts:372

Apply a window specification to this (window function) column.

Parameters

Parameter	Type
windowSpec	WindowSpec

Returns

Column

---

plus()

plus(other): Column;

Defined in: column.ts:95

Parameters

Parameter	Type
other	ColOrLiteral

Returns

Column

---

rlike()

rlike(pattern): Column;

Defined in: column.ts:334

SQL RLIKE (regex) pattern match.

Parameters

Parameter	Type
pattern	string

Returns

Column

---

startsWith()

startsWith(prefix): Column;

Defined in: column.ts:343

Test whether this string column starts with the given prefix.

Parameters

Parameter	Type
prefix	string

Returns

Column

---

substr()

substr(startPos, length): Column;

Defined in: column.ts:243

Extract a substring (1-based position).

Parameters

Parameter	Type
startPos	number
length	number

Returns

Column

---

withField()

withField(fieldName, col): Column;

Defined in: column.ts:276

Add or replace a field in a StructType column.

Parameters

Parameter	Type
fieldName	string
col	Column

Returns

Column