org.kududb.client

Class KuduTable

java.lang.Object

org.kududb.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) Asynchronously get all or some tablets for this table.
com.stumbleupon.async.Deferred<List<LocatedTablet>>	asyncGetTabletsLocations(long deadline) Asynchronously get all the tablets for this table.
AsyncKuduClient	getAsyncClient() Get the async client that created this instance.
String	getName() Get this table's name.
Schema	getSchema() Get this table's schema, as of the moment this instance was created.
String	getTableId() Get this table's unique identifier.
List<LocatedTablet>	getTabletsLocations(byte[] startKey, byte[] endKey, long deadline) Get all or some tablets for this table.
List<LocatedTablet>	getTabletsLocations(long deadline) Get all the tablets for this table.
Delete	newDelete() Get a new delete configured with this table's schema.
Insert	newInsert() Get a new insert configured with this table's schema.
Update	newUpdate() Get a new update 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

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

getTabletsLocations

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

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

asyncGetTabletsLocations

public com.stumbleupon.async.Deferred<List<LocatedTablet>> asyncGetTabletsLocations(long deadline)
                                                                             throws Exception

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

Throws:

Exception

getTabletsLocations

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

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

asyncGetTabletsLocations

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

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

Throws:

Exception