when

function when(condition, value): WhenBuilder;

Defined in: functions/conditional.ts:21

Begins a CASE WHEN chain. Returns a WhenBuilder. Terminate the chain with WhenBuilder.otherwise for an explicit default, or WhenBuilder.toColumn for a NULL default.

Parameters

Parameter	Type
condition	Column
value	Column

Returns

WhenBuilder

Example

when(col("age").gt(lit(18)), lit("adult"))
    .when(col("age").gt(lit(12)), lit("teen"))
    .otherwise(lit("child"))