Package org.apache.spark.sql.types

Class ArrayType

Object

org.apache.spark.sql.types.DataType

org.apache.spark.sql.types.ArrayType

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

public class ArrayType
extends DataType
implements scala.Product, Serializable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ArrayType(DataType elementType, boolean containsNull)

Method Summary

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

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

ArrayType

public ArrayType(DataType elementType,
 boolean containsNull)

Method Details

apply

public static ArrayType apply(DataType elementType)

Construct a ArrayType object with the given element type. The containsNull is true.

Parameters:

elementType - (undocumented)

Returns:

(undocumented)

elementType

public DataType elementType()

containsNull

public boolean containsNull()

defaultSize

public int defaultSize()

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.

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 ArrayType 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