alluxio.master.table

Class AlluxioCatalog

java.lang.Object

alluxio.master.table.AlluxioCatalog

All Implemented Interfaces:

Checkpointed, Journaled, JournalEntryIterable

public class AlluxioCatalog
extends Object
implements Journaled

Class representing the Alluxio catalog.

Constructor Summary

Constructors

Constructor and Description
AlluxioCatalog() Creates an instance.

Method Summary

Modifier and Type	Method and Description
SyncStatus	attachDatabase(JournalContext journalContext, String udbType, String udbConnectionUri, String udbDbName, String dbName, Map<String,String> map, boolean ignoreSyncErrors) Attaches an udb database to Alluxio catalog.
void	completeTransformTable(JournalContext journalContext, String dbName, String tableName, String definition, Map<String,Layout> transformedLayouts) Completes table transformation by updating the layouts of the table's partitions.
boolean	detachDatabase(JournalContext journalContext, String dbName) Removes an existing database.
List<String>	getAllDatabases() Get all databases.
List<String>	getAllTables(String dbName) Get a list of tables in a database.
CheckpointName	getCheckpointName()
Database	getDatabase(String dbName) Get Database by its name.
CloseableIterator<Journal.JournalEntry>	getJournalEntryIterator()
LayoutRegistry	getLayoutRegistry()
Map<String,ColumnStatisticsList>	getPartitionColumnStatistics(String dbName, String tableName, List<String> partNames, List<String> colNames) Returns the statistics for the specified table.
Table	getTable(String dbName, String tableName) Get a table object by name.
List<ColumnStatisticsInfo>	getTableColumnStatistics(String dbName, String tableName, List<String> colNames) Returns the statistics for the specified table.
List<TransformPlan>	getTransformPlan(String dbName, String tableName, TransformDefinition definition)
boolean	processJournalEntry(Journal.JournalEntry entry) Attempts to apply a journal entry.
List<Partition>	readTable(String dbName, String tableName, Constraint constraint) Returns the partitions based on a constraint for the specified table.
void	resetState() Resets the object's journaled state.
SyncStatus	syncDatabase(JournalContext journalContext, String dbName) Syncs a database.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.master.journal.Journaled

applyAndJournal, restoreFromCheckpoint, writeToCheckpoint

Constructor Detail

AlluxioCatalog

public AlluxioCatalog()

Creates an instance.

Method Detail

getLayoutRegistry

public LayoutRegistry getLayoutRegistry()

Returns:

the layout registry

attachDatabase

public SyncStatus attachDatabase(JournalContext journalContext,
                                 String udbType,
                                 String udbConnectionUri,
                                 String udbDbName,
                                 String dbName,
                                 Map<String,String> map,
                                 boolean ignoreSyncErrors)
                          throws IOException

Attaches an udb database to Alluxio catalog.

Parameters:

journalContext - journal context

udbType - the database type

udbConnectionUri - the udb connection uri

udbDbName - the database name in the udb

dbName - the database name in Alluxio

map - the configuration

ignoreSyncErrors - if true, will ignore syncing errors during the attach

Returns:

the sync status for the attach

Throws:

IOException

syncDatabase

public SyncStatus syncDatabase(JournalContext journalContext,
                               String dbName)
                        throws IOException

Syncs a database.

Parameters:

journalContext - journal context

dbName - database name

Returns:

the resulting sync status

Throws:

IOException

detachDatabase

public boolean detachDatabase(JournalContext journalContext,
                              String dbName)
                       throws IOException

Removes an existing database.

Parameters:

journalContext - journal context

dbName - the database name

Returns:

true if database successfully created

Throws:

IOException

getTable

public Table getTable(String dbName,
                      String tableName)
               throws IOException

Get a table object by name.

Parameters:

dbName - the database name

tableName - the table name

Returns:

a table object

Throws:

IOException

getAllDatabases

public List<String> getAllDatabases()
                             throws IOException

Get all databases.

Returns:

a list of all database names

Throws:

IOException

getDatabase

public Database getDatabase(String dbName)
                     throws IOException

Get Database by its name.

Parameters:

dbName - database name

Returns:

a database object

Throws:

IOException

getAllTables

public List<String> getAllTables(String dbName)
                          throws IOException

Get a list of tables in a database.

Parameters:

dbName - database name

Returns:

a list of table names in the database

Throws:

IOException

getTableColumnStatistics

public List<ColumnStatisticsInfo> getTableColumnStatistics(String dbName,
                                                           String tableName,
                                                           List<String> colNames)
                                                    throws IOException

Returns the statistics for the specified table.

Parameters:

dbName - the database name

tableName - the table name

colNames - column names

Returns:

the statistics for the specified table

Throws:

IOException

getPartitionColumnStatistics

public Map<String,ColumnStatisticsList> getPartitionColumnStatistics(String dbName,
                                                                     String tableName,
                                                                     List<String> partNames,
                                                                     List<String> colNames)
                                                              throws IOException

Returns the statistics for the specified table.

Parameters:

dbName - the database name

tableName - the table name

partNames - partition names

colNames - column names

Returns:

the statistics for the partitions for a specific table

Throws:

IOException

readTable

public List<Partition> readTable(String dbName,
                                 String tableName,
                                 Constraint constraint)
                          throws IOException

Returns the partitions based on a constraint for the specified table.

Parameters:

dbName - the database name

tableName - the table name

constraint - the column contraint

Returns:

the partition info for the specified table

Throws:

IOException

completeTransformTable

public void completeTransformTable(JournalContext journalContext,
                                   String dbName,
                                   String tableName,
                                   String definition,
                                   Map<String,Layout> transformedLayouts)
                            throws IOException

Completes table transformation by updating the layouts of the table's partitions.

Parameters:

journalContext - the journal context

dbName - the database name

tableName - the table name

definition - the transformation definition

transformedLayouts - map from partition spec to the transformed layouts

Throws:

IOException

getTransformPlan

public List<TransformPlan> getTransformPlan(String dbName,
                                            String tableName,
                                            TransformDefinition definition)
                                     throws IOException

Parameters:

dbName - the database name

tableName - the table name

definition - the transformation definition

Returns:

the transformation plan for the table

Throws:

IOException

processJournalEntry

public boolean processJournalEntry(Journal.JournalEntry entry)

Description copied from interface: Journaled

Attempts to apply a journal entry.

Specified by:

processJournalEntry in interface Journaled

Parameters:

entry - the entry to apply

Returns:

whether the entry type is supported by this journaled object

resetState

public void resetState()

Description copied from interface: Journaled

Resets the object's journaled state.

Specified by:

resetState in interface Journaled

getJournalEntryIterator

public CloseableIterator<Journal.JournalEntry> getJournalEntryIterator()

Specified by:

getJournalEntryIterator in interface JournalEntryIterable

Returns:

an CloseableIterator that iterates all the journal entries

getCheckpointName

public CheckpointName getCheckpointName()

Specified by:

getCheckpointName in interface Checkpointed

Returns:

a name for this checkpointed class