io.cdap.cdap.api.dataset.table

Interface Table

All Superinterfaces:

AutoCloseable, BatchReadable<byte[],Row>, BatchWritable<byte[],Put>, Closeable, Dataset, RecordScannable<StructuredRecord>, RecordWritable<StructuredRecord>

All Known Implementing Classes:

IndexedTable

Deprecated.

table based datasets will be removed in a future version

@Deprecated
public interface Table
extends BatchReadable<byte[],Row>, BatchWritable<byte[],Put>, Dataset, RecordScannable<StructuredRecord>, RecordWritable<StructuredRecord>

An ordered, optionally explorable, named table.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COLUMN_FAMILY Deprecated. The default column family.
static String	PROPERTY_COLUMN_FAMILY Deprecated. Property set to configure name of the column family.
static String	PROPERTY_CONFLICT_LEVEL Deprecated. Property set to configure transaction conflict detection level.
static String	PROPERTY_READLESS_INCREMENT Deprecated. Property set to configure read-less increment support for a dataset.
static String	PROPERTY_SCHEMA Deprecated. Property set to configure schema for the table.
static String	PROPERTY_SCHEMA_ROW_FIELD Deprecated. Property set to configure which field in the schema is the row key.
static String	PROPERTY_TTL Deprecated. Property set to configure time-to-live on data within this dataset.
static String	TYPE Deprecated. Type name

Method Summary

Modifier and Type	Method and Description
boolean	compareAndSwap(byte[] key, byte[] keyColumn, byte[] oldValue, byte[] newValue) Deprecated. Compares-and-swaps (atomically) the value of the specified row and column by looking for an expected value and, if found, replacing it with the new value.
void	delete(byte[] row) Deprecated. Deletes all columns of the specified row.
void	delete(byte[] row, byte[] column) Deprecated. Deletes specified column of the specified row.
void	delete(byte[] row, byte[][] columns) Deprecated. Deletes specified columns of the specified row.
void	delete(Delete delete) Deprecated. Deletes columns of a row as defined by the Delete parameter.
Row	get(byte[] row) Deprecated. Reads values of all columns of the specified row.
byte[]	get(byte[] row, byte[] column) Deprecated. Reads the value of the specified column of the specified row.
Row	get(byte[] row, byte[][] columns) Deprecated. Reads the values of the specified columns of the specified row.
Row	get(byte[] row, byte[] startColumn, byte[] stopColumn, int limit) Deprecated. Reads the values of all columns in the specified row that are between the specified start (inclusive) and stop (exclusive) columns.
Row	get(Get get) Deprecated. Reads values of columns as defined by Get parameter.
List<Row>	get(List<Get> gets) Deprecated. Reads values for the rows and columns defined by the Get parameters.
List<Split>	getSplits(int numSplits, byte[] start, byte[] stop) Deprecated. Returns splits for a range of keys in the table.
void	increment(byte[] row, byte[][] columns, long[] amounts) Deprecated. Increments (atomically) the specified row and columns by the specified amounts, without returning the new values.
void	increment(byte[] row, byte[] column, long amount) Deprecated. Increments (atomically) the specified row and columns by the specified amounts, without returning the new value.
void	increment(Increment increment) Deprecated. Increments (atomically) the specified row and columns by the specified amounts, without returning the new values.
Row	incrementAndGet(byte[] row, byte[][] columns, long[] amounts) Deprecated. Increments the specified columns of the row by the specified amounts and returns the new values.
long	incrementAndGet(byte[] row, byte[] column, long amount) Deprecated. Increments the specified column of the row by the specified amount and returns the new value.
Row	incrementAndGet(Increment increment) Deprecated. Increments the specified columns of a row by the specified amounts defined by the Increment parameter and returns the new values
void	put(byte[] row, byte[][] columns, byte[][] values) Deprecated. Writes the specified values for the specified columns of the specified row.
void	put(byte[] row, byte[] column, byte[] value) Deprecated. Writes the specified value for the specified column of the specified row.
void	put(Put put) Deprecated. Writes values into a column of a row as defined by the Put parameter.
Scanner	scan(byte[] startRow, byte[] stopRow) Deprecated. Scans table.
Scanner	scan(Scan scan) Deprecated. Returns a Scanner as specified by a given Scan.
void	write(byte[] key, Put value) Deprecated. Writes the {key, value} record into a dataset.

Methods inherited from interface io.cdap.cdap.api.data.batch.BatchReadable

createSplitReader, getSplits

Methods inherited from interface io.cdap.cdap.api.data.batch.RecordScannable

createSplitRecordScanner, getRecordType, getSplits

