StructField

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()
Source: StructField.scala
Since: 1.3.0

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new StructField()

No-arg constructor for kryo.
No-arg constructor for kryo.

Attributes
protected
new StructField(name: String, dataType: DataType, nullable: Boolean = true, metadata: Metadata = Metadata.empty)

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.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dataType: DataType

The data type of this field.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getComment(): Option[String]

Return the comment of this StructField.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val metadata: Metadata

The metadata of this field.
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.
val name: String

The name of this field.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val nullable: Boolean

Indicates if values of this field can be null values.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toDDL: String

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

Since
2.4.0
def toString(): String

Definition Classes
StructField → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withComment(comment: String): StructField

Updates the StructField with a new comment value.

Related Doc: package types

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

Instance Constructors

new StructField()

new StructField(name: String, dataType: DataType, nullable: Boolean = true, metadata: Metadata = Metadata.empty)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val dataType: DataType

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getComment(): Option[String]

final def isInstanceOf[T0]: Boolean

val metadata: Metadata

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val nullable: Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

def toDDL: String

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withComment(comment: String): StructField

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped