io.cdap.cdap.api.dataset.lib

Class KeyValueTable

java.lang.Object

io.cdap.cdap.api.dataset.lib.AbstractDataset

io.cdap.cdap.api.dataset.lib.KeyValueTable

All Implemented Interfaces:

BatchReadable<byte[],byte[]>, BatchWritable<byte[],byte[]>, RecordScannable<KeyValue<byte[],byte[]>>, RecordWritable<KeyValue<byte[],byte[]>>, Dataset, MeteredDataset, Closeable, AutoCloseable, org.apache.tephra.TransactionAware

Deprecated.

table based datasets will be removed in a future version

@Deprecated
public class KeyValueTable
extends AbstractDataset
implements BatchReadable<byte[],byte[]>, BatchWritable<byte[],byte[]>, RecordScannable<KeyValue<byte[],byte[]>>, RecordWritable<KeyValue<byte[],byte[]>>

A key/value map implementation on top of Table supporting read, write and delete operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	KeyValueTable.KeyValueRecordMaker Deprecated. Scannables.RecordMaker for createSplitReader(Split).
class	KeyValueTable.KeyValueScanner Deprecated. The split reader for KeyValueTable.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE Deprecated. Type name

Constructor Summary

Constructors

Constructor and Description
KeyValueTable(String instanceName, Table table) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	compareAndSwap(byte[] key, byte[] oldValue, byte[] newValue) Deprecated. Compares-and-swaps (atomically) the value of the specified row and column by looking for the specified expected value and, if found, replacing with the specified new value.
SplitReader<byte[],byte[]>	createSplitReader(Split split) Deprecated. Creates a reader for the split of a dataset.
RecordScanner<KeyValue<byte[],byte[]>>	createSplitRecordScanner(Split split) Deprecated. Creates a reader for the split of a dataset.
void	delete(byte[] key) Deprecated. Delete a key.
void	delete(String key) Deprecated. Delete a key.
Type	getRecordType() Deprecated. The type of records that the dataset exposes as a schema.
List<Split>	getSplits() Deprecated. Returns all splits of the dataset.
List<Split>	getSplits(int numSplits, byte[] start, byte[] stop) Deprecated. Returns splits for a range of keys in the table.
void	increment(byte[] key, long amount) Deprecated. Increment the value of a key by amount; the key must either not exist yet, or the current value at the key must be 8 bytes long to be interpretable as a long.
long	incrementAndGet(byte[] key, long value) Deprecated. Increment the value for a given key and return the resulting value.
byte[]	read(byte[] key) Deprecated. Read the value for a given key.
byte[]	read(String key) Deprecated. Read the value for a given key.
Map<byte[],byte[]>	readAll(byte[][] keys) Deprecated. Reads the values for an array of given keys.
CloseableIterator<KeyValue<byte[],byte[]>>	scan(byte[] startRow, byte[] stopRow) Deprecated. Scans table.
void	write(byte[] key, byte[] value) Deprecated. Write a value to a key.
void	write(KeyValue<byte[],byte[]> keyValue) Deprecated. Writes the record into a dataset.
void	write(String key, byte[] value) Deprecated. Write a value to a key.
void	write(String key, String value) Deprecated. Write a value to a key.

Methods inherited from class io.cdap.cdap.api.dataset.lib.AbstractDataset

close, commitTx, getName, getTransactionAwareName, getTxChanges, postTxCommit, rollbackTx, setMetricsCollector, startTx, toString, updateTx

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

TYPE

public static final String TYPE

Deprecated.

Type name

See Also:

Constant Field Values

Constructor Detail

KeyValueTable

public KeyValueTable(String instanceName,
                     Table table)

Deprecated.

Method Detail

read

@Nullable
public byte[] read(String key)

Deprecated.

Read the value for a given key.

Parameters:

key - the key to read for

Returns:

the value for that key, or null if no value was found

read

@Nullable
public byte[] read(byte[] key)

Deprecated.

Read the value for a given key.

Parameters:

key - the key to read for

Returns:

the value for that key, or null if no value was found

readAll

public Map<byte[],byte[]> readAll(byte[][] keys)

Deprecated.

Reads the values for an array of given keys.

Parameters:

keys - the keys to be read

Returns:

a map of the stored values, keyed by key

incrementAndGet

public long incrementAndGet(byte[] key,
                            long value)

