co.cask.cdap.data2.dataset2.lib.table

Interface MetricsTable

All Superinterfaces:

AutoCloseable, Closeable, co.cask.cdap.api.dataset.Dataset

All Known Implementing Classes:

HBaseMetricsTable, InMemoryMetricsTable, LevelDBMetricsTable

public interface MetricsTable
extends co.cask.cdap.api.dataset.Dataset

A table interface dedicated to our metrics system and is currently used by Cube dataset.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(byte[] row, byte[][] columns) Deletes specified columns of the specified row.
byte[]	get(byte[] row, byte[] column) Read single column of a row
void	increment(byte[] row, Map<byte[],Long> increments) Atomic increment of multiple columns of a row.
void	increment(NavigableMap<byte[],NavigableMap<byte[],Long>> updates) Batch increment multiple rows each with multiple columns and increments
long	incrementAndGet(byte[] row, byte[] column, long delta) Increment a single column of a row and return the new value.
void	put(SortedMap<byte[],? extends SortedMap<byte[],Long>> updates) Write multiple rows, each with multiple individual columns to write.
co.cask.cdap.api.dataset.table.Scanner	scan(byte[] start, byte[] stop, FuzzyRowFilter filter) Get a scanner for a table.
boolean	swap(byte[] row, byte[] column, byte[] oldValue, byte[] newValue) Atomically compare a single column of a row with a expected value, and if it matches, replace it with a new value.

Methods inherited from interface java.io.Closeable

close

Method Detail

get

@Nullable
byte[] get(byte[] row,
                  byte[] column)

Read single column of a row

put

void put(SortedMap<byte[],? extends SortedMap<byte[],Long>> updates)

Write multiple rows, each with multiple individual columns to write.

swap

boolean swap(byte[] row,
           byte[] column,
           byte[] oldValue,
           byte[] newValue)

Atomically compare a single column of a row with a expected value, and if it matches, replace it with a new value.

Parameters:

oldValue - the expected value of the column. If null, this means that the column must not exist.

newValue - the new value of the column. If null, the effect to delete the column if the comparison succeeds.

Returns:

whether the write happened, that is, whether the existing value of the column matched the expected value.

increment

void increment(byte[] row,
             Map<byte[],Long> increments)

Atomic increment of multiple columns of a row. If a column does not exist prior to the increment, its value is assumed zero. Increments are only guaranteed atomic with respect to other increments.

Parameters:

increments - Map from each column key to the value it should be incremented by.

increment

void increment(NavigableMap<byte[],NavigableMap<byte[],Long>> updates)

Batch increment multiple rows each with multiple columns and increments

incrementAndGet

long incrementAndGet(byte[] row,
                   byte[] column,
                   long delta)

Increment a single column of a row and return the new value.

Returns:

the new value after the increment.

delete

void delete(byte[] row,
          byte[][] columns)

Deletes specified columns of the specified row.

Parameters:

row - row to delete from

columns - names of columns to delete

scan

co.cask.cdap.api.dataset.table.Scanner scan(@Nullable
                                          byte[] start,
                                          @Nullable
                                          byte[] stop,
                                          @Nullable
                                          FuzzyRowFilter filter)

Get a scanner for a table.

Parameters:

start - the row key of the first row to scan. If null, the scan begins at the first row of the table.

stop - the row key of the last row to scan. If null, the scan goes to the last row of the table.

filter - if non-null, a fuzzy row filter used to efficiently skip over entire rows.