alluxio.cli.table.command

Class ListDatabasesCommand

java.lang.Object

alluxio.cli.table.command.AbstractTableCommand

alluxio.cli.table.command.ListDatabasesCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

public class ListDatabasesCommand
extends AbstractTableCommand

List information about attached databases and tables in the Alluxio catalog. This command has similar function to what a SHOW TABLES or SHOW DATABASES query would return but makes it easier to query on a local machine what the Alluxio catalog currently stores without needing to boot up a presto instance.

Field Summary

Fields inherited from class alluxio.cli.table.command.AbstractTableCommand

mClient, mConf

Constructor Summary

Constructors

Constructor and Description
ListDatabasesCommand(AlluxioConfiguration conf, TableMasterClient client) Creates a new instance of ListDatabasesCommand.

Method Summary

Modifier and Type	Method and Description
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
String	getUsage()
int	listDatabases() Print attached databases to stdout.
int	listTable(String db, String tableName) Print table information to stdout.
int	listTables(String db) Print list of tables stdout.
int	run(org.apache.commons.cli.CommandLine cl) Runs the command.
void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

close, getOptions, getSubCommands, hasSubCommand, parseAndValidateArgs

Constructor Detail

ListDatabasesCommand

public ListDatabasesCommand(AlluxioConfiguration conf,
                            TableMasterClient client)

Creates a new instance of ListDatabasesCommand.

Parameters:

conf - alluxio configuration

client - the table master client

Method Detail

getCommandName

public String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Specified by:

getCommandName in interface Command

Specified by:

getCommandName in class AbstractTableCommand

Returns:

the command name

getDescription

public String getDescription()

Returns:

the description information of the command

getUsage

public String getUsage()

Returns:

the usage information of the command

validateArgs

public void validateArgs(org.apache.commons.cli.CommandLine cl)
                  throws InvalidArgumentException

Description copied from interface: Command

Checks if the arguments are valid or throw InvalidArgumentException.

Specified by:

validateArgs in interface Command

Specified by:

validateArgs in class AbstractTableCommand

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws AlluxioException,
               IOException

Description copied from interface: Command

Runs the command.

Specified by:

run in interface Command

Specified by:

run in class AbstractTableCommand

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command

Throws:

AlluxioException

IOException

listDatabases

public int listDatabases()
                  throws AlluxioStatusException,
                         IOException

Print attached databases to stdout.

Returns:

0 on success, any non-zero value otherwise

Throws:

AlluxioStatusException

IOException

listTables

public int listTables(String db)
               throws AlluxioStatusException

Print list of tables stdout.

Parameters:

db - the database to list the tables of

Returns:

0 on success, any non-zero value otherwise

Throws:

AlluxioStatusException

listTable

public int listTable(String db,
                     String tableName)
              throws AlluxioStatusException

Print table information to stdout.

Parameters:

db - the database the table exists in

tableName - the name of the table to dump information for

Returns:

0 on success, any non-zero value otherwise

Throws:

AlluxioStatusException