org.apache.kudu.client

Class PartialRow

java.lang.Object

org.apache.kudu.client.PartialRow

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class PartialRow
extends Object

Class used to represent parts of a row along with its schema.

Values can be replaced as often as needed, but once the enclosing Operation is applied then they cannot be changed again. This means that a PartialRow cannot be reused.

Each PartialRow is backed by an byte array where all the cells (except strings and binary data) are written. The others are kept in a List.

This class isn't thread-safe.

Constructor Summary

Constructors

Constructor and Description
PartialRow(Schema schema) This is not a stable API, prefer using Schema.newPartialRow() to create a new partial row.

Method Summary

Modifier and Type	Method and Description
void	addBinary(int columnIndex, byte[] val) Add binary data with the specified value.
void	addBinary(int columnIndex, ByteBuffer value) Add binary data with the specified value, from the current ByteBuffer's position to its limit.
void	addBinary(String columnName, byte[] val) Add binary data with the specified value.
void	addBinary(String columnName, ByteBuffer value) Add binary data with the specified value, from the current ByteBuffer's position to its limit.
void	addBoolean(int columnIndex, boolean val) Add a boolean for the specified column.
void	addBoolean(String columnName, boolean val) Add a boolean for the specified column.
void	addByte(int columnIndex, byte val) Add a byte for the specified column.
void	addByte(String columnName, byte val) Add a byte for the specified column.
void	addDecimal(int columnIndex, BigDecimal val) Add a Decimal for the specified column.
void	addDecimal(String columnName, BigDecimal val) Add a Decimal for the specified column.
void	addDouble(int columnIndex, double val) Add an double for the specified column.
void	addDouble(String columnName, double val) Add an double for the specified column.
void	addFloat(int columnIndex, float val) Add an float for the specified column.
void	addFloat(String columnName, float val) Add an float for the specified column.
void	addInt(int columnIndex, int val) Add an int for the specified column.
void	addInt(String columnName, int val) Add an int for the specified column.
void	addLong(int columnIndex, long val) Add an long for the specified column.
void	addLong(String columnName, long val) Add an long for the specified column.
void	addShort(int columnIndex, short val) Add a short for the specified column.
void	addShort(String columnName, short val) Add a short for the specified column.
void	addString(int columnIndex, String val) Add a String for the specified column.
void	addString(String columnName, String val) Add a String for the specified column.
void	addStringUtf8(int columnIndex, byte[] val) Add a String for the specified value, encoded as UTF8.
void	addStringUtf8(String columnName, byte[] val) Add a String for the specified value, encoded as UTF8.
void	addTimestamp(int columnIndex, Timestamp val) Add a Timestamp for the specified column.
void	addTimestamp(String columnName, Timestamp val) Add a Timestamp for the specified column.
byte[]	encodePrimaryKey() Returns the encoded primary key of the row.
ByteBuffer	getBinary(int columnIndex) Get the specified column's binary data.
ByteBuffer	getBinary(String columnName) Get the specified column's binary data.
byte[]	getBinaryCopy(int columnIndex) Get a copy of the specified column's binary data.
byte[]	getBinaryCopy(String columnName) Get a copy of the specified column's binary data.
boolean	getBoolean(int columnIndex) Get the specified column's boolean
boolean	getBoolean(String columnName) Get the specified column's boolean
byte	getByte(int columnIndex) Get the specified column's byte
byte	getByte(String columnName) Get the specified column's byte
BigDecimal	getDecimal(int columnIndex) Get the specified column's Decimal.
BigDecimal	getDecimal(String columnName) Get the specified column's BigDecimal
double	getDouble(int columnIndex) Get the specified column's double
double	getDouble(String columnName) Get the specified column's double
float	getFloat(int columnIndex) Get the specified column's float
float	getFloat(String columnName) Get the specified column's float
int	getInt(int columnIndex) Get the specified column's integer
int	getInt(String columnName) Get the specified column's integer
long	getLong(int columnIndex) Get the specified column's long If this is a UNIXTIME_MICROS column, the long value corresponds to a number of microseconds since midnight, January 1, 1970 UTC.
long	getLong(String columnName) Get the specified column's long If this is a UNIXTIME_MICROS column, the long value corresponds to a number of microseconds since midnight, January 1, 1970 UTC.
short	getShort(int columnIndex) Get the specified column's short
short	getShort(String columnName) Get the specified column's short
String	getString(int columnIndex) Get the specified column's string.
String	getString(String columnName) Get the specified column's string.
Timestamp	getTimestamp(int columnIndex) Get the specified column's Timestamp.
Timestamp	getTimestamp(String columnName) Get the specified column's Timestamp.
boolean	isNull(int columnIndex) Get if the specified column is NULL
boolean	isNull(String columnName) Get if the specified column is NULL
boolean	isSet(int columnIndex) Get if the specified column has been set
boolean	isSet(String columnName) Get if the specified column has been set
void	setNull(int columnIndex) Set the specified column to null
void	setNull(String columnName) Set the specified column to null
String	stringifyRowKey() Transforms the row key into a string representation where each column is in the format: "type col_name=value".
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PartialRow

