Interface StructNamespace

Struct functions for Lazy datatframes

interface StructNamespace {
    field(name: string): pl.Expr;
    nth(index: number): pl.Expr;
    renameFields(names: string[]): pl.Expr;
    withFields(fields: pl.Expr[]): pl.Expr;
}

Index

Methods

field nth renameFields withFields

Methods

field

field(name: string): pl.Expr
Access a field by name
Parameters
- name: string
  name of the field
Returns pl.Expr
- Defined in polars/lazy/expr/struct.ts:12

nth

nth(index: number): pl.Expr
Access a field by index (zero based index)
Parameters
- index: number
  index of the field (starts at 0)
Returns pl.Expr
- Defined in polars/lazy/expr/struct.ts:17

renameFields

renameFields(names: string[]): pl.Expr
Rename the fields of a struct
Parameters
- names: string[]
  new names of the fields
Returns pl.Expr
- Defined in polars/lazy/expr/struct.ts:22

withFields

withFields(fields: pl.Expr[]): pl.Expr
Add/replace fields in a struct
Parameters
- fields: pl.Expr[]
Returns pl.Expr
- Defined in polars/lazy/expr/struct.ts:27