StructField

class pyspark.sql.types.StructField(name, dataType, nullable=True, metadata=None)[source]

A field in StructType.

Parameters
  • name – string, name of the field.

  • dataTypeDataType of the field.

  • nullable – boolean, whether the field can be null (None) or not.

  • metadata – a dict from string to simple type that can be toInternald to JSON automatically

Methods

Methods Documentation

fromInternal(obj)[source]

Converts an internal SQL object into a native Python object.

classmethod fromJson(json)[source]
json()
jsonValue()[source]
needConversion()[source]

Does this type needs conversion between Python object and internal SQL object.

This is used to avoid the unnecessary conversion for ArrayType/MapType/StructType.

simpleString()[source]
toInternal(obj)[source]

Converts a Python object into an internal SQL object.

typeName()[source]