public PartialRow(Schema schema)

This is not a stable API, prefer using Schema.newPartialRow() to create a new partial row.

Parameters:

schema - the schema to use for this row

Method Detail

addBoolean

public void addBoolean(int columnIndex,
                       boolean val)

Add a boolean for the specified column.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addBoolean

public void addBoolean(String columnName,
                       boolean val)

Add a boolean for the specified column.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getBoolean

public boolean getBoolean(String columnName)

Get the specified column's boolean

Parameters:

columnName - name of the column to get data for

Returns:

a boolean

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getBoolean

public boolean getBoolean(int columnIndex)

Get the specified column's boolean

Parameters:

columnIndex - Column index in the schema

Returns:

a boolean

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addByte

public void addByte(int columnIndex,
                    byte val)

Add a byte for the specified column.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addByte

public void addByte(String columnName,
                    byte val)

Add a byte for the specified column.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getByte

public byte getByte(String columnName)

Get the specified column's byte

Parameters:

columnName - name of the column to get data for

Returns:

a byte

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getByte

public byte getByte(int columnIndex)

Get the specified column's byte

Parameters:

columnIndex - Column index in the schema

Returns:

a byte

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addShort

public void addShort(int columnIndex,
                     short val)

Add a short for the specified column.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addShort

public void addShort(String columnName,
                     short val)

Add a short for the specified column.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getShort

public short getShort(String columnName)

Get the specified column's short

Parameters:

columnName - name of the column to get data for

Returns:

a short

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getShort

public short getShort(int columnIndex)

Get the specified column's short

Parameters:

columnIndex - Column index in the schema

Returns:

a short

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addInt

public void addInt(int columnIndex,
                   int val)

Add an int for the specified column.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addInt

public void addInt(String columnName,
                   int val)

Add an int for the specified column.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getInt

public int getInt(String columnName)

Get the specified column's integer

Parameters:

columnName - name of the column to get data for

Returns:

an integer

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getInt

public int getInt(int columnIndex)

Get the specified column's integer

Parameters:

columnIndex - Column index in the schema

Returns:

an integer

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addLong

public void addLong(int columnIndex,
                    long val)

Add an long for the specified column.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addLong

public void addLong(String columnName,
                    long val)

Add an long for the specified column. If this is a UNIXTIME_MICROS column, the long value provided should be the number of microseconds between a given time and January 1, 1970 UTC. For example, to encode the current time, use setLong(System.currentTimeMillis() * 1000);

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getLong

public long getLong(String columnName)

Get the specified column's long If this is a UNIXTIME_MICROS column, the long value corresponds to a number of microseconds since midnight, January 1, 1970 UTC.

Parameters:

columnName - name of the column to get data for

Returns:

a long

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getLong

public long getLong(int columnIndex)

Get the specified column's long If this is a UNIXTIME_MICROS column, the long value corresponds to a number of microseconds since midnight, January 1, 1970 UTC.

Parameters:

columnIndex - Column index in the schema

Returns:

a long

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addFloat

public void addFloat(int columnIndex,
                     float val)

Add an float for the specified column.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addFloat

public void addFloat(String columnName,
                     float val)

Add an float for the specified column.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getFloat

public float getFloat(String columnName)

Get the specified column's float

Parameters:

columnName - name of the column to get data for

Returns:

a float

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getFloat

public float getFloat(int columnIndex)

Get the specified column's float

Parameters:

columnIndex - Column index in the schema

Returns:

a float

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addDouble

public void addDouble(int columnIndex,
                      double val)

Add an double for the specified column.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addDouble

public void addDouble(String columnName,
                      double val)

Add an double for the specified column.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getDouble

public double getDouble(String columnName)

Get the specified column's double

Parameters:

columnName - name of the column to get data for

Returns:

a double

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getDouble

public double getDouble(int columnIndex)

Get the specified column's double

Parameters:

columnIndex - Column index in the schema

Returns:

a double

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addDecimal

public void addDecimal(int columnIndex,
                       BigDecimal val)

Add a Decimal for the specified column.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addDecimal

public void addDecimal(String columnName,
                       BigDecimal val)

Add a Decimal for the specified column.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getDecimal

public BigDecimal getDecimal(String columnName)

Get the specified column's BigDecimal

Parameters:

columnName - name of the column to get data for

Returns:

a BigDecimal

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getDecimal

public BigDecimal getDecimal(int columnIndex)

Get the specified column's Decimal.

Parameters:

columnIndex - Column index in the schema

Returns:

a BigDecimal

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addTimestamp

public void addTimestamp(int columnIndex,
                         Timestamp val)

Add a Timestamp for the specified column. Note: Timestamp instances with nanosecond precision are truncated to microseconds.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addTimestamp

public void addTimestamp(String columnName,
                         Timestamp val)

Add a Timestamp for the specified column. Note: Timestamp instances with nanosecond precision are truncated to microseconds.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getTimestamp

public Timestamp getTimestamp(String columnName)

Get the specified column's Timestamp.

Parameters:

columnName - name of the column to get data for

Returns:

a Timestamp

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getTimestamp

