pyspark.sql.types.StructField

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

A field in StructType.

Parameters

  • name – string, name of the field.

  • dataType – DataType 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

__init__(name, dataType, nullable=True, metadata=None)[source]
>>> (StructField("f1", StringType(), True)
...      == StructField("f1", StringType(), True))
True
>>> (StructField("f1", StringType(), True)
...      == StructField("f2", StringType(), True))
False

Methods

__init__(name, dataType[, nullable, metadata])

 

>>> (StructField("f1", StringType(), True)

fromInternal(obj)

Converts an internal SQL object into a native Python object.

fromJson(json)

json()

jsonValue()

needConversion()

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

simpleString()

toInternal(obj)

Converts a Python object into an internal SQL object.

typeName()

pyspark.sql.types.StringType pyspark.sql.types.StructType