Package org.apache.spark.sql.types

Class MapType

Object

org.apache.spark.sql.types.DataType

org.apache.spark.sql.types.MapType

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

public class MapType
extends DataType
implements scala.Product, Serializable

The data type for Maps. Keys in a map are not allowed to have null values.

Please use DataTypes.createMapType() to create a specific instance.

param: keyType The data type of map keys. param: valueType The data type of map values. param: valueContainsNull Indicates if map values have null values.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MapType()	No-arg constructor for kryo.
MapType(DataType keyType, DataType valueType, boolean valueContainsNull)

Method Summary

Modifier and Type	Method	Description
static MapType	apply(DataType keyType, DataType valueType)	Construct a MapType object with the given key type and value type.
String	catalogString()	String representation for the type saved in external catalogs.
int	defaultSize()	The default size of a value of the MapType is (the default size of the key type + the default size of the value type).
DataType	keyType()
String	simpleString()	Readable string representation for the type.
String	sql()
MapType	toNullable()	Returns the same data type but set all nullability fields are true (StructField.nullable, ArrayType.containsNull, and MapType.valueContainsNull).
boolean	valueContainsNull()
DataType	valueType()

Methods inherited from class org.apache.spark.sql.types.DataType

COLLATIONS_METADATA_KEY, equalsIgnoreCaseAndNullability, equalsIgnoreNullability, equalsStructurally, equalsStructurallyByName, fromDDL, fromJson, json, parseTypeWithFallback, prettyJson, typeName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details

MapType

public MapType(DataType keyType,
 DataType valueType,
 boolean valueContainsNull)

MapType

public MapType()

No-arg constructor for kryo.

Method Details

apply

public static MapType apply(DataType keyType,
 DataType valueType)

Construct a MapType object with the given key type and value type. The valueContainsNull is true.

Parameters:

keyType - (undocumented)

valueType - (undocumented)

Returns:

(undocumented)

keyType

public DataType keyType()

valueType

public DataType valueType()

valueContainsNull

public boolean valueContainsNull()

defaultSize

public int defaultSize()

The default size of a value of the MapType is (the default size of the key type + the default size of the value type). We assume that there is only 1 element on average in a map. See SPARK-18853.

Specified by:

defaultSize in class DataType

Returns:

(undocumented)

simpleString

public String simpleString()

Description copied from class: DataType

Readable string representation for the type.

Overrides:

simpleString in class DataType

catalogString

public String catalogString()

Description copied from class: DataType

String representation for the type saved in external catalogs.

Overrides:

catalogString in class DataType

sql

public String sql()

Overrides:

sql in class DataType

toNullable

public MapType toNullable()

Returns the same data type but set all nullability fields are true (StructField.nullable, ArrayType.containsNull, and MapType.valueContainsNull).

Returns:

(undocumented)

Since:

4.0.0