public Timestamp getTimestamp(int columnIndex)

Get the specified column's Timestamp.

Parameters:

columnIndex - Column index in the schema

Returns:

a Timestamp

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addString

public void addString(int columnIndex,
                      String val)

Add a String for the specified column.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addString

public void addString(String columnName,
                      String val)

Add a String for the specified column.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getString

public String getString(String columnName)

Get the specified column's string.

Parameters:

columnName - name of the column to get data for

Returns:

a string

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getString

public String getString(int columnIndex)

Get the specified column's string.

Parameters:

columnIndex - Column index in the schema

Returns:

a string

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

addStringUtf8

public void addStringUtf8(int columnIndex,
                          byte[] val)

Add a String for the specified value, encoded as UTF8. Note that the provided value must not be mutated after this.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addStringUtf8

public void addStringUtf8(String columnName,
                          byte[] val)

Add a String for the specified value, encoded as UTF8. Note that the provided value must not be mutated after this.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

addBinary

public void addBinary(int columnIndex,
                      byte[] val)

Add binary data with the specified value. Note that the provided value must not be mutated after this.

Parameters:

columnIndex - the column's index in the schema

val - value to add

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addBinary

public void addBinary(int columnIndex,
                      ByteBuffer value)

Add binary data with the specified value, from the current ByteBuffer's position to its limit. This method duplicates the ByteBuffer but doesn't copy the data. This means that the wrapped data must not be mutated after this.

Parameters:

columnIndex - the column's index in the schema

value - byte buffer to get the value from

Throws:

IllegalArgumentException - if the value doesn't match the column's type

IllegalStateException - if the row was already applied

IndexOutOfBoundsException - if the column doesn't exist

addBinary

public void addBinary(String columnName,
                      byte[] val)

Add binary data with the specified value. Note that the provided value must not be mutated after this.

Parameters:

columnName - Name of the column

val - value to add

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

addBinary

public void addBinary(String columnName,
                      ByteBuffer value)

Add binary data with the specified value, from the current ByteBuffer's position to its limit. This method duplicates the ByteBuffer but doesn't copy the data. This means that the wrapped data must not be mutated after this.

Parameters:

columnName - Name of the column

value - byte buffer to get the value from

Throws:

IllegalArgumentException - if the column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

getBinaryCopy

public byte[] getBinaryCopy(String columnName)

Get a copy of the specified column's binary data.

Parameters:

columnName - name of the column to get data for

Returns:

a byte[] with the binary data.

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getBinaryCopy

public byte[] getBinaryCopy(int columnIndex)

Get a copy of the specified column's binary data.

Parameters:

columnIndex - Column index in the schema

Returns:

a byte[] with the binary data.

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

getBinary

public ByteBuffer getBinary(String columnName)

Get the specified column's binary data. This doesn't copy the data and instead returns a ByteBuffer that wraps it.

Parameters:

columnName - name of the column to get data for

Returns:

a ByteBuffer with the binary data.

Throws:

IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type

getBinary

public ByteBuffer getBinary(int columnIndex)

Get the specified column's binary data. This doesn't copy the data and instead returns a ByteBuffer that wraps it.

Parameters:

columnIndex - Column index in the schema

Returns:

a ByteBuffer with the binary data.

Throws:

IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type

IndexOutOfBoundsException - if the column doesn't exist

setNull

public void setNull(int columnIndex)

Set the specified column to null

Parameters:

columnIndex - the column's index in the schema

Throws:

IllegalArgumentException - if the column doesn't exist or cannot be set to null

IllegalStateException - if the row was already applied

setNull

public void setNull(String columnName)

Set the specified column to null

Parameters:

columnName - Name of the column

Throws:

IllegalArgumentException - if the column doesn't exist or cannot be set to null

IllegalStateException - if the row was already applied

isNull

public boolean isNull(String columnName)

Get if the specified column is NULL

Parameters:

columnName - name of the column in the schema

Returns:

true if the column cell is null and the column is nullable, false otherwise

Throws:

IllegalArgumentException - if the column doesn't exist

isNull

public boolean isNull(int columnIndex)

Get if the specified column is NULL

Parameters:

columnIndex - Column index in the schema

Returns:

true if the column cell is null and the column is nullable, false otherwise

Throws:

IndexOutOfBoundsException - if the column doesn't exist

isSet

public boolean isSet(String columnName)

Get if the specified column has been set

Parameters:

columnName - name of the column in the schema

Returns:

true if the column has been set

Throws:

IllegalArgumentException - if the column doesn't exist

isSet

public boolean isSet(int columnIndex)

Get if the specified column has been set

Parameters:

columnIndex - Column index in the schema

Returns:

true if the column has been set

Throws:

IndexOutOfBoundsException - if the column doesn't exist

encodePrimaryKey

public byte[] encodePrimaryKey()

Returns the encoded primary key of the row.

Returns:

a byte array containing an encoded primary key

toString

public String toString()

Overrides:

toString in class Object

stringifyRowKey

public String stringifyRowKey()

Transforms the row key into a string representation where each column is in the format: "type col_name=value".

Returns:

a string representation of the operation's row key