org.apache.kudu.client

Class KuduTable

java.lang.Object

org.apache.kudu.client.KuduTable

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

A KuduTable represents a table on a particular cluster. It holds the current schema of the table. Any given KuduTable instance belongs to a specific AsyncKuduClient instance. Upon construction, the table is looked up in the catalog (or catalog cache), and the schema fetched for introspection. The schema is not kept in sync with the master. This class is thread-safe.

Method Summary

Modifier and Type	Method and Description
com.stumbleupon.async.Deferred<List<LocatedTablet>>	asyncGetTabletsLocations(byte[] startKey, byte[] endKey, long deadline) Deprecated. use the KuduScanToken API
com.stumbleupon.async.Deferred<List<LocatedTablet>>	asyncGetTabletsLocations(long deadline) Deprecated. use the KuduScanToken API
AsyncKuduClient	getAsyncClient() Get the async client that created this instance.
Map<String,String>	getExtraConfig() Get this table's extra configuration properties.
String	getName() Get this table's name.
int	getNumReplicas() Get this table's replication factor.
String	getOwner() Get this table's owner.
Schema	getSchema() Get this table's schema, as of the moment this instance was created.
String	getTableId() Get this table's unique identifier.
KuduTableStatistics	getTableStatistics() Get this table's statistics.
List<LocatedTablet>	getTabletsLocations(byte[] startKey, byte[] endKey, long deadline) Deprecated. use the KuduScanToken API
List<LocatedTablet>	getTabletsLocations(long deadline) Deprecated. use the KuduScanToken API
Delete	newDelete() Get a new delete configured with this table's schema.
DeleteIgnore	newDeleteIgnore() Get a new delete ignore configured with this table's schema.
Insert	newInsert() Get a new insert configured with this table's schema.
InsertIgnore	newInsertIgnore() Get a new insert ignore configured with this table's schema.
Update	newUpdate() Get a new update configured with this table's schema.
UpdateIgnore	newUpdateIgnore() Get a new update ignore configured with this table's schema.
Upsert	newUpsert() Get a new upsert configured with this table's schema.

Methods inherited from class java.lang.Object

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

Method Detail

getSchema

public Schema getSchema()

Get this table's schema, as of the moment this instance was created.

Returns:

this table's schema

getName

public String getName()

Get this table's name.

Returns:

this table's name

getTableId

public String getTableId()

Get this table's unique identifier.

Returns:

this table's tableId

getNumReplicas

public int getNumReplicas()

Get this table's replication factor.

Returns:

this table's replication factor

getExtraConfig

public Map<String,String> getExtraConfig()

Get this table's extra configuration properties.

Returns:

this table's extra configuration properties

getOwner

public String getOwner()

Get this table's owner.

Returns:

this table's owner or an empty string if the table was created without owner on a version of Kudu that didn't automatically assign an owner.

getAsyncClient

public AsyncKuduClient getAsyncClient()

Get the async client that created this instance.

Returns:

an async kudu client

newInsert

public Insert newInsert()

Get a new insert configured with this table's schema. The returned object should not be reused.

Returns:

an insert with this table's schema

newUpdate

public Update newUpdate()

Get a new update configured with this table's schema. The returned object should not be reused.

Returns:

an update with this table's schema

newDelete

public Delete newDelete()

Get a new delete configured with this table's schema. The returned object should not be reused.

Returns:

a delete with this table's schema

newUpsert

public Upsert newUpsert()

Get a new upsert configured with this table's schema. The returned object should not be reused.

Returns:

an upsert with this table's schema

newInsertIgnore

public InsertIgnore newInsertIgnore()

Get a new insert ignore configured with this table's schema. An insert ignore will ignore duplicate row errors. This is useful when the same insert may be sent multiple times. The returned object should not be reused.

Returns:

an insert ignore with this table's schema

newUpdateIgnore

public UpdateIgnore newUpdateIgnore()

Get a new update ignore configured with this table's schema. An update ignore will ignore missing row errors. This is useful to update a row only if it exists. The returned object should not be reused.

Returns:

an update ignore with this table's schema

newDeleteIgnore

public DeleteIgnore newDeleteIgnore()

Get a new delete ignore configured with this table's schema. An delete ignore will ignore missing row errors. This is useful to delete a row only if it exists. The returned object should not be reused.

Returns:

a delete ignore with this table's schema

asyncGetTabletsLocations

@Deprecated
public com.stumbleupon.async.Deferred<List<LocatedTablet>> asyncGetTabletsLocations(long deadline)

Deprecated. use the KuduScanToken API

Asynchronously get all the tablets for this table.

Parameters:

deadline - max time spent in milliseconds for the deferred result of this method to get called back, if deadline is reached, the deferred result will get erred back

Returns:

a Deferred object that yields a list containing the metadata and locations for each of the tablets in the table

asyncGetTabletsLocations

@Deprecated
public com.stumbleupon.async.Deferred<List<LocatedTablet>> asyncGetTabletsLocations(byte[] startKey,
                                                                                                byte[] endKey,
                                                                                                long deadline)

Deprecated. use the KuduScanToken API

Asynchronously get all or some tablets for this table.

Parameters:

startKey - where to start in the table, pass null to start at the beginning

endKey - where to stop in the table (exclusive), pass null to get all the tablets until the end of the table

deadline - max time spent in milliseconds for the deferred result of this method to get called back, if deadline is reached, the deferred result will get erred back

Returns:

a Deferred object that yields a list containing the metadata and locations for each of the tablets in the table

getTabletsLocations

@Deprecated
public List<LocatedTablet> getTabletsLocations(long deadline)
                                                    throws Exception

Deprecated. use the KuduScanToken API

Get all the tablets for this table. This may query the master multiple times if there are a lot of tablets.

Parameters:

deadline - deadline in milliseconds for this method to finish

Returns:

a list containing the metadata and locations for each of the tablets in the table

Throws:

Exception

getTabletsLocations

@Deprecated
public List<LocatedTablet> getTabletsLocations(byte[] startKey,
                                                           byte[] endKey,
                                                           long deadline)
                                                    throws Exception

Deprecated. use the KuduScanToken API

Get all or some tablets for this table. This may query the master multiple times if there are a lot of tablets. This method blocks until it gets all the tablets.

Parameters:

startKey - where to start in the table, pass null to start at the beginning

endKey - where to stop in the table (exclusive), pass null to get all the tablets until the end of the table

deadline - deadline in milliseconds for this method to finish

Returns:

a list containing the metadata and locations for each of the tablets in the table

Throws:

Exception

getTableStatistics

public KuduTableStatistics getTableStatistics()
                                       throws KuduException

Get this table's statistics.

Returns:

this table's statistics

Throws:

KuduException