pyspark.sql.types.StructType

class pyspark.sql.types.StructType(fields=None)

Struct type, consisting of a list of StructField.

This is the data type representing a Row.

Iterating a StructType will iterate over its StructFields. A contained StructField can be accessed by its name or position.

>>> struct1 = StructType([StructField("f1", StringType(), True)])
>>> struct1["f1"]
StructField(f1,StringType,true)
>>> struct1[0]
StructField(f1,StringType,true)

__init__(fields=None)

>>> struct1 = StructType([StructField("f1", StringType(), True)])
>>> struct2 = StructType([StructField("f1", StringType(), True)])
>>> struct1 == struct2
True
>>> struct1 = StructType([StructField("f1", StringType(), True)])
>>> struct2 = StructType([StructField("f1", StringType(), True),
...     StructField("f2", IntegerType(), False)])
>>> struct1 == struct2
False

Methods

__init__([fields])	>>> struct1 = StructType([StructField("f1", StringType(), True)])
add(field[, data_type, nullable, metadata])	Construct a StructType by adding new elements to it, to define the schema.
fieldNames()	Returns all field names in a list.
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.StructField pyspark.sql.types.TimestampType