Package org.apache.spark.sql.types

Class StringType

Object

org.apache.spark.sql.types.DataType

org.apache.spark.sql.types.StringType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CharType, VarcharType

public class StringType
extends DataType
implements Serializable

The data type representing String values. Please use the singleton DataTypes.StringType.

Since:

1.3.0 param: collationId The id of collation for this StringType.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static StringType	apply(String collation)
abstract static boolean	canEqual(Object that)
static String	catalogString()
int	collationId()
StringConstraint	constraint()
int	defaultSize()	The default size of a value of the StringType is 20 bytes.
boolean	equals(Object obj)
int	hashCode()
static String	json()
static String	prettyJson()
abstract static int	productArity()
abstract static Object	productElement(int n)
static String	productElementName(int n)
static scala.collection.Iterator<String>	productElementNames()
static scala.collection.Iterator<Object>	productIterator()
static String	productPrefix()
static String	simpleString()
static String	sql()
String	toString()
String	typeName()	Type name that is shown to the customer.

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

Method Details

apply

public static StringType apply(String collation)

json

public static String json()

prettyJson

public static String prettyJson()

simpleString

public static String simpleString()

catalogString

public static String catalogString()

sql

public static String sql()

canEqual

public abstract static boolean canEqual(Object that)

productArity

public abstract static int productArity()

productElement

public abstract static Object productElement(int n)

productIterator

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

productPrefix

public static String productPrefix()

productElementName

public static String productElementName(int n)

productElementNames

public static scala.collection.Iterator<String> productElementNames()

collationId

public int collationId()

constraint

public StringConstraint constraint()

typeName

public String typeName()

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 DataType

Returns:

(undocumented)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

defaultSize

public int defaultSize()

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

Specified by:

defaultSize in class DataType

Returns:

(undocumented)