Table (Hive 3.1.3 API)

java.lang.Object
- org.apache.hadoop.hive.ql.metadata.Table

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthorizationPreEventListener.TableWrapper
```
public class Table
extends Object
implements Serializable
```
A Hive Table: is a fundamental unit of data in Hive that shares a common schema/DDL. Please note that the ql code should always go through methods of this class to access the metadata, instead of directly accessing org.apache.hadoop.hive.metastore.api.Table. This helps to isolate the metastore code and the ql code.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Table.ValidationFailureSemanticException` Marker SemanticException, so that processing that allows for table validation failures and appropriately handles them can recover from these types of SemanticExceptions

Constructor Summary

Constructors
Constructor and Description

Table()
Used only for serialization.

Table(String databaseName, String tableName)

Table(Table table)

Constructors
Constructor and Description
`Table()` Used only for serialization.
`Table(String databaseName, String tableName)`
`Table(Table table)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkValidity(org.apache.hadoop.conf.Configuration conf)`
`void`	`clearSerDeInfo()`
`Table`	`copy()`
`LinkedHashMap<String,String>`	`createSpec(Partition tp)` Creates a partition name -> value spec map object
`boolean`	`equals(Object obj)`
`List<FieldSchema>`	`getAllCols()` Returns a list of all the columns of the table (data columns + partition columns in that order.
`List<String>`	`getBucketCols()`
`String`	`getBucketingDimensionId()`
`int`	`getBucketingVersion()`
`String`	`getCatName()`
`List<FieldSchema>`	`getCols()`
`List<FieldSchema>`	`getColsForMetastore()`
`String`	`getCompleteName()`
`static String`	`getCompleteName(String dbName, String tabName)`
`int`	`getCreateTime()`
`CreationMetadata`	`getCreationMetadata()`
`org.apache.hadoop.fs.Path`	`getDataLocation()`
`String`	`getDbName()`
`Deserializer`	`getDeserializer()`
`Deserializer`	`getDeserializer(boolean skipConfError)`
`Class<? extends Deserializer>`	`getDeserializerClass()`
`Deserializer`	`getDeserializerFromMetaStore(boolean skipConfError)`
`static Table`	`getEmptyTable(String databaseName, String tableName)` Initialize an empty table.
`StructField`	`getField(String fld)`
`ArrayList<StructField>`	`getFields()`
`String`	`getFullyQualifiedName()`
`Class<? extends org.apache.hadoop.mapred.InputFormat>`	`getInputFormatClass()`
`int`	`getLastAccessTime()`
`Properties`	`getMetadata()`
`int`	`getNumBuckets()`
`Class<? extends org.apache.hadoop.mapred.OutputFormat>`	`getOutputFormatClass()`
`String`	`getOwner()`
`PrincipalType`	`getOwnerType()`
`Map<String,String>`	`getParameters()`
`FieldSchema`	`getPartColByName(String colName)`
`List<String>`	`getPartColNames()`
`List<FieldSchema>`	`getPartCols()`
`List<FieldSchema>`	`getPartitionKeys()`
`org.apache.hadoop.fs.Path`	`getPath()`
`String`	`getProperty(String name)`
`int`	`getRetention()`
`StorageDescriptor`	`getSd()`
`String`	`getSerdeParam(String param)`
`String`	`getSerializationLib()`
`List<String>`	`getSkewedColNames()`
`Map<List<String>,String>`	`getSkewedColValueLocationMaps()`
`List<List<String>>`	`getSkewedColValues()`
`SkewedInfo`	`getSkewedInfo()`
`List<Order>`	`getSortCols()`
`org.apache.hadoop.fs.FileStatus[]`	`getSortedPaths()`
`HiveStorageHandler`	`getStorageHandler()`
`String`	`getTableName()`
`BaseSemanticAnalyzer.TableSpec`	`getTableSpec()`
`TableType`	`getTableType()`
`Table`	`getTTable()` This function should only be used in serialization.
`String`	`getViewExpandedText()`
`String`	`getViewOriginalText()`
`boolean`	`hasDeserializer()`
`int`	`hashCode()`
`static boolean`	`hasMetastoreBasedSchema(HiveConf conf, String serdeLib)`
`protected void`	`initialize(Table table)`
`boolean`	`isDummyTable()`
`boolean`	`isEmpty()`
`boolean`	`isImmutable()`
`boolean`	`isMaterializedTable()`
`boolean`	`isMaterializedView()`
`boolean`	`isNonNative()`
`boolean`	`isPartitioned()`
`boolean`	`isPartitionKey(String colName)`
`boolean`	`isRewriteEnabled()`
`boolean`	`isStoredAsSubDirectories()`
`boolean`	`isTemporary()`
`boolean`	`isView()`
`void`	`setBucketCols(List<String> bucketCols)`
`void`	`setCreateTime(int createTime)`
`void`	`setCreationMetadata(CreationMetadata creationMetadata)`
`void`	`setDataLocation(org.apache.hadoop.fs.Path path)`
`void`	`setDbName(String databaseName)`
`void`	`setFields(List<FieldSchema> fields)`
`void`	`setInputFormatClass(Class<? extends org.apache.hadoop.mapred.InputFormat> inputFormatClass)`
`void`	`setInputFormatClass(String name)`
`void`	`setLastAccessTime(int lastAccessTime)`
`void`	`setMaterializedTable(boolean materializedTable)`
`void`	`setNumBuckets(int nb)`
`void`	`setOutputFormatClass(Class<? extends org.apache.hadoop.mapred.OutputFormat> outputFormatClass)`
`void`	`setOutputFormatClass(String name)`
`void`	`setOwner(String owner)`
`void`	`setOwnerType(PrincipalType ownerType)`
`void`	`setParameters(Map<String,String> params)`
`void`	`setPartCols(List<FieldSchema> partCols)`
`void`	`setProperty(String name, String value)`
`void`	`setRetention(int retention)`
`void`	`setRewriteEnabled(boolean rewriteEnabled)`
`String`	`setSerdeParam(String param, String value)`
`void`	`setSerializationLib(String lib)`
`void`	`setSkewedColNames(List<String> skewedColNames)`
`void`	`setSkewedColValues(List<List<String>> skewedValues)`
`void`	`setSkewedInfo(SkewedInfo skewedInfo)`
`void`	`setSkewedValueLocationMap(List<String> valList, String dirName)`
`void`	`setSortCols(List<Order> sortOrder)`
`void`	`setStoredAsSubDirectories(boolean storedAsSubDirectories)`
`void`	`setTableName(String tableName)`
`void`	`setTableSpec(BaseSemanticAnalyzer.TableSpec tableSpec)`
`void`	`setTableType(TableType tableType)`
`void`	`setTTable(Table tTable)` This function should only be called by Java serialization.
`void`	`setViewExpandedText(String viewExpandedText)`
`void`	`setViewOriginalText(String viewOriginalText)`
`static boolean`	`shouldStoreFieldsInMetastore(HiveConf conf, String serdeLib, Map<String,String> tableParams)`
`String`	`toString()`
`void`	`unsetDataLocation()`
`static void`	`validateColumns(List<FieldSchema> columns, List<FieldSchema> partCols)`
`void`	`validatePartColumnNames(Map<String,String> spec, boolean shouldBeFull)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Table
```
public Table()
```
Used only for serialization.

