Class GroupBy<S, K>

Type Parameters

S extends Row = Row
K extends keyof S & string = keyof S & string

Index

Constructors

constructor

Methods

agg count max mean median min nunique std sum var

Constructors

constructor

new GroupBy<S extends Row = Row, K extends string = keyof S & string>(
    input: PlanNode,
    keys: K[],
    runtime: Runtime,
): GroupBy<S, K>
Type Parameters
- S extends Row = Row
- K extends string = keyof S & string
Parameters
- input: PlanNode
- keys: K[]
- runtime: Runtime
Returns GroupBy<S, K>
- Defined in core/dist/index.d.ts:794

Methods

agg

agg<A extends Record<string, AnyExpr | AggKind>>(
    spec: A | ((c: ColRefs<S>) => A),
): LazyFrame<
    { [K in string
    | number
    | symbol]: (Pick<S, K> & AggResult<A>)[K] },
>
Aggregate per group. Result columns: the keys, then one column per entry (its type from the expression, number for AggKind names).
Type Parameters
- A extends Record<string, AnyExpr | AggKind>
Parameters
- spec: A | ((c: ColRefs<S>) => A)
Returns LazyFrame<{ [K in string | number | symbol]: (Pick<S, K> & AggResult<A>)[K] }>
- Defined in core/dist/index.d.ts:796
agg(
    spec:
        | Record<string, AnyExpr | AggKind | AggKind[]>
        | ((c: ColRefs<S>) => Record<string, AggKind | AnyExpr | AggKind[]>),
): LazyFrame<Row>
Aggregate per group. Result columns: the keys, then one column per entry (its type from the expression, number for AggKind names).
Parameters
- spec:
  | Record<string, AnyExpr | AggKind | AggKind[]>
  | ((c: ColRefs<S>) => Record<string, AggKind | AnyExpr | AggKind[]>)
Returns LazyFrame<Row>
- Defined in core/dist/index.d.ts:797

count

count(): LazyFrame<{ [K in string]: (Pick<S, K> & { count: number })[K] }>
Row count per group as column count.

Returns LazyFrame<{ [K in string]: (Pick<S, K> & { count: number })[K] }>
- Defined in core/dist/index.d.ts:799

max

max(columns?: string[]): LazyFrame<Row>
Max of non-key numeric columns (or columns if given).
Parameters
- Optionalcolumns: string[]
Returns LazyFrame<Row>
- Defined in core/dist/index.d.ts:809

mean

mean(columns?: string[]): LazyFrame<Row>
Mean of non-key numeric columns (or columns if given).
Parameters
- Optionalcolumns: string[]
Returns LazyFrame<Row>
- Defined in core/dist/index.d.ts:805

median

median(columns?: string[]): LazyFrame<Row>
Parameters
- Optionalcolumns: string[]
Returns LazyFrame<Row>
- Defined in core/dist/index.d.ts:813

min

min(columns?: string[]): LazyFrame<Row>
Min of non-key numeric columns (or columns if given).
Parameters
- Optionalcolumns: string[]
Returns LazyFrame<Row>
- Defined in core/dist/index.d.ts:807

nunique

nunique(columns?: string[]): LazyFrame<Row>
Parameters
- Optionalcolumns: string[]
Returns LazyFrame<Row>
- Defined in core/dist/index.d.ts:812

std

std(columns?: string[]): LazyFrame<Row>
Parameters
- Optionalcolumns: string[]
Returns LazyFrame<Row>
- Defined in core/dist/index.d.ts:810

sum

sum(columns?: string[]): LazyFrame<Row>
Sum of non-key numeric columns (or columns if given).
Parameters
- Optionalcolumns: string[]
Returns LazyFrame<Row>
- Defined in core/dist/index.d.ts:803

var

var(columns?: string[]): LazyFrame<Row>
Parameters
- Optionalcolumns: string[]
Returns LazyFrame<Row>
- Defined in core/dist/index.d.ts:811

Class GroupBy<S, K>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GroupBy<S, K>

Methods

agg

Type Parameters

Parameters

Returns LazyFrame<{ [K in string | number | symbol]: (Pick<S, K> & AggResult<A>)[K] }>

Parameters

Returns LazyFrame<Row>

count

Returns LazyFrame<{ [K in string]: (Pick<S, K> & { count: number })[K] }>

max

Parameters

Returns LazyFrame<Row>

mean

Parameters

Returns LazyFrame<Row>

median

Parameters

Returns LazyFrame<Row>

min

Parameters

Returns LazyFrame<Row>

nunique

Parameters

Returns LazyFrame<Row>

std

Parameters

Returns LazyFrame<Row>

sum

Parameters

Returns LazyFrame<Row>

var

Parameters

Returns LazyFrame<Row>

Settings

On This Page