Spark 3.2.0 ScalaDoc < Back

Packages

package root

Definition Classes
root
package org

Definition Classes
root
package apache

Definition Classes
org
package spark
Core Spark functionality.
Core Spark functionality. org.apache.spark.SparkContext serves as the main entry point to Spark, while org.apache.spark.rdd.RDD is the data type representing a distributed collection, and provides most parallel operations.
In addition, org.apache.spark.rdd.PairRDDFunctions contains operations available only on RDDs of key-value pairs, such as groupByKey and join; org.apache.spark.rdd.DoubleRDDFunctions contains operations available only on RDDs of Doubles; and org.apache.spark.rdd.SequenceFileRDDFunctions contains operations available on RDDs that can be saved as SequenceFiles. These operations are automatically available on any RDD of the right type (e.g. RDD[(Int, Int)] through implicit conversions.
Java programmers should reference the org.apache.spark.api.java package for Spark programming APIs in Java.
Classes and methods marked with Experimental are user-facing features which have not been officially adopted by the Spark project. These are subject to change or removal in minor releases.
Classes and methods marked with Developer API are intended for advanced users want to extend Spark through lower level interfaces. These are subject to changes or removal in minor releases.

Definition Classes
apache
package sql
Allows the execution of relational queries, including those expressed in SQL using Spark.
Allows the execution of relational queries, including those expressed in SQL using Spark.

Definition Classes
spark
package types
Contains a type system for attributes produced by relations, including complex types like structs, arrays and maps.
Contains a type system for attributes produced by relations, including complex types like structs, arrays and maps.

Definition Classes
sql
AnyDataType
ArrayType
AtomicType
BinaryType
BooleanType
ByteType
CalendarIntervalType
CharType
DataType
DataTypes
DateType
DayTimeIntervalType
Decimal
DecimalType
DoubleType
FloatType
IntegerType
LongType
MapType
Metadata
MetadataBuilder
NullType
NumericType
ObjectType
SQLUserDefinedType
ShortType
StringType
StructField
StructType
TimestampType
UDTRegistration
UserDefinedType
VarcharType
YearMonthIntervalType

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

Alphabetic
By Inheritance

Inherited

StructField
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

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[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
val dataType: DataType
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
Annotations
@native()
def getComment(): Option[String]
Return the comment of this StructField.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val metadata: Metadata
val name: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
val nullable: Boolean
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, false) will be converted to eventId INT NOT NULL. StructField("eventId", IntegerType, true) 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( ... ) @native()
def withComment(comment: String): StructField
Updates the StructField with a new comment value.

Packages

StructField

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

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

StructField 

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

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

StructField