Packages

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

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 can have null values.

elementType

The data type of values.

containsNull

Indicates if the array can have null values

Annotations
@Stable()
Source
ArrayType.scala
Since

1.3.0

Linear Supertypes
Serializable, Serializable, Product, Equals, DataType, AbstractDataType, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ArrayType
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DataType
  7. AbstractDataType
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ArrayType()

    No-arg constructor for kryo.

    No-arg constructor for kryo.

    Attributes
    protected
  2. new ArrayType(elementType: DataType, containsNull: Boolean)

    elementType

    The data type of values.

    containsNull

    Indicates if the array can have null values

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def catalogString: String

    String representation for the type saved in external catalogs.

    String representation for the type saved in external catalogs.

    Definition Classes
    ArrayTypeDataType
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  7. val containsNull: Boolean
  8. def defaultSize: Int

    The default size of a value of the ArrayType is the default size of the element type.

    The default size of a value of the ArrayType is the default size of the element type. We assume that there is only 1 element on average in an array. See SPARK-18853.

    Definition Classes
    ArrayTypeDataType
  9. val elementType: DataType
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def json: String

    The compact JSON representation of this data type.

    The compact JSON representation of this data type.

    Definition Classes
    DataType
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. def prettyJson: String

    The pretty (i.e.

    The pretty (i.e. indented) JSON representation of this data type.

    Definition Classes
    DataType
  18. def simpleString: String

    Readable string representation for the type.

    Readable string representation for the type.

    Definition Classes
    ArrayTypeDataType → AbstractDataType
  19. def sql: String
    Definition Classes
    ArrayTypeDataType
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def typeName: String

    Name of the type used in JSON serialization.

    Name of the type used in JSON serialization.

    Definition Classes
    DataType
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DataType

Inherited from AbstractDataType

Inherited from AnyRef

Inherited from Any

Ungrouped