Class DataTypes

constructor

• new DataTypes(): DataTypes

  Returns DataTypes

Static ReadonlyNullType

Static ReadonlyBooleanType

Static ReadonlyByteType

Static ReadonlyShortType

Static ReadonlyIntegerType

Static ReadonlyLongType

Static ReadonlyFloatType

Static ReadonlyDoubleType

Static ReadonlyStringType

Static ReadonlyBinaryType

Static ReadonlyVariantType

Static ReadonlyDateType

Static ReadonlyTimestampType

Static ReadonlyTimestampNTZType

Static ReadonlyCalendarIntervalType

StaticcreateDecimalType

• createDecimalType(precision?: number, scale?: number): DecimalType

  Parameters

  • Optionalprecision: number
  • Optionalscale: number

  Returns DecimalType

StaticcreateStringType

• createStringType(collation?: string): StringType

  Parameters

  • Optionalcollation: string

  Returns StringType

StaticcreateCharType

• createCharType(length: number): CharType

  Parameters

  • length: number

  Returns CharType

StaticcreateVarCharType

• createVarCharType(length: number): VarcharType

  Parameters

  • length: number

  Returns VarcharType

StaticcreateDayTimeIntervalType

• createDayTimeIntervalType(
      startField?: number,
      endField?: number,
  ): DayTimeIntervalType

  Parameters

  • startField: number = DayTimeIntervalType.DAY
  • endField: number = DayTimeIntervalType.SECOND

  Returns DayTimeIntervalType

StaticcreateYearMonthIntervalType

• createYearMonthIntervalType(
      startField?: number,
      endField?: number,
  ): YearMonthIntervalType

  Parameters

  • startField: number = YearMonthIntervalType.YEAR
  • endField: number = YearMonthIntervalType.MONTH

  Returns YearMonthIntervalType

StaticcreateArrayType

• createArrayType(elementType: DataType, containsNull?: boolean): ArrayType

  Parameters

  • elementType: DataType
  • containsNull: boolean = true

  Returns ArrayType

StaticcreateMapType

• createMapType(
      keyType: DataType,
      valueType: DataType,
      valueContainsNull?: boolean,
  ): MapType

  Parameters

  • keyType: DataType
  • valueType: DataType
  • valueContainsNull: boolean = true

  Returns MapType

StaticcreateStructField

• createStructField(
      name: string,
      dataType: DataType,
      nullable: boolean,
      metadata?: Metadata,
  ): StructField

  Parameters

  • name: string
  • dataType: DataType
  • nullable: boolean
  • metadata: Metadata = ...

  Returns StructField

StaticcreateStructType

• createStructType(fields: StructField[]): StructType

  Parameters

  • fields: StructField[]

  Returns StructType

StaticcreateUnparsedType

• createUnparsedType(typeName: string): UnparsedDataType

  Parameters

  • typeName: string

  Returns UnparsedDataType

StaticfromProtoType

• fromProtoType(proto: DataType): DataType

  Parameters

  • proto: DataType

  Returns DataType

StatictoProtoType

• toProtoType(dt: DataType): DataType

  Parameters

  • dt: DataType

  Returns DataType

StaticfromArrowType

• fromArrowType(dt: Type): DataType

  Parameters

  • dt: Type

  Returns DataType

StaticfromArrowField

• fromArrowField(field: Field): DataType

  Parameters

  • field: Field

  Returns DataType

StaticfromArrowSchema

• fromArrowSchema(schema: Schema): StructType

  Convert an Arrow Schema to Spark Schema

  Parameters

  • schema: Schema

    an Arrow Schema

  Returns StructType

  a Spark StructType

  Throws

  if the data type is not supported

StatictoArrowType

• toArrowType(dt: DataType): DataType

  Convert a Spark DataType to Arrow DataType

  Parameters

  • dt: DataType

    a Spark DataType

  Returns DataType

  an Arrow DataType

  Throws

  if the data type is not supported

StatictoArrowSchema

• toArrowSchema<T extends TypeMap>(schema: StructType): Schema<T>

  Convert a Spark Schema to Arrow Schema

  Type Parameters

  • T extends TypeMap

  Parameters

  • schema: StructType

    a Spark StructType

  Returns Schema<T>

  an Arrow Schema

  Throws

  if the data type is not supported