Package org.apache.spark.sql.types

Class StructField

Object

org.apache.spark.sql.types.StructField

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

public class StructField
extends Object
implements scala.Product, Serializable

A field inside a StructType. param: name The name of this field. param: dataType The data type of this field. param: nullable Indicates if values of this field can be null values. param: 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.

Since:

1.3.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StructField(String name, DataType dataType, boolean nullable, Metadata metadata)

Method Summary

Modifier and Type	Method	Description
abstract static R	apply(T1 v1, T2 v2, T3 v3, T4 v4)
StructField	clearCurrentDefaultValue()	Clears the StructField of its current default value, if any.
DataType	dataType()
scala.Option<String>	getComment()	Return the comment of this StructField.
scala.Option<String>	getCurrentDefaultValue()	Return the current default value of this StructField.
Metadata	metadata()
String	name()
boolean	nullable()
String	toDDL()	Returns a string containing a schema in DDL format.
String	toString()
StructField	withComment(String comment)	Updates the StructField with a new comment value.
StructField	withCurrentDefaultValue(String value)	Updates the StructField with a new current default value.
StructField	withExistenceDefaultValue(String value)	Updates the StructField with a new existence default value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, 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

StructField

public StructField(String name,
 DataType dataType,
 boolean nullable,
 Metadata metadata)

Method Details

apply

public abstract static R apply(T1 v1,
 T2 v2,
 T3 v3,
 T4 v4)

name

public String name()

dataType

public DataType dataType()

nullable

public boolean nullable()

metadata

public Metadata metadata()

toString

public String toString()

Overrides:

toString in class Object

withComment

public StructField withComment(String comment)

Updates the StructField with a new comment value.

Parameters:

comment - (undocumented)

Returns:

(undocumented)

getComment

public scala.Option<String> getComment()

Return the comment of this StructField.

Returns:

(undocumented)

withCurrentDefaultValue

public StructField withCurrentDefaultValue(String value)

Updates the StructField with a new current default value.

Parameters:

value - (undocumented)

Returns:

(undocumented)

clearCurrentDefaultValue

public StructField clearCurrentDefaultValue()

Clears the StructField of its current default value, if any.

Returns:

(undocumented)

getCurrentDefaultValue

public scala.Option<String> getCurrentDefaultValue()

Return the current default value of this StructField.

It is present only when the field represents a table column with a default value, such as: ALTER TABLE t ALTER COLUMN c SET DEFAULT 42.

Returns:

(undocumented)

withExistenceDefaultValue

public StructField withExistenceDefaultValue(String value)

Updates the StructField with a new existence default value.

Parameters:

value - (undocumented)

Returns:

(undocumented)

toDDL

public String toDDL()

Returns a string containing a schema in DDL format. For example, the following value: StructField("eventId", IntegerType, false) will be converted to eventId INT NOT NULL. StructField("eventId", IntegerType, true) will be converted to eventId INT.

Returns:

(undocumented)

Since:

2.4.0