alluxio.client.table

Class RetryHandlingTableMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

alluxio.client.table.RetryHandlingTableMasterClient

All Implemented Interfaces:

Client, TableMasterClient, Closeable, AutoCloseable

@ThreadSafe
public final class RetryHandlingTableMasterClient
extends AbstractMasterClient
implements TableMasterClient

A wrapper for the gRPC client to interact with the table master.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

Nested classes/interfaces inherited from interface alluxio.client.table.TableMasterClient

TableMasterClient.Factory

Field Summary

Fields inherited from class alluxio.AbstractClient

mChannel, mClosed, mConnected, mContext, mServerAddress, mServiceVersion, mVersionService

Constructor Summary

Constructors

Constructor and Description
RetryHandlingTableMasterClient(MasterClientContext conf) Creates a new block master client.

Method Summary

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
SyncStatus	attachDatabase(String udbType, String udbConnectionUri, String udbDbName, String dbName, Map<String,String> configuration, boolean ignoreSyncErrors) Attaches an existing database.
boolean	detachDatabase(String dbName) Detaches an existing database in the catalog master.
List<String>	getAllDatabases() Get a list of all database names.
List<String>	getAllTables(String databaseName) Get a list of all table names.
List<TransformJobInfo>	getAllTransformJobInfo()
Database	getDatabase(String databaseName) Get database metadata.
Map<String,List<ColumnStatisticsInfo>>	getPartitionColumnStatistics(String databaseName, String tableName, List<String> partitionNames, List<String> columnNames) Get column statistics for selected partition and column.
List<String>	getPartitionNames(String databaseName, String tableName) Get partition names with given database name and table name.
protected ServiceType	getRemoteServiceType()
protected String	getServiceName()
protected long	getServiceVersion()
TableInfo	getTable(String databaseName, String tableName) Get table metadata.
List<ColumnStatisticsInfo>	getTableColumnStatistics(String databaseName, String tableName, List<String> columnNames) Get table column statistics with given database name, table name and list of column names.
TransformJobInfo	getTransformJobInfo(long jobId)
List<Partition>	readTable(String databaseName, String tableName, Constraint constraint) Returns metadata for reading a table given constraints.
SyncStatus	syncDatabase(String dbName) Syncs an existing database in the catalog master.
long	transformTable(String dbName, String tableName, String definition) Transforms a table.

Methods inherited from class alluxio.AbstractMasterClient

afterDisconnect, beforeConnect, getConfAddress, queryGrpcServerAddress

Methods inherited from class alluxio.AbstractClient

beforeDisconnect, checkVersion, close, connect, connectWithRuntimeException, disconnect, getRemoteHostName, getRemoteServiceVersion, getRemoteSockAddress, isClosed, isConnected, retryRPC, retryRPC

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.Client

connect, disconnect, getConfAddress, getRemoteHostName, getRemoteSockAddress, isClosed, isConnected

Methods inherited from interface java.io.Closeable

close

Constructor Detail

RetryHandlingTableMasterClient

public RetryHandlingTableMasterClient(MasterClientContext conf)

Creates a new block master client.

Parameters:

conf - master client configuration

Method Detail

getRemoteServiceType

protected ServiceType getRemoteServiceType()

Specified by:

getRemoteServiceType in class AbstractClient

Returns:

the expected type of remote service

getServiceName

protected String getServiceName()

Specified by:

getServiceName in class AbstractClient

Returns:

a string representing the specific service

getServiceVersion

protected long getServiceVersion()

Specified by:

getServiceVersion in class AbstractClient

Returns:

the client service version

afterConnect

protected void afterConnect()

Description copied from class: AbstractClient

This method is called after the connection is made to the remote. Implementations should create internal state to finish the connection process.

Overrides:

afterConnect in class AbstractClient

getAllDatabases

public List<String> getAllDatabases()
                             throws AlluxioStatusException

Description copied from interface: TableMasterClient

Get a list of all database names.

Specified by:

getAllDatabases in interface TableMasterClient

Returns:

list of database names

Throws:

AlluxioStatusException

getDatabase

public Database getDatabase(String databaseName)
                     throws AlluxioStatusException

Description copied from interface: TableMasterClient

Get database metadata.

Specified by:

getDatabase in interface TableMasterClient

Parameters:

databaseName - database name

Returns:

database metadata

Throws:

AlluxioStatusException

getAllTables

public List<String> getAllTables(String databaseName)
                          throws AlluxioStatusException

Description copied from interface: TableMasterClient

Get a list of all table names.

Specified by:

getAllTables in interface TableMasterClient

Parameters:

databaseName - database name

Returns:

list of table names

Throws:

AlluxioStatusException