Table
```
public Table(Table table)
```

Table

public Table(String databaseName,
             String tableName)

Method Detail

initialize

protected void initialize(Table table)

isDummyTable
```
public boolean isDummyTable()
```

getTTable
```
public Table getTTable()
```
This function should only be used in serialization. We should never call this function to modify the fields, because the cached fields will become outdated.

setTTable
```
public void setTTable(Table tTable)
```
This function should only be called by Java serialization.

getEmptyTable

public static Table getEmptyTable(String databaseName,
                                  String tableName)

Initialize an empty table.

checkValidity

public void checkValidity(org.apache.hadoop.conf.Configuration conf)
                   throws HiveException

Throws:: HiveException

getSd
```
public StorageDescriptor getSd()
```

setInputFormatClass

public void setInputFormatClass(Class<? extends org.apache.hadoop.mapred.InputFormat> inputFormatClass)

setOutputFormatClass

public void setOutputFormatClass(Class<? extends org.apache.hadoop.mapred.OutputFormat> outputFormatClass)

getMetadata
```
public final Properties getMetadata()
```

getPath

public final org.apache.hadoop.fs.Path getPath()

getTableName
```
public final String getTableName()
```

getDataLocation

public final org.apache.hadoop.fs.Path getDataLocation()

getDeserializer

public final Deserializer getDeserializer()

getDeserializerClass

public final Class<? extends Deserializer> getDeserializerClass()
                                                         throws Exception

Throws:: Exception

getDeserializer

public final Deserializer getDeserializer(boolean skipConfError)

getDeserializerFromMetaStore

public final Deserializer getDeserializerFromMetaStore(boolean skipConfError)

getStorageHandler

public HiveStorageHandler getStorageHandler()

getInputFormatClass

public final Class<? extends org.apache.hadoop.mapred.InputFormat> getInputFormatClass()

getOutputFormatClass

public final Class<? extends org.apache.hadoop.mapred.OutputFormat> getOutputFormatClass()