Methods inherited from interface io.cdap.cdap.api.data.batch.RecordWritable

getRecordType, write

Methods inherited from interface java.io.Closeable

close

Field Detail

TYPE

static final String TYPE

Deprecated.

Type name

See Also:

Constant Field Values

PROPERTY_TTL

static final String PROPERTY_TTL

Deprecated.

Property set to configure time-to-live on data within this dataset. The value given is in seconds. Once a cell's data has surpassed the given value in age, the cell's data will no longer be visible and may be garbage collected.

See Also:

Constant Field Values

PROPERTY_READLESS_INCREMENT

static final String PROPERTY_READLESS_INCREMENT

Deprecated.

Property set to configure read-less increment support for a dataset. When not set, calling the increment(byte[], byte[], long) method will result in a normal read-modify-write operation.

See Also:

Constant Field Values

PROPERTY_COLUMN_FAMILY

static final String PROPERTY_COLUMN_FAMILY

Deprecated.

Property set to configure name of the column family. This property only applies to implementations that support it. If not set, a default column family will be used.

See Also:

Constant Field Values

DEFAULT_COLUMN_FAMILY

static final String DEFAULT_COLUMN_FAMILY

Deprecated.

The default column family. This is used if table properties do not specify a column family.

See Also:

Constant Field Values

PROPERTY_CONFLICT_LEVEL

static final String PROPERTY_CONFLICT_LEVEL

Deprecated.

Property set to configure transaction conflict detection level. This property only applies to implementations that support transaction. The property value must be obtained by Enum.name().

See Also:

ConflictDetection, Constant Field Values

PROPERTY_SCHEMA

static final String PROPERTY_SCHEMA

Deprecated.

Property set to configure schema for the table. Schema is currently not enforced when writing to a Table, but is used when exploring a Table. Field names from the schema will be read from columns of the same name. For example, if the schema contains an integer field named "count", the value for that field will be read from the "count" column. The schema can only contain simple types.

See Also:

Constant Field Values

PROPERTY_SCHEMA_ROW_FIELD

static final String PROPERTY_SCHEMA_ROW_FIELD

Deprecated.

Property set to configure which field in the schema is the row key.

See Also:

Constant Field Values

Method Detail

get

@Nonnull
Row get(byte[] row)

Deprecated.

Reads values of all columns of the specified row.

NOTE: Depending on the implementation of this interface and use-case, calling this method can be less efficient than calling the same method with columns as parameters because it can require making a round trip to the persistent store.

NOTE: objects that are passed in parameters can be re-used by underlying implementation and present in returned data structures from this method.

Parameters:

row - row to read from

Returns:

instance of Row: never null; returns an empty Row if nothing read

get

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

Deprecated.

Reads the value of the specified column of the specified row.

Parameters:

row - row to read from

column - column to read value for

Returns:

value of the column or null if the value is absent

get

@Nonnull
Row get(byte[] row,
                 byte[][] columns)

Deprecated.

Reads the values of the specified columns of the specified row.

NOTE: objects that are passed in parameters can be re-used by underlying implementation and present in returned data structures from this method.

Parameters:

row - row to read from

columns - collection of columns to read; if empty, will return an empty Row.

Returns:

instance of Row: never null; returns an empty Row if nothing read

get

@Nonnull
Row get(byte[] row,
                 byte[] startColumn,
                 byte[] stopColumn,
                 int limit)

Deprecated.

Reads the values of all columns in the specified row that are between the specified start (inclusive) and stop (exclusive) columns.

NOTE: objects that are passed in parameters can be re-used by underlying implementation and present in returned data structures from this method.

Parameters:

startColumn - beginning of range of columns, inclusive

stopColumn - end of range of columns, exclusive

limit - maximum number of columns to return

Returns:

instance of Row; never null; returns an empty Row if nothing read

get

@Nonnull
Row get(Get get)

Deprecated.

Reads values of columns as defined by Get parameter.

NOTE: objects that are passed in parameters can be re-used by underlying implementation and present in returned data structures from this method.

Parameters:

get - defines read selection

Returns:

instance of Row: never null; returns an empty Row if nothing read

get

List<Row> get(List<Get> gets)

Deprecated.

Reads values for the rows and columns defined by the Get parameters. When running in distributed mode, and retrieving multiple rows at the same time, this method should be preferred to multiple get(Get) calls, as the operations will be batched into a single remote call per server.

Parameters:

gets - defines the rows and columns to read

Returns:

a list of Row instances

put

void put(byte[] row,
         byte[] column,
         byte[] value)

Deprecated.