getTable

public TableInfo getTable(String databaseName,
                          String tableName)
                   throws AlluxioStatusException

Description copied from interface: TableMasterClient

Get table metadata.

Specified by:

getTable in interface TableMasterClient

Parameters:

databaseName - database name

tableName - table name

Returns:

table metadata

Throws:

AlluxioStatusException

attachDatabase

public SyncStatus attachDatabase(String udbType,
                                 String udbConnectionUri,
                                 String udbDbName,
                                 String dbName,
                                 Map<String,String> configuration,
                                 boolean ignoreSyncErrors)
                          throws AlluxioStatusException

Description copied from interface: TableMasterClient

Attaches an existing database.

Specified by:

attachDatabase in interface TableMasterClient

Parameters:

udbType - the database type

udbConnectionUri - the udb connection uri

udbDbName - the database name in the udb

dbName - the database name in Alluxio

configuration - the configuration map

ignoreSyncErrors - will ignore sync errors if true

Returns:

the sync status for the attach

Throws:

AlluxioStatusException

detachDatabase

public boolean detachDatabase(String dbName)
                       throws AlluxioStatusException

Description copied from interface: TableMasterClient

Detaches an existing database in the catalog master.

Specified by:

detachDatabase in interface TableMasterClient

Parameters:

dbName - database name

Returns:

true if database created successfully

Throws:

AlluxioStatusException

syncDatabase

public SyncStatus syncDatabase(String dbName)
                        throws AlluxioStatusException

Description copied from interface: TableMasterClient

Syncs an existing database in the catalog master.

Specified by:

syncDatabase in interface TableMasterClient

Parameters:

dbName - database name

Returns:

the sync status

Throws:

AlluxioStatusException

readTable

public List<Partition> readTable(String databaseName,
                                 String tableName,
                                 Constraint constraint)
                          throws AlluxioStatusException

Description copied from interface: TableMasterClient

Returns metadata for reading a table given constraints.

Specified by:

readTable in interface TableMasterClient

Parameters:

databaseName - database name

tableName - table name

constraint - constraint on the columns

Returns:

list of partitions

Throws:

AlluxioStatusException

getTableColumnStatistics

public List<ColumnStatisticsInfo> getTableColumnStatistics(String databaseName,
                                                           String tableName,
                                                           List<String> columnNames)
                                                    throws AlluxioStatusException

Description copied from interface: TableMasterClient

Get table column statistics with given database name, table name and list of column names.

Specified by:

getTableColumnStatistics in interface TableMasterClient

Parameters:

databaseName - database name

tableName - table name

columnNames - column names

Returns:

list of column statistics

Throws:

AlluxioStatusException

getPartitionNames

public List<String> getPartitionNames(String databaseName,
                                      String tableName)
                               throws AlluxioStatusException

Description copied from interface: TableMasterClient

Get partition names with given database name and table name.

Specified by:

getPartitionNames in interface TableMasterClient

Parameters:

databaseName - database name

tableName - table name

Returns:

list of partition names

Throws:

AlluxioStatusException

getPartitionColumnStatistics

public Map<String,List<ColumnStatisticsInfo>> getPartitionColumnStatistics(String databaseName,
                                                                           String tableName,
                                                                           List<String> partitionNames,
                                                                           List<String> columnNames)
                                                                    throws AlluxioStatusException

Description copied from interface: TableMasterClient

Get column statistics for selected partition and column.

Specified by:

getPartitionColumnStatistics in interface TableMasterClient

Parameters:

databaseName - database name

tableName - table name

partitionNames - partition names

columnNames - column names

Returns:

Map<String partitionName, Map<String columnName, columnStatistics>>

Throws:

AlluxioStatusException

transformTable

public long transformTable(String dbName,
                           String tableName,
                           String definition)
                    throws AlluxioStatusException

Description copied from interface: TableMasterClient

Transforms a table.

Specified by:

transformTable in interface TableMasterClient

Parameters:

dbName - the database name

tableName - the table name

definition - the transformation definition

Returns:

job ID which can be used to poll the job status from job service

Throws:

AlluxioStatusException

getTransformJobInfo

public TransformJobInfo getTransformJobInfo(long jobId)
                                     throws AlluxioStatusException

Specified by:

getTransformJobInfo in interface TableMasterClient

Parameters:

jobId - the transformation job's ID

Returns:

the job info

Throws:

AlluxioStatusException

getAllTransformJobInfo

public List<TransformJobInfo> getAllTransformJobInfo()
                                              throws AlluxioStatusException

Specified by:

getAllTransformJobInfo in interface TableMasterClient

Returns:

a list of information for all transformation jobs

Throws:

AlluxioStatusException