isMaterializedTable
```
public boolean isMaterializedTable()
```

setMaterializedTable

public void setMaterializedTable(boolean materializedTable)

validatePartColumnNames

public final void validatePartColumnNames(Map<String,String> spec,
                                          boolean shouldBeFull)
                                   throws SemanticException

Throws:: SemanticException

setProperty

public void setProperty(String name,
                        String value)

setParameters

public void setParameters(Map<String,String> params)

getProperty

public String getProperty(String name)

isImmutable
```
public boolean isImmutable()
```

setTableType

public void setTableType(TableType tableType)

getTableType
```
public TableType getTableType()
```

getFields

public ArrayList<StructField> getFields()

getField

public StructField getField(String fld)

getBucketingVersion
```
public int getBucketingVersion()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

getPartCols

public List<FieldSchema> getPartCols()

getPartColByName

public FieldSchema getPartColByName(String colName)

getPartColNames
```
public List<String> getPartColNames()
```

isPartitionKey

public boolean isPartitionKey(String colName)

getBucketingDimensionId

public String getBucketingDimensionId()

setDataLocation

public void setDataLocation(org.apache.hadoop.fs.Path path)

unsetDataLocation
```
public void unsetDataLocation()
```

setBucketCols

public void setBucketCols(List<String> bucketCols)
                   throws HiveException

Throws:: HiveException

setSortCols

public void setSortCols(List<Order> sortOrder)
                 throws HiveException

Throws:: HiveException

setSkewedValueLocationMap

public void setSkewedValueLocationMap(List<String> valList,
                                      String dirName)
                               throws HiveException

Throws:: HiveException

getSkewedColValueLocationMaps

public Map<List<String>,String> getSkewedColValueLocationMaps()

setSkewedColValues

public void setSkewedColValues(List<List<String>> skewedValues)
                        throws HiveException

Throws:: HiveException

getSkewedColValues

public List<List<String>> getSkewedColValues()

setSkewedColNames

public void setSkewedColNames(List<String> skewedColNames)
                       throws HiveException

Throws:: HiveException

getSkewedColNames

public List<String> getSkewedColNames()

getSkewedInfo
```
public SkewedInfo getSkewedInfo()
```

setSkewedInfo

public void setSkewedInfo(SkewedInfo skewedInfo)
                   throws HiveException

Throws:: HiveException

isStoredAsSubDirectories

public boolean isStoredAsSubDirectories()

setStoredAsSubDirectories

public void setStoredAsSubDirectories(boolean storedAsSubDirectories)
                               throws HiveException

Throws:: HiveException

getCols
```
public List<FieldSchema> getCols()
```

getColsForMetastore

public List<FieldSchema> getColsForMetastore()

getAllCols
```
public List<FieldSchema> getAllCols()
```
Returns a list of all the columns of the table (data columns + partition columns in that order.

Returns:

List

setPartCols

public void setPartCols(List<FieldSchema> partCols)

getCatName
```
public String getCatName()
```

getDbName
```
public String getDbName()
```

getNumBuckets
```
public int getNumBuckets()
```

setInputFormatClass

public void setInputFormatClass(String name)
                         throws HiveException

Throws:: HiveException

setOutputFormatClass

public void setOutputFormatClass(String name)
                          throws HiveException

Throws:: HiveException

isPartitioned
```
public boolean isPartitioned()
```

setFields

public void setFields(List<FieldSchema> fields)

setNumBuckets
```
public void setNumBuckets(int nb)
```

getOwner
```
public String getOwner()
```
Returns:

The owner of the table.

See Also:

Table.getOwner()

getOwnerType
```
public PrincipalType getOwnerType()
```
Returns:

The owner type of the table.

See Also:

Table.getOwnerType()

getParameters
```
public Map<String,String> getParameters()
```
Returns:

The table parameters.

See Also:

Table.getParameters()

getRetention
```
public int getRetention()
```
Returns:

The retention on the table.

See Also:

Table.getRetention()

setOwner
```
public void setOwner(String owner)
```
Parameters:

owner -

See Also:

Table.setOwner(java.lang.String)

setOwnerType
```
public void setOwnerType(PrincipalType ownerType)
```
Parameters:

ownerType -

See Also:

Table.setOwnerType(org.apache.hadoop.hive.metastore.api.PrincipalType)

setRetention
```
public void setRetention(int retention)
```
Parameters:

retention -

See Also:

Table.setRetention(int)

setSerializationLib

public void setSerializationLib(String lib)

getSerializationLib
```
public String getSerializationLib()
```

getSerdeParam

public String getSerdeParam(String param)

setSerdeParam

public String setSerdeParam(String param,
                            String value)

getBucketCols
```
public List<String> getBucketCols()
```

getSortCols
```
public List<Order> getSortCols()
```

setTableName

public void setTableName(String tableName)

setDbName

public void setDbName(String databaseName)

getPartitionKeys

public List<FieldSchema> getPartitionKeys()

getViewOriginalText
```
public String getViewOriginalText()
```
Returns:

the original view text, or null if this table is not a view

setViewOriginalText
```
public void setViewOriginalText(String viewOriginalText)
```
Parameters:

viewOriginalText - the original view text to set

getViewExpandedText
```
public String getViewExpandedText()
```
Returns:

the expanded view text, or null if this table is not a view

setViewExpandedText
```
public void setViewExpandedText(String viewExpandedText)
```
Parameters:

viewExpandedText - the expanded view text to set

isRewriteEnabled
```
public boolean isRewriteEnabled()
```
Returns:

whether this view can be used for rewriting queries

setRewriteEnabled
```
public void setRewriteEnabled(boolean rewriteEnabled)
```
Parameters:

rewriteEnabled - whether this view can be used for rewriting queries

getCreationMetadata
```
public CreationMetadata getCreationMetadata()
```
Returns:

the creation metadata (only for materialized views)

setCreationMetadata
```
public void setCreationMetadata(CreationMetadata creationMetadata)
```
Parameters:

creationMetadata - the creation metadata (only for materialized views)

clearSerDeInfo
```
public void clearSerDeInfo()
```

isView
```
public boolean isView()
```
Returns:

whether this table is actually a view

isMaterializedView
```
public boolean isMaterializedView()
```

createSpec
```
public LinkedHashMap<String,String> createSpec(Partition tp)
```
Creates a partition name -> value spec map object

Parameters:

tp - Use the information from this partition.

Returns:

Partition name to value mapping.

copy

public Table copy()
           throws HiveException

Throws:: HiveException

getCreateTime
```
public int getCreateTime()
```

setCreateTime

public void setCreateTime(int createTime)

getLastAccessTime
```
public int getLastAccessTime()
```

setLastAccessTime

public void setLastAccessTime(int lastAccessTime)

isNonNative
```
public boolean isNonNative()
```

getFullyQualifiedName
```
public String getFullyQualifiedName()
```

getCompleteName
```
public String getCompleteName()
```
Returns:

include the db name

getCompleteName

public static String getCompleteName(String dbName,
                                     String tabName)

getSortedPaths

public org.apache.hadoop.fs.FileStatus[] getSortedPaths()

isEmpty

public boolean isEmpty()
                throws HiveException

Throws:: HiveException

isTemporary
```
public boolean isTemporary()
```

hasMetastoreBasedSchema

public static boolean hasMetastoreBasedSchema(HiveConf conf,
                                              String serdeLib)

shouldStoreFieldsInMetastore

public static boolean shouldStoreFieldsInMetastore(HiveConf conf,
                                                   String serdeLib,
                                                   Map<String,String> tableParams)

validateColumns

public static void validateColumns(List<FieldSchema> columns,
                                   List<FieldSchema> partCols)
                            throws HiveException

Throws:: HiveException

getTableSpec

public BaseSemanticAnalyzer.TableSpec getTableSpec()

setTableSpec

public void setTableSpec(BaseSemanticAnalyzer.TableSpec tableSpec)

hasDeserializer
```
public boolean hasDeserializer()
```

Class Table

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Table

Table

Table

Method Detail

initialize

isDummyTable

getTTable

setTTable

getEmptyTable

checkValidity

getSd

setInputFormatClass

setOutputFormatClass

getMetadata

getPath

getTableName

getDataLocation

getDeserializer

getDeserializerClass

getDeserializer

getDeserializerFromMetaStore

getStorageHandler

getInputFormatClass

getOutputFormatClass

isMaterializedTable

setMaterializedTable

validatePartColumnNames

setProperty

setParameters

getProperty

isImmutable

setTableType

getTableType

getFields

getField

getBucketingVersion

toString

hashCode

equals

getPartCols

getPartColByName

getPartColNames

isPartitionKey

getBucketingDimensionId

setDataLocation

unsetDataLocation

setBucketCols

setSortCols

setSkewedValueLocationMap

getSkewedColValueLocationMaps

setSkewedColValues

getSkewedColValues

setSkewedColNames

getSkewedColNames

getSkewedInfo

setSkewedInfo

isStoredAsSubDirectories

setStoredAsSubDirectories

getCols

getColsForMetastore

getAllCols

setPartCols

getCatName

getDbName

getNumBuckets

setInputFormatClass

setOutputFormatClass

isPartitioned

setFields

setNumBuckets

getOwner

getOwnerType

getParameters

getRetention