Deprecated.

Increment the value for a given key and return the resulting value.

Parameters:

key - the key to increment

Returns:

the incremented value of that key

write

public void write(byte[] key,
                  byte[] value)

Deprecated.

Write a value to a key.

Specified by:

write in interface BatchWritable<byte[],byte[]>

Parameters:

key - the key

value - the new value

write

public void write(String key,
                  String value)

Deprecated.

Write a value to a key.

Parameters:

key - the key

value - the new value

write

public void write(String key,
                  byte[] value)

Deprecated.

Write a value to a key.

Parameters:

key - the key

value - the new value

increment

public void increment(byte[] key,
                      long amount)

Deprecated.

Increment the value of a key by amount; the key must either not exist yet, or the current value at the key must be 8 bytes long to be interpretable as a long.

Parameters:

key - the key

amount - the amount to increment by

delete

public void delete(String key)

Deprecated.

Delete a key.

Parameters:

key - the key to delete

delete

public void delete(byte[] key)

Deprecated.

Delete a key.

Parameters:

key - the key to delete

compareAndSwap

public boolean compareAndSwap(byte[] key,
                              byte[] oldValue,
                              byte[] newValue)

Deprecated.

Compares-and-swaps (atomically) the value of the specified row and column by looking for the specified expected value and, if found, replacing with the specified new value.

Parameters:

key - key to modify

oldValue - expected value before change

newValue - value to set

Returns:

true if compare and swap succeeded, false otherwise (stored value is different from expected)

getRecordType

public Type getRecordType()

Deprecated.

Description copied from interface: RecordScannable

The type of records that the dataset exposes as a schema. The schema will be derived from the type using reflection.

Specified by:

getRecordType in interface RecordScannable<KeyValue<byte[],byte[]>>

Specified by:

getRecordType in interface RecordWritable<KeyValue<byte[],byte[]>>

Returns:

the schema type.

getSplits

public List<Split> getSplits()

Deprecated.

Description copied from interface: BatchReadable

Returns all splits of the dataset.

For feeding the whole dataset into a batch job.

Specified by:

getSplits in interface BatchReadable<byte[],byte[]>

Specified by:

getSplits in interface RecordScannable<KeyValue<byte[],byte[]>>

Returns:

A list of Splits.

createSplitRecordScanner

public RecordScanner<KeyValue<byte[],byte[]>> createSplitRecordScanner(Split split)

Deprecated.

Description copied from interface: RecordScannable

Creates a reader for the split of a dataset.

Specified by:

createSplitRecordScanner in interface RecordScannable<KeyValue<byte[],byte[]>>

Parameters:

split - The split to create a reader for.

Returns:

The instance of a RecordScanner.

getSplits

public List<Split> getSplits(int numSplits,
                             @Nullable
                             byte[] start,
                             @Nullable
                             byte[] stop)

Deprecated.

Returns splits for a range of keys in the table.

Parameters:

numSplits - Desired number of splits. If greater than zero, at most this many splits will be returned. If less than or equal to zero, any number of splits can be returned.

start - if non-null, the returned splits will only cover keys that are greater or equal

stop - if non-null, the returned splits will only cover keys that are less

Returns:

list of Split

createSplitReader

public SplitReader<byte[],byte[]> createSplitReader(Split split)

Deprecated.

Description copied from interface: BatchReadable

Creates a reader for the split of a dataset.

Specified by:

createSplitReader in interface BatchReadable<byte[],byte[]>

Parameters:

split - The split to create a reader for.

Returns:

The instance of a SplitReader.

write

public void write(KeyValue<byte[],byte[]> keyValue)
           throws IOException

Deprecated.

Description copied from interface: RecordWritable

Writes the record into a dataset.

Specified by:

write in interface RecordWritable<KeyValue<byte[],byte[]>>

Parameters:

keyValue - record to write into the dataset.

Throws:

IOException - when the RECORD could not be written to the dataset.

scan

public CloseableIterator<KeyValue<byte[],byte[]>> scan(byte[] startRow,
                                                       byte[] stopRow)

Deprecated.

Scans table.

Parameters:

startRow - start row inclusive. null means start from first row of the table

stopRow - stop row exclusive. null means scan all rows to the end of the table

Returns:

CloseableIterator of KeyValue<byte[], byte[]>