HCatTable (Hive 1.2.2 API)

java.lang.Object
- org.apache.hive.hcatalog.api.HCatTable

```
public class HCatTable
extends Object
```
The HCatTable is a wrapper around org.apache.hadoop.hive.metastore.api.Table.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HCatTable.TableAttribute
Attributes that can be compared between HCatTables.

static class HCatTable.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`HCatTable.TableAttribute` Attributes that can be compared between HCatTables.
`static class`	`HCatTable.Type`

Field Summary

Fields
Modifier and Type	Field and Description
`static EnumSet<HCatTable.TableAttribute>`	`DEFAULT_COMPARISON_ATTRIBUTES` The default set of attributes that can be diffed between HCatTables.
`static String`	`DEFAULT_INPUT_FORMAT_CLASS`
`static String`	`DEFAULT_OUTPUT_FORMAT_CLASS`
`static String`	`DEFAULT_SERDE_CLASS`
`static EnumSet<HCatTable.TableAttribute>`	`NO_DIFF` 2 HCatTables are considered equivalent if `lhs.diff(rhs).equals(NO_DIFF) == true;`

Constructor Summary

Constructors
Constructor and Description

HCatTable(String dbName, String tableName)

Constructors
Constructor and Description
`HCatTable(String dbName, String tableName)`

Method Summary

Methods
Modifier and Type	Method and Description
`HCatTable`	`bucketCols(List<String> bucketCols)` Setter for list of bucket columns.
`HCatTable`	`collectionItemsTerminatedBy(char delimiter)` See row_format element of CREATE_TABLE DDL for Hive.
`HCatTable`	`cols(List<HCatFieldSchema> cols)` Setter for Column schemas.
`String`	`comment()`
`HCatTable`	`comment(String comment)` Setter for table-level comment.
`HCatTable`	`dbName(String dbName)` Setter for db-name.
`EnumSet<HCatTable.TableAttribute>`	`diff(HCatTable rhs)` Method to compare the attributes of 2 HCatTable instances.
`EnumSet<HCatTable.TableAttribute>`	`diff(HCatTable rhs, EnumSet<HCatTable.TableAttribute> attributesToCheck)` Method to compare the attributes of 2 HCatTable instances.
`HCatTable`	`escapeChar(char escapeChar)` See row_format element of CREATE_TABLE DDL for Hive.
`HCatTable`	`fieldsTerminatedBy(char delimiter)` See row_format element of CREATE_TABLE DDL for Hive.
`String`	`fileFormat()`
`HCatTable`	`fileFormat(String fileFormat)`
`List<String>`	`getBucketCols()` Gets the bucket columns.
`List<HCatFieldSchema>`	`getCols()` Gets the columns.
`String`	`getDbName()` Gets the db name.
`String`	`getInputFileFormat()` Gets the input file format.
`String`	`getLocation()` Gets the location.
`int`	`getNumBuckets()` Gets the number of buckets.
`String`	`getOutputFileFormat()` Gets the output file format.
`List<HCatFieldSchema>`	`getPartCols()` Gets the part columns.
`String`	`getSerdeLib()` Gets the serde lib.
`Map<String,String>`	`getSerdeParams()` Returns parameters such as field delimiter,etc.
`List<Order>`	`getSortCols()` Gets the sort columns.
`String`	`getStorageHandler()` Gets the storage handler.
`String`	`getTableName()` Gets the table name.
`String`	`getTabletype()` Gets the tableType.
`Map<String,String>`	`getTblProps()` Gets the table props.
`HCatTable`	`inputFileFormat(String inputFileFormat)` Setter for InputFormat class.
`HCatTable`	`linesTerminatedBy(char delimiter)` See row_format element of CREATE_TABLE DDL for Hive.
`HCatTable`	`location(String location)` Setter for location.
`HCatTable`	`mapKeysTerminatedBy(char delimiter)` See row_format element of CREATE_TABLE DDL for Hive.
`HCatTable`	`nullDefinedAs(char nullChar)` See row_format element of CREATE_TABLE DDL for Hive.
`HCatTable`	`numBuckets(int numBuckets)` Setter for number of buckets.
`HCatTable`	`outputFileFormat(String outputFileFormat)` Setter for OutputFormat class.
`String`	`owner()` Getter for table-owner.
`HCatTable`	`owner(String owner)` Setter for table-owner.
`HCatTable`	`partCol(HCatFieldSchema partCol)` Setter for individual partition columns.
`HCatTable`	`partCols(List<HCatFieldSchema> partCols)` Setter for list of partition columns.
`HCatTable`	`resolve(HCatTable rhs, EnumSet<HCatTable.TableAttribute> attributes)` Method to "adopt" the specified attributes from rhs into this HCatTable object.
`HCatTable`	`serdeLib(String serde)` Setter for SerDe class name.
`HCatTable`	`serdeParam(String paramName, String value)`
`HCatTable`	`serdeParams(Map<String,String> serdeParams)`
`HCatTable`	`sortCols(List<Order> sortCols)` Setter for Sort-cols.
`HCatTable`	`storageHandler(String storageHandler)` Setter for StorageHandler class.
`HCatTable`	`tableName(String tableName)` Setter for TableName.
`HCatTable`	`tableType(HCatTable.Type tableType)` Setter for table-type.
`HCatTable`	`tblProps(Map<String,String> tblProps)` Setter for TableProperty map.
`String`	`toString()`

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

