StringType

class pyspark.sql.types.StringType(collation=None)

String data type.

Parameters

collationstr

name of the collation, default is UTF8_BINARY.

Methods

collationIdToName(collationId)
collationNameToId(collationName)
collationProvider(collationName)
fromCollationId(collationId)
fromDDL(ddl)	Creates DataType for a given DDL-formatted string.
fromInternal(obj)	Converts an internal SQL object into a native Python object.
isUTF8BinaryCollation()
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()

Attributes

collationNames
providerICU
providerSpark
providers

Methods Documentation

classmethod collationIdToName(collationId)

classmethod collationNameToId(collationName)

classmethod collationProvider(collationName)

classmethod fromCollationId(collationId)

classmethod fromDDL(ddl)

Creates DataType for a given DDL-formatted string.

New in version 4.0.0.

Parameters

ddlstr

DDL-formatted string representation of types, e.g. pyspark.sql.types.DataType.simpleString, except that top level struct type can omit the struct<> for the compatibility reason with spark.createDataFrame and Python UDFs.

Returns

DataType

Examples

Create a StructType by the corresponding DDL formatted string.

>>> from pyspark.sql.types import DataType
>>> DataType.fromDDL("b string, a int")
StructType([StructField('b', StringType(), True), StructField('a', IntegerType(), True)])

Create a single DataType by the corresponding DDL formatted string.

>>> DataType.fromDDL("decimal(10,10)")
DecimalType(10,10)

Create a StructType by the legacy string format.

>>> DataType.fromDDL("b: string, a: int")
StructType([StructField('b', StringType(), True), StructField('a', IntegerType(), True)])

fromInternal(obj)

Converts an internal SQL object into a native Python object.

isUTF8BinaryCollation()

json()

jsonValue()

needConversion()

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()

toInternal(obj)

Converts a Python object into an internal SQL object.

classmethod typeName()

Attributes Documentation

collationNames = ['UTF8_BINARY', 'UTF8_BINARY_LCASE', 'UNICODE', 'UNICODE_CI']

providerICU = 'icu'

providerSpark = 'spark'

providers = ['spark', 'icu']