Writes the specified value for the specified column of the specified row.

Parameters:

row - row to write to

column - column to write to

value - to write

put

void put(byte[] row,
         byte[][] columns,
         byte[][] values)

Deprecated.

Writes the specified values for the specified columns of the specified row.

NOTE: Depending on the implementation, this can work faster than calling put(byte[], byte[], byte[]) multiple times (especially in transactions that alter many columns of one row).

Parameters:

row - row to write to

columns - columns to write to

values - array of values to write (same order as values)

put

void put(Put put)

Deprecated.

Writes values into a column of a row as defined by the Put parameter.

Parameters:

put - defines values to write

delete

void delete(byte[] row)

Deprecated.

Deletes all columns of the specified row.

NOTE: Depending on the implementation of this interface and use-case, calling this method can be less efficient than calling the same method with columns as parameters because it can require a round trip to the persistent store.

Parameters:

row - row to delete

delete

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

Deprecated.

Deletes specified column of the specified row.

Parameters:

row - row to delete from

column - column name to delete

delete

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

Deprecated.

Deletes specified columns of the specified row.

NOTE: Depending on the implementation, this can work faster than calling delete(byte[], byte[]) multiple times (especially in transactions that delete many columns of the same rows).

Parameters:

row - row to delete from

columns - names of columns to delete; if empty, nothing will be deleted

delete

void delete(Delete delete)

Deprecated.

Deletes columns of a row as defined by the Delete parameter.

Parameters:

delete - defines what to delete

incrementAndGet

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

Deprecated.

Increments the specified column of the row by the specified amount and returns the new value.

Parameters:

row - row which value to increment

column - column to increment

amount - amount to increment by

Returns:

new value of the column

Throws:

NumberFormatException - if stored value for the column is not in the serialized long value format

incrementAndGet

Row incrementAndGet(byte[] row,
                    byte[][] columns,
                    long[] amounts)

Deprecated.

Increments the specified columns of the row by the specified amounts and returns the new values.

NOTE: Depending on the implementation, this can work faster than calling incrementAndGet(byte[], byte[], long) multiple times (especially in a transaction that increments multiple columns of the same rows)

NOTE: objects that are passed in parameters can be re-used by underlying implementation and present in returned data structures from this method.

Parameters:

row - row whose values to increment

columns - columns to increment

amounts - amounts to increment columns by (in the same order as the columns)

Returns:

Row with a subset of changed columns

Throws:

NumberFormatException - if stored value for the column is not in the serialized long value format

incrementAndGet

Row incrementAndGet(Increment increment)

Deprecated.

Increments the specified columns of a row by the specified amounts defined by the Increment parameter and returns the new values

NOTE: objects that are passed in parameters can be re-used by underlying implementation and present in returned data structures from this method.

Parameters:

increment - defines changes

Returns:

Row with a subset of changed columns

Throws:

NumberFormatException - if stored value for the column is not in the serialized long value format

increment

void increment(byte[] row,
               byte[] column,
               long amount)

Deprecated.

Increments (atomically) the specified row and columns by the specified amounts, without returning the new value.

Parameters:

row - row which values to increment

column - column to increment

amount - amount to increment by

increment

void increment(byte[] row,
               byte[][] columns,
               long[] amounts)

Deprecated.

Increments (atomically) the specified row and columns by the specified amounts, without returning the new values. NOTE: depending on the implementation this may work faster than calling increment(byte[], byte[], long) multiple times (esp. in transaction that changes a lot of rows)

Parameters:

row - row which values to increment

columns - columns to increment

amounts - amounts to increment columns by (same order as columns)

increment

void increment(Increment increment)

Deprecated.

Increments (atomically) the specified row and columns by the specified amounts, without returning the new values. NOTE: depending on the implementation this may work faster than calling increment(byte[], byte[], long) multiple times (esp. in transaction that changes a lot of rows)

Parameters:

increment - the row and column increment amounts

scan

Scanner scan(@Nullable
             byte[] startRow,
             @Nullable
             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:

instance of Scanner

scan

@Beta
Scanner scan(Scan scan)

Deprecated.

Returns a Scanner as specified by a given Scan.

Parameters:

scan - a Scan instance

Returns:

instance of Scanner

getSplits

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

compareAndSwap

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

Deprecated.

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

Parameters:

key - row to modify

keyColumn - column 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)

write

void write(byte[] key,
           Put value)

Deprecated.

Writes the {key, value} record into a dataset.

Specified by:

write in interface BatchWritable<byte[],Put>

Parameters:

key - always ignored, and it is safe to write null as the key.

value - a Put for one row of the table.