- Field Detail
  - DEFAULT_COMPARISON_ATTRIBUTES
```
public static final EnumSet<HCatTable.TableAttribute> DEFAULT_COMPARISON_ATTRIBUTES
```
    The default set of attributes that can be diffed between HCatTables.
  - NO_DIFF
```
public static final EnumSet<HCatTable.TableAttribute> NO_DIFF
```
    2 HCatTables are considered equivalent if lhs.diff(rhs).equals(NO_DIFF) == true;
  - DEFAULT_SERDE_CLASS
```
public static final String DEFAULT_SERDE_CLASS
```
  - DEFAULT_INPUT_FORMAT_CLASS
```
public static final String DEFAULT_INPUT_FORMAT_CLASS
```
  - DEFAULT_OUTPUT_FORMAT_CLASS
```
public static final String DEFAULT_OUTPUT_FORMAT_CLASS
```
- Constructor Detail
  - HCatTable
```
public HCatTable(String dbName,
         String tableName)
```
- Method Detail
  - getTableName
```
public String getTableName()
```
    Gets the table name.
    
    Returns:
    the table name
  - tableName
```
public HCatTable tableName(String tableName)
```
    Setter for TableName.
  - getDbName
```
public String getDbName()
```
    Gets the db name.
    
    Returns:
    the db name
  - dbName
```
public HCatTable dbName(String dbName)
```
    Setter for db-name.
  - getCols
```
public List<HCatFieldSchema> getCols()
```
    Gets the columns.
    
    Returns:
    the columns
  - cols
```
public HCatTable cols(List<HCatFieldSchema> cols)
```
    Setter for Column schemas.
  - getPartCols
```
public List<HCatFieldSchema> getPartCols()
```
    Gets the part columns.
    
    Returns:
    the part columns
  - partCols
```
public HCatTable partCols(List<HCatFieldSchema> partCols)
```
    Setter for list of partition columns.
  - partCol
```
public HCatTable partCol(HCatFieldSchema partCol)
```
    Setter for individual partition columns.
  - getBucketCols
```
public List<String> getBucketCols()
```
    Gets the bucket columns.
    
    Returns:
    the bucket columns
  - bucketCols
```
public HCatTable bucketCols(List<String> bucketCols)
```
    Setter for list of bucket columns.
  - getSortCols
```
public List<Order> getSortCols()
```
    Gets the sort columns.
    
    Returns:
    the sort columns
  - sortCols
```
public HCatTable sortCols(List<Order> sortCols)
```
    Setter for Sort-cols.
  - getNumBuckets
```
public int getNumBuckets()
```
    Gets the number of buckets.
    
    Returns:
    the number of buckets
  - numBuckets
```
public HCatTable numBuckets(int numBuckets)
```
    Setter for number of buckets.
  - getStorageHandler
```
public String getStorageHandler()
```
    Gets the storage handler.
    
    Returns:
    the storage handler
  - storageHandler
```
public HCatTable storageHandler(String storageHandler)
                         throws HCatException
```
    Setter for StorageHandler class.
    
    Throws:
    
    HCatException
  - getTblProps
```
public Map<String,String> getTblProps()
```
    Gets the table props.
    
    Returns:
    the table props
  - tblProps
```
public HCatTable tblProps(Map<String,String> tblProps)
```
    Setter for TableProperty map.
  - getTabletype
```
public String getTabletype()
```
    Gets the tableType.
    
    Returns:
    the tableType
  - tableType
```
public HCatTable tableType(HCatTable.Type tableType)
```
    Setter for table-type.
  - fileFormat
```
public HCatTable fileFormat(String fileFormat)
```
  - fileFormat
```
public String fileFormat()
```
  - getInputFileFormat
```
public String getInputFileFormat()
```
    Gets the input file format.
    
    Returns:
    the input file format
  - inputFileFormat
```
public HCatTable inputFileFormat(String inputFileFormat)
```
    Setter for InputFormat class.
  - getOutputFileFormat
