types

Type Members

1. case class ArrayType(elementType: DataType, containsNull: Boolean) extends DataType with Product with Serializable

   

   The data type for collections of multiple values.

   The data type for collections of multiple values. Internally these are represented as columns that contain a scala.collection.Seq.

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

   An ArrayType object comprises two fields, elementType: DataType and containsNull: Boolean. The field of elementType is used to specify the type of array elements. The field of containsNull is used to specify if the array has null values.

   elementType

   The data type of values.

   containsNull

   Indicates if values have null values

   Annotations

   @Stable()

   Since

   1.3.0

2. abstract class AtomicType extends DataType

   

   An internal type used to represent everything that is not null, UDTs, arrays, structs, and maps.

   An internal type used to represent everything that is not null, UDTs, arrays, structs, and maps.

   Attributes

   protected[org.apache.spark.sql]

3. class BinaryType extends AtomicType

   

   The data type representing Array[Byte] values.

   The data type representing Array[Byte] values. Please use the singleton DataTypes.BinaryType.

   Annotations

   @Stable()

4. class BooleanType extends AtomicType

   

   The data type representing Boolean values.

   The data type representing Boolean values. Please use the singleton DataTypes.BooleanType.

   Annotations

   @Stable()

   Since

   1.3.0

5. class ByteType extends IntegralType

   

   The data type representing Byte values.

   The data type representing Byte values. Please use the singleton DataTypes.ByteType.

   Annotations

   @Stable()

   Since

   1.3.0

6. class CalendarIntervalType extends DataType

   

   The data type representing calendar time intervals.

   The data type representing calendar time intervals. The calendar time interval is stored internally in two components: number of months the number of microseconds.

   Please use the singleton DataTypes.CalendarIntervalType.

   Annotations

   @Stable()

   Since

   1.5.0

   Note

   Calendar intervals are not comparable.

7. abstract class DataType extends AbstractDataType

   

   The base type of all Spark SQL data types.

   The base type of all Spark SQL data types.

   Annotations

   @Stable()

   Since

   1.3.0

8. class DataTypes extends AnyRef

   

9. class DateType extends AtomicType

   

   A date type, supporting "0001-01-01" through "9999-12-31".

   A date type, supporting "0001-01-01" through "9999-12-31".

   Please use the singleton DataTypes.DateType.

   Internally, this is represented as the number of days from 1970-01-01.

   Annotations

   @Stable()

   Since

   1.3.0

10. final class Decimal extends Ordered[Decimal] with Serializable

    

    A mutable implementation of BigDecimal that can hold a Long if values are small enough.

    A mutable implementation of BigDecimal that can hold a Long if values are small enough.

    The semantics of the fields are as follows: - _precision and _scale represent the SQL precision and scale we are looking for - If decimalVal is set, it represents the whole decimal value - Otherwise, the decimal value is longVal / (10 ** _scale)

    Annotations

    @Unstable()

11. case class DecimalType(precision: Int, scale: Int) extends FractionalType with Product with Serializable

    

    The data type representing java.math.BigDecimal values.

    The data type representing java.math.BigDecimal values. A Decimal that must have fixed precision (the maximum number of digits) and scale (the number of digits on right side of dot).

    The precision can be up to 38, scale can also be up to 38 (less or equal to precision).

    The default precision and scale is (10, 0).

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

    Annotations

    @Stable()

    Since

    1.3.0

12. class DoubleType extends FractionalType

    

    The data type representing Double values.

    The data type representing Double values. Please use the singleton DataTypes.DoubleType.

    Annotations

    @Stable()

    Since

    1.3.0

13. class FloatType extends FractionalType

    

    The data type representing Float values.

    The data type representing Float values. Please use the singleton DataTypes.FloatType.

    Annotations

    @Stable()

    Since

    1.3.0

14. class IntegerType extends IntegralType

    

    The data type representing Int values.

    The data type representing Int values. Please use the singleton DataTypes.IntegerType.

    Annotations

    @Stable()

    Since

    1.3.0

15. class LongType extends IntegralType

    

    The data type representing Long values.

    The data type representing Long values. Please use the singleton DataTypes.LongType.

    Annotations

    @Stable()

    Since

    1.3.0

16. case class MapType(keyType: DataType, valueType: DataType, valueContainsNull: Boolean) extends DataType with Product with Serializable

    

    The data type for Maps.

    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.

    keyType

    The data type of map keys.

    valueType

    The data type of map values.

    valueContainsNull

    Indicates if map values have null values.

    Annotations

    @Stable()

