Class MapType

All Implemented Interfaces:
Serializable, scala.Equals, scala.Product, scala.Serializable

public class MapType extends DataType implements scala.Product, scala.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:
  • 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.
      keyType - (undocumented)
      valueType - (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
    • simpleString

      public String simpleString()
      Description copied from class: DataType
      Readable string representation for the type.
      simpleString in class DataType
    • catalogString

      public String catalogString()
      Description copied from class: DataType
      String representation for the type saved in external catalogs.
      catalogString in class DataType
    • sql

      public String sql()
      sql in class DataType