org.tikv.common.columnar

Class TiColumnVector

java.lang.Object

org.tikv.common.columnar.TiColumnVector

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BatchedTiChunkColumnVector, TiBlockColumnVector, TiChunkColumnVector, TiRowColumnVector

public abstract class TiColumnVector
extends Object
implements AutoCloseable

An interface is mostly copied from Spark's ColumnVector (we do not link it here because we do not want to pollute tikv java client's dependencies).

Most of the APIs take the rowId as a parameter. This is the batch local 0-based row id for values in this TiColumnVector.

Spark only calls specific `get` method according to the data type of this TiColumnVector, e.g. if it's int type, Spark is guaranteed to only call getInt(int) or getInts(int, int).

TiColumnVector is expected to be reused during the entire data loading process, to avoid allocating memory again and again.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataType	type Data type for this column.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TiColumnVector(DataType type, int numOfRows) Sets up the data type of this column vector.

Method Summary

Modifier and Type	Method and Description
abstract void	close() Cleans up memory for this column vector.
DataType	dataType() Returns the data type of this column vector.
abstract byte[]	getBinary(int rowId) Returns the binary type value for rowId.
abstract boolean	getBoolean(int rowId) Returns the boolean type value for rowId.
boolean[]	getBooleans(int rowId, int count) Gets boolean type values from [rowId, rowId + count).
abstract byte	getByte(int rowId) Returns the byte type value for rowId.
byte[]	getBytes(int rowId, int count) Gets byte type values from [rowId, rowId + count).
protected abstract TiColumnVector	getChild(int ordinal)
abstract BigDecimal	getDecimal(int rowId, int precision, int scale) Returns the decimal type value for rowId.
abstract double	getDouble(int rowId) Returns the double type value for rowId.
double[]	getDoubles(int rowId, int count) Gets double type values from [rowId, rowId + count).
abstract float	getFloat(int rowId) Returns the float type value for rowId.
float[]	getFloats(int rowId, int count) Gets float type values from [rowId, rowId + count).
abstract int	getInt(int rowId) Returns the int type value for rowId.
int[]	getInts(int rowId, int count) Gets int type values from [rowId, rowId + count).
abstract long	getLong(int rowId) Returns the long type value for rowId.
long[]	getLongs(int rowId, int count) Gets long type values from [rowId, rowId + count).
abstract short	getShort(int rowId) Returns the short type value for rowId.
short[]	getShorts(int rowId, int count) Gets short type values from [rowId, rowId + count).
abstract String	getUTF8String(int rowId) Returns the string type value for rowId.
abstract boolean	hasNull() Returns true if this column vector contains any null values.
abstract boolean	isNullAt(int rowId) Returns whether the value at rowId is NULL.
abstract int	numNulls() Returns the number of nulls in this column vector.
int	numOfRows()

Methods inherited from class java.lang.Object

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

Field Detail

type

protected DataType type

Data type for this column.

Constructor Detail

TiColumnVector

protected TiColumnVector(DataType type,
                         int numOfRows)

Sets up the data type of this column vector.

Method Detail

dataType

public final DataType dataType()

Returns the data type of this column vector.

close

public abstract void close()

Cleans up memory for this column vector. The column vector is not usable after this.

This overwrites `AutoCloseable.close` to remove the `throws` clause, as column vector is in-memory and we don't expect any exception to happen during closing.

Specified by:

close in interface AutoCloseable

hasNull

public abstract boolean hasNull()

Returns true if this column vector contains any null values.

numNulls

public abstract int numNulls()

Returns the number of nulls in this column vector.

isNullAt

public abstract boolean isNullAt(int rowId)

Returns whether the value at rowId is NULL.

getBoolean

public abstract boolean getBoolean(int rowId)

Returns the boolean type value for rowId. The return value is undefined and can be anything, if the slot for rowId is null.

getBooleans

public boolean[] getBooleans(int rowId,
                             int count)

Gets boolean type values from [rowId, rowId + count). The return values for the null slots are undefined and can be anything.

getByte

public abstract byte getByte(int rowId)

Returns the byte type value for rowId. The return value is undefined and can be anything, if the slot for rowId is null.

getBytes

public byte[] getBytes(int rowId,
                       int count)

Gets byte type values from [rowId, rowId + count). The return values for the null slots are undefined and can be anything.

getShort

public abstract short getShort(int rowId)

Returns the short type value for rowId. The return value is undefined and can be anything, if the slot for rowId is null.

getShorts

public short[] getShorts(int rowId,
                         int count)

Gets short type values from [rowId, rowId + count). The return values for the null slots are undefined and can be anything.

getInt

public abstract int getInt(int rowId)

Returns the int type value for rowId. The return value is undefined and can be anything, if the slot for rowId is null.

getInts

public int[] getInts(int rowId,
                     int count)

Gets int type values from [rowId, rowId + count). The return values for the null slots are undefined and can be anything.

getLong

public abstract long getLong(int rowId)

Returns the long type value for rowId. The return value is undefined and can be anything, if the slot for rowId is null.

getLongs

public long[] getLongs(int rowId,
                       int count)

Gets long type values from [rowId, rowId + count). The return values for the null slots are undefined and can be anything.

getFloat

public abstract float getFloat(int rowId)

Returns the float type value for rowId. The return value is undefined and can be anything, if the slot for rowId is null.

getFloats

public float[] getFloats(int rowId,
                         int count)

Gets float type values from [rowId, rowId + count). The return values for the null slots are undefined and can be anything.

getDouble

public abstract double getDouble(int rowId)

Returns the double type value for rowId. The return value is undefined and can be anything, if the slot for rowId is null.

getDoubles

public double[] getDoubles(int rowId,
                           int count)

Gets double type values from [rowId, rowId + count). The return values for the null slots are undefined and can be anything.

getDecimal

public abstract BigDecimal getDecimal(int rowId,
                                      int precision,
                                      int scale)

Returns the decimal type value for rowId. If the slot for rowId is null, it should return null.

getUTF8String

public abstract String getUTF8String(int rowId)

Returns the string type value for rowId. If the slot for rowId is null, it should return null. Note that the returned UTF8String may point to the data of this column vector, please copy it if you want to keep it after this column vector is freed.

getBinary

public abstract byte[] getBinary(int rowId)

Returns the binary type value for rowId. If the slot for rowId is null, it should return null.

getChild

protected abstract TiColumnVector getChild(int ordinal)

Returns:

child [[TiColumnVector]] at the given ordinal.

numOfRows

public int numOfRows()