alluxio.client.table

Interface TableMasterClient

All Superinterfaces:

java.lang.AutoCloseable, Client, java.io.Closeable

All Known Implementing Classes:

RetryHandlingTableMasterClient

@ThreadSafe
public interface TableMasterClient
extends Client

A client to use for interacting with a table master.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TableMasterClient.Factory Factory for TableMasterClient.

Method Summary

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

Methods inherited from interface alluxio.Client

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

Methods inherited from interface java.io.Closeable

close

Method Detail

getAllDatabases

java.util.List<java.lang.String> getAllDatabases()
                                          throws AlluxioStatusException

Get a list of all database names.

Returns:

list of database names

Throws:

AlluxioStatusException

getDatabase

Database getDatabase(java.lang.String databaseName)
              throws AlluxioStatusException

Get database metadata.

Parameters:

databaseName - database name

Returns:

database metadata

Throws:

AlluxioStatusException

getAllTables

java.util.List<java.lang.String> getAllTables(java.lang.String databaseName)
                                       throws AlluxioStatusException

Get a list of all table names.

Parameters:

databaseName - database name

Returns:

list of table names

Throws:

AlluxioStatusException

getTable

TableInfo getTable(java.lang.String databaseName,
                   java.lang.String tableName)
            throws AlluxioStatusException

Get table metadata.

Parameters:

databaseName - database name

tableName - table name

Returns:

table metadata

Throws:

AlluxioStatusException

attachDatabase

SyncStatus attachDatabase(java.lang.String udbType,
                          java.lang.String udbConnectionUri,
                          java.lang.String udbDbName,
                          java.lang.String dbName,
                          java.util.Map<java.lang.String,java.lang.String> configuration,
                          boolean ignoreSyncErrors)
                   throws AlluxioStatusException

Attaches an existing database.

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

boolean detachDatabase(java.lang.String dbName)
                throws AlluxioStatusException

Detaches an existing database in the catalog master.

Parameters:

dbName - database name

Returns:

true if database created successfully

Throws:

AlluxioStatusException

syncDatabase

SyncStatus syncDatabase(java.lang.String dbName)
                 throws AlluxioStatusException

Syncs an existing database in the catalog master.

Parameters:

dbName - database name

Returns:

the sync status

Throws:

AlluxioStatusException

readTable

java.util.List<Partition> readTable(java.lang.String databaseName,
                                    java.lang.String tableName,
                                    Constraint constraint)
                             throws AlluxioStatusException

Returns metadata for reading a table given constraints.

Parameters:

databaseName - database name

tableName - table name

constraint - constraint on the columns

Returns:

list of partitions

Throws:

AlluxioStatusException

getTableColumnStatistics

java.util.List<ColumnStatisticsInfo> getTableColumnStatistics(java.lang.String databaseName,
                                                              java.lang.String tableName,
                                                              java.util.List<java.lang.String> columnNames)
                                                       throws AlluxioStatusException

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

Parameters:

databaseName - database name

tableName - table name

columnNames - column names

Returns:

list of column statistics

Throws:

AlluxioStatusException

getPartitionNames

java.util.List<java.lang.String> getPartitionNames(java.lang.String databaseName,
                                                   java.lang.String tableName)
                                            throws AlluxioStatusException

Get partition names with given database name and table name.

Parameters:

databaseName - database name

tableName - table name

Returns:

list of partition names

Throws:

AlluxioStatusException

getPartitionColumnStatistics

java.util.Map<java.lang.String,java.util.List<ColumnStatisticsInfo>> getPartitionColumnStatistics(java.lang.String databaseName,
                                                                                                  java.lang.String tableName,
                                                                                                  java.util.List<java.lang.String> partitionNames,
                                                                                                  java.util.List<java.lang.String> columnNames)
                                                                                           throws AlluxioStatusException

Get column statistics for selected partition and column.

Parameters:

databaseName - database name

tableName - table name

partitionNames - partition names

columnNames - column names

Returns:

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

Throws:

AlluxioStatusException

transformTable

long transformTable(java.lang.String dbName,
                    java.lang.String tableName,
                    java.lang.String definition)
             throws AlluxioStatusException

Transforms a table.

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

TransformJobInfo getTransformJobInfo(long jobId)
                              throws AlluxioStatusException

Parameters:

jobId - the transformation job's ID

Returns:

the job info

Throws:

AlluxioStatusException

getAllTransformJobInfo

java.util.List<TransformJobInfo> getAllTransformJobInfo()
                                                 throws AlluxioStatusException

Returns:

a list of information for all transformation jobs

Throws:

AlluxioStatusException