DataType (TiKV Java Client 3.3.5 API)

java.lang.Object
- org.tikv.common.types.DataType

所有已实现的接口:

Serializable

直接已知子类:

AbstractDateTimeType, BytesType, DecimalType, EnumType, IntegerType, JsonType, RealType, SetType, TimeType, UninitializedType
```
public abstract class DataType
extends Object
implements Serializable
```
Base Type for encoding and decoding TiDB row information.

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

static class DataType.EncodeType

嵌套类
限定符和类型	类和说明
`static class`	`DataType.EncodeType`

字段概要

字段
限定符和类型	字段和说明
`static int`	`AutoIncrementFlag`
`static int`	`BinaryFlag`
`static int`	`BlobFlag`
`protected int`	`collation`
`static long`	`COLUMN_VERSION_FLAG`
`protected int`	`decimal`
`static int`	`EnumFlag`
`protected int`	`flag`
`protected long`	`length`
`static int`	`MultipleKeyFlag`
`static int`	`NoDefaultValueFlag`
`static int`	`NotNullFlag`
`static int`	`NumFlag`
`static int`	`OnUpdateNowFlag`
`static int`	`PriKeyFlag`
`static int`	`SetFlag`
`static int`	`TimestampFlag`
`protected MySQLType`	`tp`
`static int`	`UniqueKeyFlag`
`static int`	`UnsignedFlag`
`static int`	`UNSPECIFIED_LEN`
`static int`	`ZerofillFlag`

构造器概要

构造器
限定符	构造器和说明
`protected`	`DataType(MySQLType type)`
	`DataType(MySQLType tp, int prec, int scale)`