```
public String getOutputFileFormat()
```
    Gets the output file format.
    
    Returns:
    the output file format
  - outputFileFormat
```
public HCatTable outputFileFormat(String outputFileFormat)
```
    Setter for OutputFormat class.
  - getSerdeLib
```
public String getSerdeLib()
```
    Gets the serde lib.
    
    Returns:
    the serde lib
  - serdeLib
```
public HCatTable serdeLib(String serde)
```
    Setter for SerDe class name.
  - serdeParams
```
public HCatTable serdeParams(Map<String,String> serdeParams)
```
  - serdeParam
```
public HCatTable serdeParam(String paramName,
                   String value)
```
  - getSerdeParams
```
public Map<String,String> getSerdeParams()
```
    Returns parameters such as field delimiter,etc.
  - getLocation
```
public String getLocation()
```
    Gets the location.
    
    Returns:
    the location
  - location
```
public HCatTable location(String location)
```
    Setter for location.
  - owner
```
public String owner()
```
    Getter for table-owner.
  - owner
```
public HCatTable owner(String owner)
```
    Setter for table-owner.
  - comment
```
public String comment()
```
  - comment
```
public HCatTable comment(String comment)
```
    Setter for table-level comment.
  - fieldsTerminatedBy
```
public HCatTable fieldsTerminatedBy(char delimiter)
```
    See row_format element of CREATE_TABLE DDL for Hive.
  - escapeChar
```
public HCatTable escapeChar(char escapeChar)
```
    See row_format element of CREATE_TABLE DDL for Hive.
  - collectionItemsTerminatedBy
```
public HCatTable collectionItemsTerminatedBy(char delimiter)
```
    See row_format element of CREATE_TABLE DDL for Hive.
  - mapKeysTerminatedBy
```
public HCatTable mapKeysTerminatedBy(char delimiter)
```
    See row_format element of CREATE_TABLE DDL for Hive.
  - linesTerminatedBy
```
public HCatTable linesTerminatedBy(char delimiter)
```
    See row_format element of CREATE_TABLE DDL for Hive.
  - nullDefinedAs
```
public HCatTable nullDefinedAs(char nullChar)
```
    See row_format element of CREATE_TABLE DDL for Hive.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - diff
```
public EnumSet<HCatTable.TableAttribute> diff(HCatTable rhs,
                                     EnumSet<HCatTable.TableAttribute> attributesToCheck)
```
    Method to compare the attributes of 2 HCatTable instances.
    
    Parameters:
    rhs - The other table being compared against. Can't be null.
    attributesToCheck - The list of TableAttributes being compared.
    
    Returns:
    EnumSet<TableAttribute> containing all the attribute that differ between this and rhs. Subset of attributesToCheck.
  - diff
```
public EnumSet<HCatTable.TableAttribute> diff(HCatTable rhs)
```
    Method to compare the attributes of 2 HCatTable instances. Only the DEFAULT_COMPARISON_ATTRIBUTES are compared.
    
    Parameters:
    rhs - The other table being compared against. Can't be null.
    
    Returns:
    EnumSet<TableAttribute> containing all the attribute that differ between this and rhs. Subset of DEFAULT_COMPARISON_ATTRIBUTES.
  - resolve
```
public HCatTable resolve(HCatTable rhs,
                EnumSet<HCatTable.TableAttribute> attributes)
                  throws HCatException
```
    Method to "adopt" the specified attributes from rhs into this HCatTable object.
    
    Parameters:
    rhs - The "source" table from which attributes are to be copied from.
    attributes - The set of attributes to be copied from rhs. Usually the result of this.diff(rhs).
    
    Returns:
    This HCatTable
    
    Throws:
    
    HCatException

Class HCatTable

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_COMPARISON_ATTRIBUTES

NO_DIFF

DEFAULT_SERDE_CLASS

DEFAULT_INPUT_FORMAT_CLASS

DEFAULT_OUTPUT_FORMAT_CLASS

Constructor Detail

HCatTable

Method Detail

getTableName

tableName

getDbName

dbName

getCols

cols

getPartCols

partCols

partCol

getBucketCols

bucketCols

getSortCols

sortCols

getNumBuckets

numBuckets

getStorageHandler

storageHandler

getTblProps

tblProps

getTabletype

tableType

fileFormat

fileFormat

getInputFileFormat

inputFileFormat

getOutputFileFormat

outputFileFormat

getSerdeLib

serdeLib

serdeParams

serdeParam

getSerdeParams

getLocation

location

owner

owner

comment

comment

fieldsTerminatedBy

escapeChar

collectionItemsTerminatedBy

mapKeysTerminatedBy

linesTerminatedBy

nullDefinedAs

toString

diff

diff

resolve