org.apache.hadoop.hive.common

Class TableName

java.lang.Object

org.apache.hadoop.hive.common.TableName

All Implemented Interfaces:

Serializable

public class TableName
extends Object
implements Serializable

A container for a fully qualified table name, i.e. catalogname.databasename.tablename. Also includes utilities for string parsing.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TableName(String catName, String dbName, String tableName)
TableName(String catName, String dbName, String tableName, String metaTable)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static TableName	fromString(String name, String defaultCatalog, String defaultDatabase)
static TableName	fromString(String name, String defaultCatalog, String defaultDatabase, String metaTable) Build a TableName from a string of the form [[catalog.]database.]table.
String	getCat()
String	getDb()
String	getDbTable() Deprecated. use getNotEmptyDbTable() instead.
static String	getDbTable(String dbName, String tableName) Get the name in db.table format, for use with stuff not yet converted to use the catalog.
String	getEscapedNotEmptyDbTable() Get the name in `db`.`table` escaped format, if db is not empty, otherwise pass only the table name.
String	getMetaTable()
String	getNotEmptyDbTable() Get the name in db.table format, if db is not empty, otherwise pass only the table name.
static String	getQualified(String catName, String dbName, String tableName)
String	getTable()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TableName

public TableName(String catName,
                 String dbName,
                 String tableName,
                 String metaTable)

Parameters:

catName - catalog name. Cannot be null. If you do not know it you can get it from SessionState.getCurrentCatalog() if you want to use the catalog from the current session, or from MetaStoreUtils.getDefaultCatalog() if you do not have a session or want to use the default catalog for the Hive instance.

dbName - database name. Cannot be null. If you do not now it you can get it from SessionState.getCurrentDatabase() or use Warehouse.DEFAULT_DATABASE_NAME.

tableName - table name, cannot be null

metaTable - name Use this to query Iceberg metadata tables.

TableName

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

Method Detail

fromString

public static TableName fromString(String name,
                                   String defaultCatalog,
                                   String defaultDatabase)

fromString

public static TableName fromString(String name,
                                   String defaultCatalog,
                                   String defaultDatabase,
                                   String metaTable)
                            throws IllegalArgumentException

Build a TableName from a string of the form [[catalog.]database.]table.

Parameters:

name - name in string form, not null

defaultCatalog - default catalog to use if catalog is not in the name. If you do not know it you can get it from SessionState.getCurrentCatalog() if you want to use the catalog from the current session, or from MetaStoreUtils.getDefaultCatalog() if you do not have a session or want to use the default catalog for the Hive instance.

defaultDatabase - default database to use if database is not in the name. If you do not now it you can get it from SessionState.getCurrentDatabase() or use Warehouse.DEFAULT_DATABASE_NAME.

metaTable - When querying Iceberg metadata tables, set this parameter.

Returns:

TableName

Throws:

IllegalArgumentException - if a non-null name is given

getCat

public String getCat()

getDb

public String getDb()

getTable

public String getTable()

getMetaTable

public String getMetaTable()

getDbTable

public String getDbTable()

Deprecated. use getNotEmptyDbTable() instead.

Get the name in db.table format, for use with stuff not yet converted to use the catalog. Fair warning, that if the db is null, this will return null.tableName

getEscapedNotEmptyDbTable

public String getEscapedNotEmptyDbTable()

Get the name in `db`.`table` escaped format, if db is not empty, otherwise pass only the table name.

getNotEmptyDbTable

public String getNotEmptyDbTable()

Get the name in db.table format, if db is not empty, otherwise pass only the table name.

getDbTable

public static String getDbTable(String dbName,
                                String tableName)

Get the name in db.table format, for use with stuff not yet converted to use the catalog.

getQualified

public static String getQualified(String catName,
                                  String dbName,
                                  String tableName)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object