case class StructType(fields: Array[StructField]) extends DataType with Seq[StructField] with Product with Serializable
A StructType object can be constructed by
StructType(fields: Seq[StructField])
For a StructType object, one or multiple StructFields can be extracted by names.
If multiple StructFields are extracted, a StructType object will be returned.
If a provided name does not have a matching field, it will be ignored. For the case
of extracting a single StructField, a null
will be returned.
Scala Example:
import org.apache.spark.sql._ import org.apache.spark.sql.types._ val struct = StructType( StructField("a", IntegerType, true) :: StructField("b", LongType, false) :: StructField("c", BooleanType, false) :: Nil) // Extract a single StructField. val singleField = struct("b") // singleField: StructField = StructField(b,LongType,false) // If this struct does not have a field called "d", it throws an exception. struct("d") // java.lang.IllegalArgumentException: d does not exist. // ... // Extract multiple StructFields. Field names are provided in a set. // A StructType object will be returned. val twoFields = struct(Set("b", "c")) // twoFields: StructType = // StructType(StructField(b,LongType,false), StructField(c,BooleanType,false)) // Any names without matching fields will throw an exception. // For the case shown below, an exception is thrown due to "d". struct(Set("b", "c", "d")) // java.lang.IllegalArgumentException: d does not exist. // ...
A org.apache.spark.sql.Row object is used as a value of the StructType.
Scala Example:
import org.apache.spark.sql._ import org.apache.spark.sql.types._ val innerStruct = StructType( StructField("f1", IntegerType, true) :: StructField("f2", LongType, false) :: StructField("f3", BooleanType, false) :: Nil) val struct = StructType( StructField("a", innerStruct, true) :: Nil) // Create a Row with the schema defined by struct val row = Row(Row(1, 2, true))
- Annotations
- @Stable()
- Source
- StructType.scala
- Since
1.3.0
- Alphabetic
- By Inheritance
- StructType
- Serializable
- Product
- Seq
- SeqOps
- Seq
- Equals
- SeqOps
- PartialFunction
- Function1
- Iterable
- Iterable
- IterableFactoryDefaults
- IterableOps
- IterableOnceOps
- IterableOnce
- DataType
- AbstractDataType
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new StructType()
No-arg constructor for kryo.
- new StructType(fields: Array[StructField])
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ++[B >: StructField](suffix: IterableOnce[B]): Seq[B]
- Definition Classes
- IterableOps
- Annotations
- @inline()
- final def ++:[B >: StructField](prefix: IterableOnce[B]): Seq[B]
- Definition Classes
- SeqOps → IterableOps
- Annotations
- @inline()
- final def +:[B >: StructField](elem: B): Seq[B]
- Definition Classes
- SeqOps
- Annotations
- @inline()
- final def :+[B >: StructField](elem: B): Seq[B]
- Definition Classes
- SeqOps
- Annotations
- @inline()
- final def :++[B >: StructField](suffix: IterableOnce[B]): Seq[B]
- Definition Classes
- SeqOps
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def add(name: String, dataType: String, nullable: Boolean, comment: String): StructType
Creates a new StructType by adding a new field and specifying metadata where the dataType is specified as a String.
Creates a new StructType by adding a new field and specifying metadata where the dataType is specified as a String.
val struct = (new StructType) .add("a", "int", true, "comment1") .add("b", "long", false, "comment2") .add("c", "string", true, "comment3")
- def add(name: String, dataType: String, nullable: Boolean, metadata: Metadata): StructType
Creates a new StructType by adding a new field and specifying metadata where the dataType is specified as a String.
Creates a new StructType by adding a new field and specifying metadata where the dataType is specified as a String.
val struct = (new StructType) .add("a", "int", true, Metadata.empty) .add("b", "long", false, Metadata.empty) .add("c", "string", true, Metadata.empty)
- def add(name: String, dataType: String, nullable: Boolean): StructType
Creates a new StructType by adding a new field with no metadata where the dataType is specified as a String.
Creates a new StructType by adding a new field with no metadata where the dataType is specified as a String.
val struct = (new StructType) .add("a", "int", true) .add("b", "long", false) .add("c", "string", true)
- def add(name: String, dataType: String): StructType
Creates a new StructType by adding a new nullable field with no metadata where the dataType is specified as a String.
Creates a new StructType by adding a new nullable field with no metadata where the dataType is specified as a String.
val struct = (new StructType) .add("a", "int") .add("b", "long") .add("c", "string")
- def add(name: String, dataType: DataType, nullable: Boolean, comment: String): StructType
Creates a new StructType by adding a new field and specifying metadata.
Creates a new StructType by adding a new field and specifying metadata.
val struct = (new StructType) .add("a", IntegerType, true, "comment1") .add("b", LongType, false, "comment2") .add("c", StringType, true, "comment3")
- def add(name: String, dataType: DataType, nullable: Boolean, metadata: Metadata): StructType
Creates a new StructType by adding a new field and specifying metadata.
Creates a new StructType by adding a new field and specifying metadata.
val struct = (new StructType) .add("a", IntegerType, true, Metadata.empty) .add("b", LongType, false, Metadata.empty) .add("c", StringType, true, Metadata.empty)
- def add(name: String, dataType: DataType, nullable: Boolean): StructType
Creates a new StructType by adding a new field with no metadata.
Creates a new StructType by adding a new field with no metadata.
val struct = (new StructType) .add("a", IntegerType, true) .add("b", LongType, false) .add("c", StringType, true)
- def add(name: String, dataType: DataType): StructType
Creates a new StructType by adding a new nullable field with no metadata.
Creates a new StructType by adding a new nullable field with no metadata.
val struct = (new StructType) .add("a", IntegerType) .add("b", LongType) .add("c", StringType)
- def add(field: StructField): StructType
Creates a new StructType by adding a new field.
Creates a new StructType by adding a new field.
val struct = (new StructType) .add(StructField("a", IntegerType, true)) .add(StructField("b", LongType, false)) .add(StructField("c", StringType, true))
- final def addString(b: StringBuilder): b.type
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def addString(b: StringBuilder, sep: String): b.type
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- def addString(b: StringBuilder, start: String, sep: String, end: String): b.type
- Definition Classes
- IterableOnceOps
- def andThen[C](k: PartialFunction[StructField, C]): PartialFunction[Int, C]
- Definition Classes
- PartialFunction
- def andThen[C](k: (StructField) => C): PartialFunction[Int, C]
- Definition Classes
- PartialFunction → Function1
- def appended[B >: StructField](elem: B): Seq[B]
- Definition Classes
- SeqOps
- def appendedAll[B >: StructField](suffix: IterableOnce[B]): Seq[B]
- Definition Classes
- SeqOps
- def apply(fieldIndex: Int): StructField
- Definition Classes
- StructType → SeqOps → Function1
- def apply(names: Set[String]): StructType
Returns a StructType containing StructFields of the given names, preserving the original order of fields.
Returns a StructType containing StructFields of the given names, preserving the original order of fields.
- Exceptions thrown
IllegalArgumentException
if at least one given field name does not exist
- def apply(name: String): StructField
Extracts the StructField with the given name.
Extracts the StructField with the given name.
- Exceptions thrown
IllegalArgumentException
if a field with the given name does not exist
- def applyOrElse[A1 <: Int, B1 >: StructField](x: A1, default: (A1) => B1): B1
- Definition Classes
- PartialFunction
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def canEqual(that: Any): Boolean
- Definition Classes
- Seq → Equals
- def catalogString: String
String representation for the type saved in external catalogs.
String representation for the type saved in external catalogs.
- Definition Classes
- StructType → DataType
- def className: String
- Attributes
- protected[this]
- Definition Classes
- Iterable
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def coll: StructType.this.type
- Attributes
- protected
- Definition Classes
- Iterable → IterableOps
- def collect[B](pf: PartialFunction[StructField, B]): Seq[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def collectFirst[B](pf: PartialFunction[StructField, B]): Option[B]
- Definition Classes
- IterableOnceOps
- def combinations(n: Int): Iterator[Seq[StructField]]
- Definition Classes
- SeqOps
- def compose[R](k: PartialFunction[R, Int]): PartialFunction[R, StructField]
- Definition Classes
- PartialFunction
- def compose[A](g: (A) => Int): (A) => StructField
- Definition Classes
- Function1
- Annotations
- @unspecialized()
- final def concat[B >: StructField](suffix: IterableOnce[B]): Seq[B]
- Definition Classes
- SeqOps → IterableOps
- Annotations
- @inline()
- def contains[A1 >: StructField](elem: A1): Boolean
- Definition Classes
- SeqOps
- def containsSlice[B >: StructField](that: Seq[B]): Boolean
- Definition Classes
- SeqOps
- def copyToArray[B >: StructField](xs: Array[B], start: Int, len: Int): Int
- Definition Classes
- IterableOnceOps
- def copyToArray[B >: StructField](xs: Array[B], start: Int): Int
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- def copyToArray[B >: StructField](xs: Array[B]): Int
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- def corresponds[B](that: Seq[B])(p: (StructField, B) => Boolean): Boolean
- Definition Classes
- SeqOps
- def corresponds[B](that: IterableOnce[B])(p: (StructField, B) => Boolean): Boolean
- Definition Classes
- IterableOnceOps
- def count(p: (StructField) => Boolean): Int
- Definition Classes
- IterableOnceOps
- def defaultSize: Int
The default size of a value of the StructType is the total default sizes of all field types.
The default size of a value of the StructType is the total default sizes of all field types.
- Definition Classes
- StructType → DataType
- def diff[B >: StructField](that: Seq[B]): Seq[StructField]
- Definition Classes
- SeqOps
- def distinct: Seq[StructField]
- Definition Classes
- SeqOps
- def distinctBy[B](f: (StructField) => B): Seq[StructField]
- Definition Classes
- SeqOps
- def drop(n: Int): Seq[StructField]
- Definition Classes
- IterableOps → IterableOnceOps
- def dropRight(n: Int): Seq[StructField]
- Definition Classes
- IterableOps
- def dropWhile(p: (StructField) => Boolean): Seq[StructField]
- Definition Classes
- IterableOps → IterableOnceOps
- def elementWise: ElementWiseExtractor[Int, StructField]
- Definition Classes
- PartialFunction
- def empty: Seq[StructField]
- Definition Classes
- IterableFactoryDefaults → IterableOps
- def endsWith[B >: StructField](that: Iterable[B]): Boolean
- Definition Classes
- SeqOps
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(that: Any): Boolean
- Definition Classes
- StructType → Seq → Equals → AnyRef → Any
- def exists(p: (StructField) => Boolean): Boolean
- Definition Classes
- IterableOnceOps
- def fieldIndex(name: String): Int
Returns the index of a given field.
Returns the index of a given field.
- Exceptions thrown
IllegalArgumentException
if a field with the given name does not exist
- def fieldNames: Array[String]
Returns all field names in an array.
- val fields: Array[StructField]
- def filter(pred: (StructField) => Boolean): Seq[StructField]
- Definition Classes
- IterableOps → IterableOnceOps
- def filterNot(pred: (StructField) => Boolean): Seq[StructField]
- Definition Classes
- IterableOps → IterableOnceOps
- def find(p: (StructField) => Boolean): Option[StructField]
- Definition Classes
- IterableOnceOps
- def findLast(p: (StructField) => Boolean): Option[StructField]
- Definition Classes
- SeqOps
- def flatMap[B](f: (StructField) => IterableOnce[B]): Seq[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def flatten[B](implicit asIterable: (StructField) => IterableOnce[B]): Seq[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def fold[A1 >: StructField](z: A1)(op: (A1, A1) => A1): A1
- Definition Classes
- IterableOnceOps
- def foldLeft[B](z: B)(op: (B, StructField) => B): B
- Definition Classes
- IterableOnceOps
- def foldRight[B](z: B)(op: (StructField, B) => B): B
- Definition Classes
- IterableOnceOps
- def forall(p: (StructField) => Boolean): Boolean
- Definition Classes
- IterableOnceOps
- def foreach[U](f: (StructField) => U): Unit
- Definition Classes
- IterableOnceOps
- def fromSpecific(coll: IterableOnce[StructField]): Seq[StructField]
- Attributes
- protected
- Definition Classes
- IterableFactoryDefaults → IterableOps
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def groupBy[K](f: (StructField) => K): Map[K, Seq[StructField]]
- Definition Classes
- IterableOps
- def groupMap[K, B](key: (StructField) => K)(f: (StructField) => B): Map[K, Seq[B]]
- Definition Classes
- IterableOps
- def groupMapReduce[K, B](key: (StructField) => K)(f: (StructField) => B)(reduce: (B, B) => B): Map[K, B]
- Definition Classes
- IterableOps
- def grouped(size: Int): Iterator[Seq[StructField]]
- Definition Classes
- IterableOps
- def hashCode(): Int
- Definition Classes
- StructType → Seq → AnyRef → Any
- def head: StructField
- Definition Classes
- IterableOps
- def headOption: Option[StructField]
- Definition Classes
- IterableOps
- def indexOf[B >: StructField](elem: B): Int
- Definition Classes
- SeqOps
- Annotations
- @deprecatedOverriding()
- def indexOf[B >: StructField](elem: B, from: Int): Int
- Definition Classes
- SeqOps
- def indexOfSlice[B >: StructField](that: Seq[B]): Int
- Definition Classes
- SeqOps
- Annotations
- @deprecatedOverriding()
- def indexOfSlice[B >: StructField](that: Seq[B], from: Int): Int
- Definition Classes
- SeqOps
- def indexWhere(p: (StructField) => Boolean): Int
- Definition Classes
- SeqOps
- Annotations
- @deprecatedOverriding()
- def indexWhere(p: (StructField) => Boolean, from: Int): Int
- Definition Classes
- SeqOps
- def indices: Range
- Definition Classes
- SeqOps
- def init: Seq[StructField]
- Definition Classes
- IterableOps
- def inits: Iterator[Seq[StructField]]
- Definition Classes
- IterableOps
- def intersect[B >: StructField](that: Seq[B]): Seq[StructField]
- Definition Classes
- SeqOps
- def isDefinedAt(idx: Int): Boolean
- Definition Classes
- SeqOps
- def isEmpty: Boolean
- Definition Classes
- SeqOps → IterableOnceOps
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isTraversableAgain: Boolean
- Definition Classes
- IterableOps → IterableOnceOps
- def iterableFactory: SeqFactory[Seq]
- Definition Classes
- Seq → Seq → Iterable → Iterable → IterableOps
- def iterator: Iterator[StructField]
- Definition Classes
- StructType → IterableOnce
- def json: String
The compact JSON representation of this data type.
The compact JSON representation of this data type.
- Definition Classes
- DataType
- def knownSize: Int
- Definition Classes
- IterableOnce
- def last: StructField
- Definition Classes
- IterableOps
- def lastIndexOf[B >: StructField](elem: B, end: Int): Int
- Definition Classes
- SeqOps
- def lastIndexOfSlice[B >: StructField](that: Seq[B]): Int
- Definition Classes
- SeqOps
- Annotations
- @deprecatedOverriding()
- def lastIndexOfSlice[B >: StructField](that: Seq[B], end: Int): Int
- Definition Classes
- SeqOps
- def lastIndexWhere(p: (StructField) => Boolean): Int
- Definition Classes
- SeqOps
- Annotations
- @deprecatedOverriding()
- def lastIndexWhere(p: (StructField) => Boolean, end: Int): Int
- Definition Classes
- SeqOps
- def lastOption: Option[StructField]
- Definition Classes
- IterableOps
- def lazyZip[B](that: Iterable[B]): LazyZip2[StructField, B, StructType.this.type]
- Definition Classes
- Iterable
- def length: Int
- Definition Classes
- StructType → SeqOps
- def lengthCompare(that: Iterable[_]): Int
- Definition Classes
- SeqOps
- def lengthCompare(len: Int): Int
- Definition Classes
- SeqOps
- final def lengthIs: SizeCompareOps
- Definition Classes
- SeqOps
- Annotations
- @inline()
- def lift: (Int) => Option[StructField]
- Definition Classes
- PartialFunction
- def map[B](f: (StructField) => B): Seq[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def max[B >: StructField](implicit ord: Ordering[B]): StructField
- Definition Classes
- IterableOnceOps
- def maxBy[B](f: (StructField) => B)(implicit ord: Ordering[B]): StructField
- Definition Classes
- IterableOnceOps
- def maxByOption[B](f: (StructField) => B)(implicit ord: Ordering[B]): Option[StructField]
- Definition Classes
- IterableOnceOps
- def maxOption[B >: StructField](implicit ord: Ordering[B]): Option[StructField]
- Definition Classes
- IterableOnceOps
- def min[B >: StructField](implicit ord: Ordering[B]): StructField
- Definition Classes
- IterableOnceOps
- def minBy[B](f: (StructField) => B)(implicit ord: Ordering[B]): StructField
- Definition Classes
- IterableOnceOps
- def minByOption[B](f: (StructField) => B)(implicit ord: Ordering[B]): Option[StructField]
- Definition Classes
- IterableOnceOps
- def minOption[B >: StructField](implicit ord: Ordering[B]): Option[StructField]
- Definition Classes
- IterableOnceOps
- final def mkString: String
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def mkString(sep: String): String
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def mkString(start: String, sep: String, end: String): String
- Definition Classes
- IterableOnceOps
- def names: Array[String]
Returns all field names in an array.
Returns all field names in an array. This is an alias of
fieldNames
.- Since
2.4.0
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newSpecificBuilder: Builder[StructField, Seq[StructField]]
- Attributes
- protected
- Definition Classes
- IterableFactoryDefaults → IterableOps
- def nonEmpty: Boolean
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def occCounts[B](sq: Seq[B]): Map[B, Int]
- Attributes
- protected[collection]
- Definition Classes
- SeqOps
- def orElse[A1 <: Int, B1 >: StructField](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]
- Definition Classes
- PartialFunction
- def padTo[B >: StructField](len: Int, elem: B): Seq[B]
- Definition Classes
- SeqOps
- def partition(p: (StructField) => Boolean): (Seq[StructField], Seq[StructField])
- Definition Classes
- IterableOps
- def partitionMap[A1, A2](f: (StructField) => Either[A1, A2]): (Seq[A1], Seq[A2])
- Definition Classes
- IterableOps
- def patch[B >: StructField](from: Int, other: IterableOnce[B], replaced: Int): Seq[B]
- Definition Classes
- SeqOps
- def permutations: Iterator[Seq[StructField]]
- Definition Classes
- SeqOps
- def prepended[B >: StructField](elem: B): Seq[B]
- Definition Classes
- SeqOps
- def prependedAll[B >: StructField](prefix: IterableOnce[B]): Seq[B]
- Definition Classes
- SeqOps
- def prettyJson: String
The pretty (i.e.
The pretty (i.e. indented) JSON representation of this data type.
- Definition Classes
- DataType
- def printTreeString(): Unit
- def product[B >: StructField](implicit num: Numeric[B]): B
- Definition Classes
- IterableOnceOps
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def reduce[B >: StructField](op: (B, B) => B): B
- Definition Classes
- IterableOnceOps
- def reduceLeft[B >: StructField](op: (B, StructField) => B): B
- Definition Classes
- IterableOnceOps
- def reduceLeftOption[B >: StructField](op: (B, StructField) => B): Option[B]
- Definition Classes
- IterableOnceOps
- def reduceOption[B >: StructField](op: (B, B) => B): Option[B]
- Definition Classes
- IterableOnceOps
- def reduceRight[B >: StructField](op: (StructField, B) => B): B
- Definition Classes
- IterableOnceOps
- def reduceRightOption[B >: StructField](op: (StructField, B) => B): Option[B]
- Definition Classes
- IterableOnceOps
- def reverse: Seq[StructField]
- Definition Classes
- SeqOps
- def reverseIterator: Iterator[StructField]
- Definition Classes
- SeqOps
- def reversed: Iterable[StructField]
- Attributes
- protected
- Definition Classes
- IterableOnceOps
- def runWith[U](action: (StructField) => U): (Int) => Boolean
- Definition Classes
- PartialFunction
- def sameElements[B >: StructField](that: IterableOnce[B]): Boolean
- Definition Classes
- SeqOps
- def scan[B >: StructField](z: B)(op: (B, B) => B): Seq[B]
- Definition Classes
- IterableOps
- def scanLeft[B](z: B)(op: (B, StructField) => B): Seq[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def scanRight[B](z: B)(op: (StructField, B) => B): Seq[B]
- Definition Classes
- IterableOps
- def search[B >: StructField](elem: B, from: Int, to: Int)(implicit ord: Ordering[B]): SearchResult
- Definition Classes
- SeqOps
- def search[B >: StructField](elem: B)(implicit ord: Ordering[B]): SearchResult
- Definition Classes
- SeqOps
- def segmentLength(p: (StructField) => Boolean, from: Int): Int
- Definition Classes
- SeqOps
- final def segmentLength(p: (StructField) => Boolean): Int
- Definition Classes
- SeqOps
- def simpleString: String
Readable string representation for the type.
Readable string representation for the type.
- Definition Classes
- StructType → DataType → AbstractDataType
- final def size: Int
- Definition Classes
- SeqOps → IterableOnceOps
- final def sizeCompare(that: Iterable[_]): Int
- Definition Classes
- SeqOps → IterableOps
- final def sizeCompare(otherSize: Int): Int
- Definition Classes
- SeqOps → IterableOps
- final def sizeIs: SizeCompareOps
- Definition Classes
- IterableOps
- Annotations
- @inline()
- def slice(from: Int, until: Int): Seq[StructField]
- Definition Classes
- IterableOps → IterableOnceOps
- def sliding(size: Int, step: Int): Iterator[Seq[StructField]]
- Definition Classes
- IterableOps
- def sliding(size: Int): Iterator[Seq[StructField]]
- Definition Classes
- IterableOps
- def sortBy[B](f: (StructField) => B)(implicit ord: Ordering[B]): Seq[StructField]
- Definition Classes
- SeqOps
- def sortWith(lt: (StructField, StructField) => Boolean): Seq[StructField]
- Definition Classes
- SeqOps
- def sorted[B >: StructField](implicit ord: Ordering[B]): Seq[StructField]
- Definition Classes
- SeqOps
- def span(p: (StructField) => Boolean): (Seq[StructField], Seq[StructField])
- Definition Classes
- IterableOps → IterableOnceOps
- def splitAt(n: Int): (Seq[StructField], Seq[StructField])
- Definition Classes
- IterableOps → IterableOnceOps
- def sql: String
- Definition Classes
- StructType → DataType
- def startsWith[B >: StructField](that: IterableOnce[B], offset: Int): Boolean
- Definition Classes
- SeqOps
- def stepper[S <: Stepper[_]](implicit shape: StepperShape[StructField, S]): S
- Definition Classes
- IterableOnce
- def stringPrefix: String
- Attributes
- protected[this]
- Definition Classes
- Seq → Iterable
- def sum[B >: StructField](implicit num: Numeric[B]): B
- Definition Classes
- IterableOnceOps
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tail: Seq[StructField]
- Definition Classes
- IterableOps
- def tails: Iterator[Seq[StructField]]
- Definition Classes
- IterableOps
- def take(n: Int): Seq[StructField]
- Definition Classes
- IterableOps → IterableOnceOps
- def takeRight(n: Int): Seq[StructField]
- Definition Classes
- IterableOps
- def takeWhile(p: (StructField) => Boolean): Seq[StructField]
- Definition Classes
- IterableOps → IterableOnceOps
- def tapEach[U](f: (StructField) => U): Seq[StructField]
- Definition Classes
- IterableOps → IterableOnceOps
- def to[C1](factory: Factory[StructField, C1]): C1
- Definition Classes
- IterableOnceOps
- def toArray[B >: StructField](implicit arg0: ClassTag[B]): Array[B]
- Definition Classes
- IterableOnceOps
- final def toBuffer[B >: StructField]: Buffer[B]
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- 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:
StructType(Seq(StructField("eventId", IntegerType), StructField("s", StringType)))
will be converted toeventId
INT,s
STRING. The returned DDL schema can be used in a table creation.- Since
2.4.0
- def toIndexedSeq: IndexedSeq[StructField]
- Definition Classes
- IterableOnceOps
- def toList: List[StructField]
- Definition Classes
- IterableOnceOps
- def toMap[K, V](implicit ev: <:<[StructField, (K, V)]): Map[K, V]
- Definition Classes
- IterableOnceOps
- def toNullable: StructType
Returns the same data type but set all nullability fields are true (
StructField.nullable
,ArrayType.containsNull
, andMapType.valueContainsNull
).Returns the same data type but set all nullability fields are true (
StructField.nullable
,ArrayType.containsNull
, andMapType.valueContainsNull
).- Since
4.0.0
- final def toSeq: StructType.this.type
- Definition Classes
- Seq → IterableOnceOps
- def toSet[B >: StructField]: Set[B]
- Definition Classes
- IterableOnceOps
- def toString(): String
- Definition Classes
- StructType → Seq → Function1 → Iterable → AnyRef → Any
- def toVector: Vector[StructField]
- Definition Classes
- IterableOnceOps
- def transpose[B](implicit asIterable: (StructField) => Iterable[B]): Seq[Seq[B]]
- Definition Classes
- IterableOps
- def treeString(maxDepth: Int): String
- def treeString: String
- def typeName: String
Name of the type used in JSON serialization.
Name of the type used in JSON serialization.
- Definition Classes
- DataType
- def unapply(a: Int): Option[StructField]
- Definition Classes
- PartialFunction
- def unzip[A1, A2](implicit asPair: (StructField) => (A1, A2)): (Seq[A1], Seq[A2])
- Definition Classes
- IterableOps
- def unzip3[A1, A2, A3](implicit asTriple: (StructField) => (A1, A2, A3)): (Seq[A1], Seq[A2], Seq[A3])
- Definition Classes
- IterableOps
- def updated[B >: StructField](index: Int, elem: B): Seq[B]
- Definition Classes
- SeqOps
- def view: SeqView[StructField]
- Definition Classes
- SeqOps → IterableOps
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withFilter(p: (StructField) => Boolean): WithFilter[StructField, [_]Seq[_]]
- Definition Classes
- IterableOps
- def zip[B](that: IterableOnce[B]): Seq[(StructField, B)]
- Definition Classes
- IterableOps
- def zipAll[A1 >: StructField, B](that: Iterable[B], thisElem: A1, thatElem: B): Seq[(A1, B)]
- Definition Classes
- IterableOps
- def zipWithIndex: Seq[(StructField, Int)]
- Definition Classes
- IterableOps → IterableOnceOps
Deprecated Value Members
- final def /:[B](z: B)(op: (B, StructField) => B): B
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use foldLeft instead of /:
- final def :\[B](z: B)(op: (StructField, B) => B): B
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use foldRight instead of :\
- def aggregate[B](z: => B)(seqop: (B, StructField) => B, combop: (B, B) => B): B
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) For sequential collections, prefer
foldLeft(z)(seqop)
. For parallel collections, useParIterableLike#aggregate
.
- def companion: IterableFactory[[_]Seq[_]]
- Definition Classes
- IterableOps
- Annotations
- @deprecated @deprecatedOverriding() @inline()
- Deprecated
(Since version 2.13.0) Use iterableFactory instead
- final def copyToBuffer[B >: StructField](dest: Buffer[B]): Unit
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use
dest ++= coll
instead
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def hasDefiniteSize: Boolean
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)
- final def prefixLength(p: (StructField) => Boolean): Int
- Definition Classes
- SeqOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use segmentLength instead of prefixLength
- final def repr: Seq[StructField]
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use coll instead of repr in a collection implementation, use the collection value itself from the outside
- def reverseMap[B](f: (StructField) => B): Seq[B]
- Definition Classes
- SeqOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .reverseIterator.map(f).to(...) instead of .reverseMap(f)
- def seq: StructType.this.type
- Definition Classes
- Iterable
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Iterable.seq always returns the iterable itself
- final def toIterable: StructType.this.type
- Definition Classes
- Iterable → IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.7) toIterable is internal and will be made protected; its name is similar to
toList
ortoSeq
, but it doesn't copy non-immutable collections
- final def toIterator: Iterator[StructField]
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator instead of .toIterator
- final def toStream: Stream[StructField]
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .to(LazyList) instead of .toStream
- final def toTraversable: Traversable[StructField]
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) toTraversable is internal and will be made protected; its name is similar to
toList
ortoSeq
, but it doesn't copy non-immutable collections
- final def union[B >: StructField](that: Seq[B]): Seq[B]
- Definition Classes
- SeqOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use
concat
instead
- def view(from: Int, until: Int): View[StructField]
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .view.slice(from, until) instead of .view(from, until)