Constructors
Methods
withProject
Parameters
- expressions: Expression[]
Optionalinput: Relation
withFilter
Parameters
- condition: Expression
Optionalinput: Relation
withLocalRelation
Parameters
- localRelation: LocalRelation
withRange
withRange( start: bigint, end: bigint, step: bigint, numPartitions?: number,): RelationBuilder Parameters
- start: bigint
- end: bigint
- step: bigint
OptionalnumPartitions: number
withReadDataSource
withReadDataSource( format: undefined | string, schema: undefined | string, paths: string[], predicates: string[], options: CaseInsensitiveMap<string>, isStreaming?: boolean,): RelationBuilder Parameters
- format: undefined | string
- schema: undefined | string
- paths: string[]
- predicates: string[]
- options: CaseInsensitiveMap<string>
- isStreaming: boolean = false
withLimit
Parameters
- limit: number
Optionalinput: Relation
withOffset
Parameters
- offset: number
Optionalinput: Relation
withTail
Parameters
- limit: number
Optionalinput: Relation
withToDf
Parameters
- columns: string[]
Optionalinput: Relation
withShowString
withShowString( numRows: number, truncate: number, vertical: boolean, input?: Relation,): RelationBuilder Parameters
- numRows: number
- truncate: number
- vertical: boolean
Optionalinput: Relation
withCatalog
withCatalog(catalog: Catalog): void
withHint
withHint(name: string, parameters: any[], input?: Relation): RelationBuilder Parameters
- name: string
- parameters: any[]
Optionalinput: Relation
withUnpivot
withUnpivot( ids: Column[], variableColumnName: string, valueColumnName: string, values?: Column[], input?: Relation,): RelationBuilder Parameters
- ids: Column[]
- variableColumnName: string
- valueColumnName: string
Optionalvalues: Column[]Optionalinput: Relation
withTranspose
Parameters
OptionalindexColumn: ColumnOptionalinput: Relation
withSetOperation
withSetOperation( left?: Relation, right?: Relation, operation?: string, isAll?: boolean, byName?: boolean, allowMissingColumns?: boolean,): RelationBuilder Parameters
Optionalleft: RelationOptionalright: RelationOptionaloperation: stringOptionalisAll: booleanOptionalbyName: booleanOptionalallowMissingColumns: boolean
withJoin
withJoin( left?: Relation, right?: Relation, joinCondition?: Expression, joinType?: string, usingColumns?: string[],): RelationBuilder Parameters
Optionalleft: RelationOptionalright: RelationOptionaljoinCondition: ExpressionOptionaljoinType: stringOptionalusingColumns: string[]
withAsOfJoin
withAsOfJoin( left?: Relation, right?: Relation, leftAsOf?: Expression, rightAsOf?: Expression, joinExpr?: Expression, usingColumns?: string[], joinType?: string, tolerance?: Expression, allowExactMatches?: boolean, direction?: string,): RelationBuilder Parameters
Optionalleft: RelationOptionalright: RelationOptionalleftAsOf: ExpressionOptionalrightAsOf: ExpressionOptionaljoinExpr: ExpressionOptionalusingColumns: string[]OptionaljoinType: stringOptionaltolerance: ExpressionOptionalallowExactMatches: booleanOptionaldirection: string
withLateralJoin
withLateralJoin( left?: Relation, right?: Relation, joinType?: string, condition?: Expression,): RelationBuilder Parameters
Optionalleft: RelationOptionalright: RelationOptionaljoinType: stringOptionalcondition: Expression
withRepartition
withRepartition( numPartitions: number, shuffle: boolean, input?: Relation,): RelationBuilder Parameters
- numPartitions: number
- shuffle: boolean
Optionalinput: Relation
withRepartitionByExpression
withRepartitionByExpression( partitionExprs: Expression[], numPartitions?: number, input?: Relation,): RelationBuilder Parameters
- partitionExprs: Expression[]
OptionalnumPartitions: numberOptionalinput: Relation
withStatCov
Parameters
- col1: string
- col2: string
Optionalinput: Relation
withStatCorr
withStatCorr( col1: string, col2: string, method?: string, input?: Relation,): RelationBuilder Parameters
- col1: string
- col2: string
Optionalmethod: stringOptionalinput: Relation
withStatCrosstab
withStatCrosstab(col1: string, col2: string, input?: Relation): RelationBuilder Parameters
- col1: string
- col2: string
Optionalinput: Relation
withStatFreqItems
withStatFreqItems( cols: string[], support?: number, input?: Relation,): RelationBuilder Parameters
- cols: string[]
Optionalsupport: numberOptionalinput: Relation
withStatSampleBy
withStatSampleBy( col: Column, fractions: Map<any, number>, seed?: number, input?: Relation,): RelationBuilder Parameters
- col: Column
- fractions: Map<any, number>
Optionalseed: numberOptionalinput: Relation
withStatApproxQuantile
withStatApproxQuantile( cols: string[], probabilities: number[], relativeError: number, input?: Relation,): RelationBuilder Parameters
- cols: string[]
- probabilities: number[]
- relativeError: number
Optionalinput: Relation
withNAFill
withNAFill( cols: undefined | string[], values: (
string | number | boolean)
[], input?: Relation,): RelationBuilder Parameters
- cols: undefined | string[]
- values: (string | number | boolean)[]
Optionalinput: Relation
withNADrop
withNADrop( cols: undefined | string[], minNonNulls: undefined | number, input?: Relation,): RelationBuilder Parameters
- cols: undefined | string[]
- minNonNulls: undefined | number
Optionalinput: Relation
withNAReplace
withNAReplace( cols: undefined | string[], replacementMap: { [key: string]: null | string | number | boolean }, input?: Relation,): RelationBuilder Parameters
- cols: undefined | string[]
- replacementMap: { [key: string]: null | string | number | boolean }
Optionalinput: Relation
withMapPartitions
Parameters
- pythonCode: string
- outputSchema: StructType
Optionalinput: Relation- pythonVersion: string = '3.11'
withGroupMap
withGroupMap( groupingExpressions: Expression[], pythonCode: string, outputSchema: StructType, input?: Relation, pythonVersion?: string,): RelationBuilder Parameters
- groupingExpressions: Expression[]
- pythonCode: string
- outputSchema: StructType
Optionalinput: Relation- pythonVersion: string = '3.11'
withCoGroupMap
withCoGroupMap( input: Relation, inputGroupingExpressions: Expression[], other: Relation, otherGroupingExpressions: Expression[], pythonCode: string, outputSchema: StructType, pythonVersion?: string,): RelationBuilder Parameters
- input: Relation
- inputGroupingExpressions: Expression[]
- other: Relation
- otherGroupingExpressions: Expression[]
- pythonCode: string
- outputSchema: StructType
- pythonVersion: string = '3.11'