Package org.apache.spark.sql.types

Class VarcharType

Object

org.apache.spark.sql.types.DataType

org.apache.spark.sql.types.StringType

org.apache.spark.sql.types.VarcharType

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

public class VarcharType
extends StringType
implements scala.Product, Serializable

A data type representing variable-length character strings with a specified maximum length.

param: length The maximum length of the varchar string (must be non-negative) param: collation Optional collation ID for string comparison and sorting. If None, uses UTF8_BINARY_COLLATION_ID. The reason for using an Option is to be able to see in the analyzer whether the collation was explicitly specified or not.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static VarcharType	apply(int length)
static VarcharType	apply(int length, int collationId)
static VarcharType	apply(int length, String collationName)
scala.Option<Object>	collation()
int	defaultSize()	The default size of a value of the StringType is 20 bytes.
int	length()
String	toString()
StringType	toStringType()
String	typeName()	Type name that is shown to the customer.

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

apply, canEqual, catalogString, collationId, constraint, equals, hashCode, json, prettyJson, productArity, productElement, productElementName, productElementNames, productIterator, productPrefix, simpleString, sql

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Method Details

apply

public static VarcharType apply(int length)

apply

public static VarcharType apply(int length,
 String collationName)

apply

public static VarcharType apply(int length,
 int collationId)

length

public int length()

collation

public scala.Option<Object> collation()

defaultSize

public int defaultSize()

Description copied from class: StringType

The default size of a value of the StringType is 20 bytes.

Overrides:

defaultSize in class StringType

Returns:

(undocumented)

typeName

public String typeName()

Description copied from class: StringType

Type name that is shown to the customer. If this is an UTF8_BINARY collation output is string due to backwards compatibility.

Overrides:

typeName in class StringType

Returns:

(undocumented)

toString

public String toString()

Overrides:

toString in class StringType

toStringType

public StringType toStringType()