`protected`	`DataType(MySQLType type, int flag, int len, int decimal, String charset, int collation)`
`protected`	`DataType(TiColumnInfo.InternalTypeHolder holder)`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`Object`	`convertToTiDBType(Object value)` Convert from Spark SQL Supported Java Type to TiDB Type 1. data convert, e.g.
`Object`	`decode(CodecDataInput cdi)` decode value from row which is nothing.
`TiChunkColumnVector`	`decodeChunkColumn(CodecDataInput cdi)`
`Object`	`decodeForBatchWrite(CodecDataInput cdi)`
`protected abstract Object`	`decodeNotNull(int flag, CodecDataInput cdi)`
`protected Object`	`decodeNotNullForBatchWrite(int flag, CodecDataInput cdi)`
`protected abstract Object`	`doConvertToTiDBType(Object value)`
`void`	`encode(CodecDataOutput cdo, DataType.EncodeType encodeType, Object value)` encode a Row to CodecDataOutput
`static void`	`encodeIndex(CodecDataOutput cdo)`
`protected abstract void`	`encodeKey(CodecDataOutput cdo, Object value)`
`void`	`encodeKey(CodecDataOutput cdo, Object value, int prefixLength)` encode a Key's prefix to CodecDataOutput
`static void`	`encodeMaxValue(CodecDataOutput cdo)`
`static void`	`encodeNull(CodecDataOutput cdo)`
`protected abstract void`	`encodeProto(CodecDataOutput cdo, Object value)`
`protected abstract void`	`encodeValue(CodecDataOutput cdo, Object value)`
`boolean`	`equals(Object other)`
`String`	`getCharset()`
`int`	`getCollationCode()`
`int`	`getDecimal()`
`int`	`getDefaultLength()`
`List<String>`	`getElems()`
`int`	`getFlag()`
`long`	`getLength()`
`abstract String`	`getName()`
`Object`	`getOriginDefaultValue(String value, long version)`
`abstract Object`	`getOriginDefaultValueNonNull(String value, long version)` get origin default value
`abstract ExprType`	`getProtoExprType()`
`long`	`getSize()` Size of data type
`MySQLType`	`getType()`
`int`	`getTypeCode()`
`int`	`hashCode()`
`boolean`	`isAutoIncrement()`
`boolean`	`isBinary()`
`boolean`	`isBlob()`
`boolean`	`isDecimalUnSpecified()`
`boolean`	`isEnum()`
`boolean`	`isLengthUnSpecified()`
`static boolean`	`isLengthUnSpecified(long length)`
`boolean`	`isMultiKey()`
`boolean`	`isNextNull(CodecDataInput cdi)`
`boolean`	`isNoDefault()`
`boolean`	`isNotNull()`
`boolean`	`isNum()`
`boolean`	`isOnUpdateNow()`
`protected boolean`	`isPrefixIndexSupported()` Indicates whether a data type supports prefix index
`boolean`	`isPrimaryKey()`
`boolean`	`isPushDownSupported()`
`boolean`	`isSameCatalog(DataType other)`
`boolean`	`isSet()`
`boolean`	`isTimestamp()`
`boolean`	`isUniqueKey()`
`boolean`	`isUnsigned()`
`boolean`	`isZeroFill()`
`Long`	`signedLowerBound()`
`Long`	`signedUpperBound()`
`String`	`toString()`
`TiColumnInfo.InternalTypeHolder`	`toTypeHolder()`
`Long`	`unsignedUpperBound()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

NotNullFlag
```
public static final int NotNullFlag
```
另请参阅:

常量字段值

PriKeyFlag
```
public static final int PriKeyFlag
```
另请参阅:

常量字段值

UniqueKeyFlag
```
public static final int UniqueKeyFlag
```
另请参阅:

常量字段值

MultipleKeyFlag
```
public static final int MultipleKeyFlag
```
另请参阅:

常量字段值

BlobFlag
```
public static final int BlobFlag
```
另请参阅:

常量字段值

UnsignedFlag
```
public static final int UnsignedFlag
```
另请参阅:

常量字段值

ZerofillFlag
```
public static final int ZerofillFlag
```
另请参阅:

常量字段值

BinaryFlag
```
public static final int BinaryFlag
```
另请参阅:

常量字段值

EnumFlag
```
public static final int EnumFlag
```
另请参阅:

常量字段值

AutoIncrementFlag
```
public static final int AutoIncrementFlag
```
另请参阅:

常量字段值

TimestampFlag
```
public static final int TimestampFlag
```
另请参阅:

常量字段值

SetFlag
```
public static final int SetFlag
```
另请参阅:

常量字段值

NoDefaultValueFlag
```
public static final int NoDefaultValueFlag
```
另请参阅:

常量字段值

OnUpdateNowFlag
```
public static final int OnUpdateNowFlag
```
另请参阅:

常量字段值

NumFlag
```
public static final int NumFlag
```
另请参阅:

常量字段值

COLUMN_VERSION_FLAG
```
public static final long COLUMN_VERSION_FLAG
```
另请参阅:

常量字段值

UNSPECIFIED_LEN
```
public static final int UNSPECIFIED_LEN
```
另请参阅:

常量字段值

tp
```
protected final MySQLType tp
```

flag
```
protected final int flag
```

decimal
```
protected final int decimal
```

collation
```
protected final int collation
```

length
```
protected final long length
```

构造器详细资料

DataType

public DataType(MySQLType tp,
                int prec,
                int scale)

DataType

protected DataType(TiColumnInfo.InternalTypeHolder holder)

DataType
```
protected DataType(MySQLType type)
```

DataType

protected DataType(MySQLType type,
                   int flag,
                   int len,
                   int decimal,
                   String charset,
                   int collation)

方法详细资料

encodeMaxValue

public static void encodeMaxValue(CodecDataOutput cdo)

encodeNull

public static void encodeNull(CodecDataOutput cdo)

encodeIndex

public static void encodeIndex(CodecDataOutput cdo)

isLengthUnSpecified

public static boolean isLengthUnSpecified(long length)

signedLowerBound

public Long signedLowerBound()
                      throws TypeException

抛出:: TypeException

signedUpperBound

public Long signedUpperBound()
                      throws TypeException

抛出:: TypeException

unsignedUpperBound

public Long unsignedUpperBound()
                        throws TypeException

抛出:: TypeException

decodeNotNull

protected abstract Object decodeNotNull(int flag,
                                        CodecDataInput cdi)

decodeNotNullForBatchWrite

protected Object decodeNotNullForBatchWrite(int flag,
                                            CodecDataInput cdi)

isSameCatalog

public boolean isSameCatalog(DataType other)

decodeChunkColumn

public TiChunkColumnVector decodeChunkColumn(CodecDataInput cdi)

decode
```
public Object decode(CodecDataInput cdi)
```
decode value from row which is nothing.

参数:

cdi - source of data.

decodeForBatchWrite

public Object decodeForBatchWrite(CodecDataInput cdi)

isNextNull

public boolean isNextNull(CodecDataInput cdi)

encode

public void encode(CodecDataOutput cdo,
                   DataType.EncodeType encodeType,
                   Object value)

encode a Row to CodecDataOutput

参数:: cdo - destination of data.; encodeType - Key or Value.; value - value to be encoded.

convertToTiDBType
```
public Object convertToTiDBType(Object value)
                         throws ConvertNotSupportException,
                                ConvertOverflowException
