org.apache.hadoop.hive.ql.parse

Class HiveTableName

java.lang.Object

org.apache.hadoop.hive.common.TableName

org.apache.hadoop.hive.ql.parse.HiveTableName

All Implemented Interfaces:

Serializable

public final class HiveTableName
extends TableName

A utility class for TableName.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HiveTableName(String catName, String dbName, String tableName)

Method Summary

Modifier and Type	Method and Description
static TableName	of(String dbTableName) Accepts qualified name which is in the form of table, dbname.tablename or catalog.dbname.tablename and returns a TableName.
static TableName	of(Table table) Get a TableName object based on a Table.
static TableName	ofNullable(String dbTableName) Deprecated. use of(String) or TableName.fromString(String, String, String)
static TableName	ofNullable(String dbTableName, String defaultDb) Deprecated. use of(String) or TableName.fromString(String, String, String)
static TableName	ofNullableWithNoDefault(String dbTableName) Deprecated. use of(String) or TableName.fromString(String, String, String)
static Table	setFrom(String dbTable, Table table) Set a @Table object's table and db names based on the provided string.
static TableName	withNoDefault(String dbTableName) Deprecated. use of(String) instead and use the default db/catalog.

Methods inherited from class org.apache.hadoop.hive.common.TableName

equals, fromString, fromString, getCat, getDb, getDbTable, getDbTable, getEscapedNotEmptyDbTable, getMetaTable, getNotEmptyDbTable, getQualified, getTable, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HiveTableName

public HiveTableName(String catName,
                     String dbName,
                     String tableName)

Method Detail

of

public static TableName of(Table table)
                    throws SemanticException

Get a TableName object based on a Table. This is basically a wrapper of TableName.fromString(String, String, String) to throw a SemanticException in case of errors.

Parameters:

table - the table

Returns:

a TableName

Throws:

SemanticException

setFrom

public static Table setFrom(String dbTable,
                            Table table)
                     throws SemanticException

Set a @Table object's table and db names based on the provided string.

Parameters:

dbTable - the dbtable string

table - the table to update

Returns:

the table

Throws:

SemanticException

ofNullable

public static TableName ofNullable(String dbTableName)
                            throws SemanticException

Deprecated. use of(String) or TableName.fromString(String, String, String)

Accepts qualified name which is in the form of table, dbname.tablename or catalog.dbname.tablename and returns a TableName. All parts can be null.

Parameters:

dbTableName -

Returns:

a TableName

Throws:

SemanticException

ofNullableWithNoDefault

public static TableName ofNullableWithNoDefault(String dbTableName)
                                         throws SemanticException

Deprecated. use of(String) or TableName.fromString(String, String, String)

Accepts qualified name which is in the form of table, dbname.tablename or catalog.dbname.tablename and returns a TableName. All parts can be null. This method won't try to find the default db based on the session state.

Parameters:

dbTableName -

Returns:

a TableName

Throws:

SemanticException

ofNullable

public static TableName ofNullable(String dbTableName,
                                   String defaultDb)
                            throws SemanticException

Deprecated. use of(String) or TableName.fromString(String, String, String)

Accepts qualified name which is in the form of table, dbname.tablename or catalog.dbname.tablename and returns a TableName. All parts can be null.

Parameters:

dbTableName -

defaultDb -

Returns:

a TableName

Throws:

SemanticException

withNoDefault

public static TableName withNoDefault(String dbTableName)
                               throws SemanticException

Deprecated. use of(String) instead and use the default db/catalog.

Accepts qualified name which is in the form of table, dbname.tablename or catalog.dbname.tablename and returns a TableName. This method won't try to find the default db/catalog based on the session state.

Parameters:

dbTableName - not null

Returns:

a TableName

Throws:

SemanticException - if dbTableName is null

of

public static TableName of(String dbTableName)
                    throws SemanticException

Accepts qualified name which is in the form of table, dbname.tablename or catalog.dbname.tablename and returns a TableName.

Parameters:

dbTableName - not null

Returns:

a TableName

Throws:

SemanticException - if dbTableName is null