17. sealed class Metadata extends Serializable

    

    Metadata is a wrapper over Map[String, Any] that limits the value type to simple ones: Boolean, Long, Double, String, Metadata, Array[Boolean], Array[Long], Array[Double], Array[String], and Array[Metadata].

    Metadata is a wrapper over Map[String, Any] that limits the value type to simple ones: Boolean, Long, Double, String, Metadata, Array[Boolean], Array[Long], Array[Double], Array[String], and Array[Metadata]. JSON is used for serialization.

    The default constructor is private. User should use either MetadataBuilder or Metadata.fromJson() to create Metadata instances.

    Annotations

    @Stable()

    Since

    1.3.0

18. class MetadataBuilder extends AnyRef

    

    Builder for Metadata.

    Builder for Metadata. If there is a key collision, the latter will overwrite the former.

    Annotations

    @Stable()

    Since

    1.3.0

19. class NullType extends DataType

    

    The data type representing NULL values.

    The data type representing NULL values. Please use the singleton DataTypes.NullType.

    Annotations

    @Stable()

    Since

    1.3.0

20. abstract class NumericType extends AtomicType

    

    Numeric data types.

    Numeric data types.

    Annotations

    @Stable()

    Since

    1.3.0

21. case class ObjectType(cls: Class[_]) extends DataType with Product with Serializable

    

    Represents a JVM object that is passing through Spark SQL expression evaluation.

    Represents a JVM object that is passing through Spark SQL expression evaluation.

    Annotations

    @Evolving()

22. class SQLUserDefinedType extends Annotation with Annotation with ClassfileAnnotation

    

23. class ShortType extends IntegralType

    

    The data type representing Short values.

    The data type representing Short values. Please use the singleton DataTypes.ShortType.

    Annotations

    @Stable()

    Since

    1.3.0

24. class StringType extends AtomicType

    

    The data type representing String values.

    The data type representing String values. Please use the singleton DataTypes.StringType.

    Annotations

    @Stable()

    Since

    1.3.0

25. case class StructField(name: String, dataType: DataType, nullable: Boolean = true, metadata: Metadata = Metadata.empty) extends Product with Serializable

    

    A field inside a StructType.

    A field inside a StructType.

    name

    The name of this field.

    dataType

    The data type of this field.

    nullable

    Indicates if values of this field can be null values.

    metadata

    The metadata of this field. The metadata should be preserved during transformation if the content of the column is not modified, e.g, in selection.

    Annotations

    @Stable()

    Since

    1.3.0

26. case class StructType(fields: Array[StructField]) extends DataType with Seq[StructField] with Product with Serializable

    

    A StructType object can be constructed by

    A StructType object can be constructed by

    StructType(fields: Seq[StructField])

    For a StructType object, one or multiple StructFields can be extracted by names. If multiple StructFields are extracted, a StructType object will be returned. If a provided name does not have a matching field, it will be ignored. For the case of extracting a single StructField, a null will be returned. Example:

    import org.apache.spark.sql._
    import org.apache.spark.sql.types._
    
    val struct =
      StructType(
        StructField("a", IntegerType, true) ::
        StructField("b", LongType, false) ::
        StructField("c", BooleanType, false) :: Nil)
    
    // Extract a single StructField.
    val singleField = struct("b")
    // singleField: StructField = StructField(b,LongType,false)
    
    // This struct does not have a field called "d". null will be returned.
    val nonExisting = struct("d")
    // nonExisting: StructField = null
    
    // Extract multiple StructFields. Field names are provided in a set.
    // A StructType object will be returned.
    val twoFields = struct(Set("b", "c"))
    // twoFields: StructType =
    //   StructType(List(StructField(b,LongType,false), StructField(c,BooleanType,false)))
    
    // Any names without matching fields will be ignored.
    // For the case shown below, "d" will be ignored and
    // it is treated as struct(Set("b", "c")).
    val ignoreNonExisting = struct(Set("b", "c", "d"))
    // ignoreNonExisting: StructType =
    //   StructType(List(StructField(b,LongType,false), StructField(c,BooleanType,false)))

    A org.apache.spark.sql.Row object is used as a value of the StructType. Example:

    import org.apache.spark.sql._
    
    val innerStruct =
      StructType(
        StructField("f1", IntegerType, true) ::
        StructField("f2", LongType, false) ::
        StructField("f3", BooleanType, false) :: Nil)
    
    val struct = StructType(
      StructField("a", innerStruct, true) :: Nil)
    
    // Create a Row with the schema defined by struct
    val row = Row(Row(1, 2, true))
    // row: Row = [[1,2,true]]

    Annotations

    @Stable()

    Since

    1.3.0

27. class TimestampType extends AtomicType

    

    The data type representing java.sql.Timestamp values.

    The data type representing java.sql.Timestamp values. Please use the singleton DataTypes.TimestampType.

    Annotations

    @Stable()

    Since

    1.3.0