```
Convert from Spark SQL Supported Java Type to TiDB Type
1. data convert, e.g. Integer -> SHORT
2. check overflow, e.g. write 1000 to short
Spark SQL only support following types:
1. BooleanType -> java.lang.Boolean 2. ByteType -> java.lang.Byte 3. ShortType -> java.lang.Short 4. IntegerType -> java.lang.Integer 5. LongType -> java.lang.Long 6. FloatType -> java.lang.Float 7. DoubleType -> java.lang.Double 8. StringType -> String 9. DecimalType -> java.math.BigDecimal 10. DateType -> java.sql.Date 11. TimestampType -> java.sql.Timestamp 12. BinaryType -> byte array 13. ArrayType -> scala.collection.Seq (use getList for java.util.List) 14. MapType -> scala.collection.Map (use getJavaMap for java.util.Map) 15. StructType -> org.apache.spark.sql.Row

参数:

value -

返回:

抛出:

ConvertNotSupportException

ConvertOverflowException

doConvertToTiDBType

protected abstract Object doConvertToTiDBType(Object value)
                                       throws ConvertNotSupportException,
                                              ConvertOverflowException

抛出:: ConvertNotSupportException; ConvertOverflowException

encodeKey

protected abstract void encodeKey(CodecDataOutput cdo,
                                  Object value)

encodeValue

protected abstract void encodeValue(CodecDataOutput cdo,
                                    Object value)

encodeProto

protected abstract void encodeProto(CodecDataOutput cdo,
                                    Object value)

getName
```
public abstract String getName()
```

encodeKey
```
public void encodeKey(CodecDataOutput cdo,
                      Object value,
                      int prefixLength)
```
encode a Key's prefix to CodecDataOutput

参数:

cdo - destination of data.

value - value to be encoded.

prefixLength - specifies prefix length of value to be encoded. When prefixLength is DataType.UNSPECIFIED_LEN, encode full length of value.

isPrefixIndexSupported
```
protected boolean isPrefixIndexSupported()
```
Indicates whether a data type supports prefix index

返回:

returns true iff the type is BytesType

getProtoExprType

public abstract ExprType getProtoExprType()

getOriginDefaultValueNonNull

public abstract Object getOriginDefaultValueNonNull(String value,
                                                    long version)

get origin default value

参数:: value - a int value represents in string
返回:: a int object

isPushDownSupported
```
public boolean isPushDownSupported()
```
返回:

true if this type can be pushed down to TiKV or TiFLASH

getOriginDefaultValue

public Object getOriginDefaultValue(String value,
                                    long version)

getCollationCode
```
public int getCollationCode()
```

getLength
```
public long getLength()
```

getDefaultLength
```
public int getDefaultLength()
```

getSize
```
public long getSize()
```
Size of data type

返回:

size

isLengthUnSpecified
```
public boolean isLengthUnSpecified()
```

isDecimalUnSpecified
```
public boolean isDecimalUnSpecified()
```

getDecimal
```
public int getDecimal()
```

getFlag
```
public int getFlag()
```

getElems
```
public List<String> getElems()
```

getTypeCode
```
public int getTypeCode()
```

getType
```
public MySQLType getType()
```

getCharset
```
public String getCharset()
```

isPrimaryKey
```
public boolean isPrimaryKey()
```

isNotNull
```
public boolean isNotNull()
```

isNoDefault
```
public boolean isNoDefault()
```

isAutoIncrement
```
public boolean isAutoIncrement()
```

isZeroFill
```
public boolean isZeroFill()
```

isBinary
```
public boolean isBinary()
```

isUniqueKey
```
public boolean isUniqueKey()
```

isMultiKey
```
public boolean isMultiKey()
```

isTimestamp
```
public boolean isTimestamp()
```

isOnUpdateNow
```
public boolean isOnUpdateNow()
```

isBlob
```
public boolean isBlob()
```

isEnum
```
public boolean isEnum()
```

isSet
```
public boolean isSet()
```

isNum
```
public boolean isNum()
```

isUnsigned
```
public boolean isUnsigned()
```

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

equals
```
public boolean equals(Object other)
```
覆盖:

equals 在类中 Object

hashCode
```
public int hashCode()
```
覆盖:

hashCode 在类中 Object

toTypeHolder

public TiColumnInfo.InternalTypeHolder toTypeHolder()

类 DataType

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

NotNullFlag

PriKeyFlag

UniqueKeyFlag

MultipleKeyFlag

BlobFlag

UnsignedFlag

ZerofillFlag

BinaryFlag

EnumFlag

AutoIncrementFlag

TimestampFlag

SetFlag

NoDefaultValueFlag

OnUpdateNowFlag

NumFlag

COLUMN_VERSION_FLAG

UNSPECIFIED_LEN

tp

flag

decimal

collation

length

构造器详细资料

DataType

DataType

DataType

DataType

方法详细资料

encodeMaxValue

encodeNull

encodeIndex

isLengthUnSpecified

signedLowerBound

signedUpperBound

unsignedUpperBound

decodeNotNull

decodeNotNullForBatchWrite

isSameCatalog

decodeChunkColumn

decode

decodeForBatchWrite

isNextNull

encode

convertToTiDBType

doConvertToTiDBType

encodeKey

encodeValue

encodeProto

getName

encodeKey

isPrefixIndexSupported

getProtoExprType

getOriginDefaultValueNonNull

isPushDownSupported

getOriginDefaultValue

getCollationCode

getLength

getDefaultLength

getSize

isLengthUnSpecified

isDecimalUnSpecified

getDecimal

getFlag

getElems

getTypeCode

getType

getCharset

isPrimaryKey

isNotNull

isNoDefault

isAutoIncrement

isZeroFill

isBinary