org.kududb.client

Class PartialRow

java.lang.Object

org.kududb.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	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.
byte[]	encodePrimaryKey() Returns the encoded primary key of the row.
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".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

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

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 column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

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

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 column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

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

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 column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

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

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 column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

addLong

public void addLong(String columnName,
                    long val)

Add an long for the specified column. If this is a TIMESTAMP 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

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 column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

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

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 column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

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

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 column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

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

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 column doesn't exist or if the value doesn't match the column's type

IllegalStateException - if the row was already applied

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 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,
                      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 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,
                      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

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

encodePrimaryKey

public byte[] encodePrimaryKey()

Returns the encoded primary key of the row.

Returns:

a byte array containing an encoded primary key

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