Packages

c

org.apache.spark.sql.types

StructField

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

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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StructField
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StructField()

    No-arg constructor for kryo.

    No-arg constructor for kryo.

    Attributes
    protected
  2. 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

  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 clearCurrentDefaultValue(): StructField

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

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. val dataType: DataType
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getComment(): Option[String]

    Return the comment of this StructField.

  12. def getCurrentDefaultValue(): Option[String]

    Return the current default value of this StructField.

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val metadata: Metadata
  15. val name: String
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. val nullable: Boolean
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. 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, false) will be converted to eventId INT NOT NULL. StructField("eventId", IntegerType, true) will be converted to eventId INT.

    Since

    2.4.0

  22. def toString(): String
    Definition Classes
    StructField → AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. def withComment(comment: String): StructField

    Updates the StructField with a new comment value.

  27. def withCurrentDefaultValue(value: String): StructField

    Updates the StructField with a new current default value.

  28. def withExistenceDefaultValue(value: String): StructField

    Updates the StructField with a new existence default value.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped