org.apache.spark.sql.types

Class YearMonthIntervalType

Object

org.apache.spark.sql.types.DataType

org.apache.spark.sql.types.YearMonthIntervalType

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public class YearMonthIntervalType
extends DataType
implements scala.Product, scala.Serializable

The type represents year-month intervals of the SQL standard. A year-month interval is made up of a contiguous subset of the following fields: - MONTH, months within years [0..11], - YEAR, years in the range [0..178956970].

YearMonthIntervalType represents positive as well as negative year-month intervals.

param: startField The leftmost field which the type comprises of. Valid values: 0 (YEAR), 1 (MONTH). param: endField The rightmost field which the type comprises of. Valid values: 0 (YEAR), 1 (MONTH).

Since:

3.2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
YearMonthIntervalType(byte startField, byte endField)

Method Summary

Modifier and Type	Method and Description
static YearMonthIntervalType	apply()
static YearMonthIntervalType	apply(byte field)
abstract static boolean	canEqual(Object that)
static YearMonthIntervalType	DEFAULT()
int	defaultSize() Year-month interval values always occupy 4 bytes.
byte	endField()
abstract static boolean	equals(Object that)
static String	fieldToString(byte field)
static byte	MONTH()
abstract static int	productArity()
abstract static Object	productElement(int n)
static scala.collection.Iterator<Object>	productIterator()
static String	productPrefix()
byte	startField()
static scala.collection.immutable.Map<String,Object>	stringToField()
String	typeName() Name of the type used in JSON serialization.
static byte	YEAR()
static scala.collection.Seq<Object>	yearMonthFields()

Methods inherited from class org.apache.spark.sql.types.DataType

catalogString, equalsIgnoreCaseAndNullability, equalsIgnoreNullability, equalsStructurally, equalsStructurallyByName, fromDDL, fromJson, json, parseTypeWithFallback, prettyJson, simpleString, sql

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

YearMonthIntervalType

public YearMonthIntervalType(byte startField,
                             byte endField)

Method Detail

YEAR

public static byte YEAR()

MONTH

public static byte MONTH()

yearMonthFields

public static scala.collection.Seq<Object> yearMonthFields()

fieldToString

public static String fieldToString(byte field)

stringToField

public static scala.collection.immutable.Map<String,Object> stringToField()

DEFAULT

public static YearMonthIntervalType DEFAULT()

apply

public static YearMonthIntervalType apply()

apply

public static YearMonthIntervalType apply(byte field)

canEqual

public abstract static boolean canEqual(Object that)

equals

public abstract static boolean equals(Object that)

productElement

public abstract static Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<Object> productIterator()

productPrefix

public static String productPrefix()

startField

public byte startField()

endField

public byte endField()

defaultSize

public int defaultSize()

Year-month interval values always occupy 4 bytes. The YEAR field is constrained by the upper bound 178956970 to fit to Int.

Specified by:

defaultSize in class DataType

Returns:

(undocumented)

typeName

public String typeName()

Description copied from class: DataType

Name of the type used in JSON serialization.

Overrides:

typeName in class DataType