oracle.javatools.db.hive

Class HiveStorageProperties

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractChildDBObject

oracle.javatools.db.hive.HiveStorageProperties

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable

public class HiveStorageProperties
extends AbstractChildDBObject

Collection of properties for a Table definition that are specific to the Hive Metastore.

Since:

12.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HiveStorageProperties.PredefinedFileFormat Enum of the predefined file formats that are available for the STORED AS clause.

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE Type String for this object.

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
HiveStorageProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCollectionItemDelim() Gets the delimiter (terminator) String for collection items in the underlying data.
java.lang.String	getFieldDelim() Gets the delimiter (terminator) String for fields in the underlying data.
java.lang.String	getFieldEscape() Gets the escape String for the field terminator.
java.lang.String	getHdfsLocation() Gets the location for the hive table.
java.lang.String	getInputFormatClass() Gets the input format class for the storage format.
java.lang.String	getLineDelim() Gets the delimiter (terminator) String for lines in the underlying data.
java.lang.String	getMapKeyDelim() Gets the delimiter (terminator) String for map keys in the underlying data.
java.lang.String	getNullFormat() Gets the format String for the representation of null in the underlying data.
java.lang.String	getOutputFormatClass() Gets the output format class for the storage format.
HiveStorageProperties.PredefinedFileFormat	getPredefinedFileFormat() Gets the predefined file format to use which will default the input and output format class names when the table is created.
java.lang.Object	getProperty(java.lang.String key) Retrieves the value associated with a property.
java.lang.String	getSerDeClass() Gets the class name for the SerDe that will deal with this table's storage.
TblProperty[]	getSerDeProperties() Gets the list of key/value pairs that represent the SERDEPROPERTIES for the table.
java.lang.String	getSerDePropertyValue(java.lang.String name) Utility method to get the value for a SerDe property with the given name.
java.lang.String	getStorageHandlerClass() Gets the storage handler class.
java.lang.String	getType() Returns the type of this object.
void	setCollectionItemDelim(java.lang.String delim) Sets the delimiter (terminator) String for collection items in the underlying data.
void	setFieldDelim(java.lang.String delim) Sets the delimiter (terminator) String for fields in the underlying data.
void	setFieldEscape(java.lang.String fieldEscape) Gets the escape String for the field terminator.
void	setHdfsLocation(java.lang.String location) Sets the location for the hive table.
void	setInputFormatClass(java.lang.String inputFormat) Sets the input format class for the storage format.
void	setLineDelim(java.lang.String delim) Sets the delimiter (terminator) String for lines in the underlying data.
void	setMapKeyDelim(java.lang.String delim) Sets the delimiter (terminator) String for map keys in the underlying data.
void	setNullFormat(java.lang.String nullFormat) Gets the format String for the representation of null in the underlying data.
void	setOutputFormatClass(java.lang.String outputFormat) Gets the output format class for the storage format.
void	setPredefinedFileFormat(HiveStorageProperties.PredefinedFileFormat fileFormat) Sets the predefined file format to use which will default the input and output format class names when the table is created.
void	setProperty(java.lang.String key, java.lang.Object value) Sets the value for a property.
void	setSerDeClass(java.lang.String serDeClass) Sets the class name for the SerDe that will deal with this table's storage.
void	setSerDeProperties(TblProperty... serDeProps) Sets the list of SERDEPROPERTIES for the table.
void	setSerDeProperty(java.lang.String name, java.lang.String value) Utility method for setting a serde property with the given name/value.
void	setStorageHandlerClass(java.lang.String storedBy) Sets the storage handler class.

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

setParent

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, copyToImpl, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getParent, getProperties, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName, setProperties

Field Detail

TYPE

public static final java.lang.String TYPE

Type String for this object. This is a pseudo-type (i.e. it doesn't correspond to anything in the database). It is also the property key for this object on a Table.

See Also:

Constant Field Values

Constructor Detail

HiveStorageProperties

public HiveStorageProperties()

Method Detail

getType

public java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:

a string describing the type of object.

getHdfsLocation

public java.lang.String getHdfsLocation()

Gets the location for the hive table.

Returns:

the location (e.g. hdfs url).

setHdfsLocation

public void setHdfsLocation(java.lang.String location)

Sets the location for the hive table.

Parameters:

location - the hive location (e.g. hdfs url)

getSerDeProperties

public TblProperty[] getSerDeProperties()

Gets the list of key/value pairs that represent the SERDEPROPERTIES for the table. The SERDEPROPERTIES clause stores metadata that drives the SerDe.

Returns:

the serde properties

setSerDeProperties

public void setSerDeProperties(TblProperty... serDeProps)

Sets the list of SERDEPROPERTIES for the table. These apply to either the SerDe class or the Storage Handler class (whichever is set).

Parameters:

serDeProps - the serde properties

getSerDePropertyValue

public java.lang.String getSerDePropertyValue(java.lang.String name)

Utility method to get the value for a SerDe property with the given name.

Parameters:

name - the serde property name to look up

setSerDeProperty

public void setSerDeProperty(java.lang.String name,
                             java.lang.String value)

Utility method for setting a serde property with the given name/value. If a property exists with the given property name its value will be changed, rather than adding a duplicate property.

Parameters:

name - the serde property name

value - the serde property value If null this will remove the given serde property name.

getSerDeClass

public java.lang.String getSerDeClass()

Gets the class name for the SerDe that will deal with this table's storage.

Returns:

the serde class name

setSerDeClass

public void setSerDeClass(java.lang.String serDeClass)

Sets the class name for the SerDe that will deal with this table's storage.

Parameters:

serDeClass - the serde class name

getLineDelim

public java.lang.String getLineDelim()

Gets the delimiter (terminator) String for lines in the underlying data.

Returns:

the line delimiter

setLineDelim

public void setLineDelim(java.lang.String delim)

Sets the delimiter (terminator) String for lines in the underlying data.

Parameters:

delim - the line delimiter

getMapKeyDelim

public java.lang.String getMapKeyDelim()

Gets the delimiter (terminator) String for map keys in the underlying data.

Returns:

the map key delimiter

setMapKeyDelim

public void setMapKeyDelim(java.lang.String delim)

Sets the delimiter (terminator) String for map keys in the underlying data.

Parameters:

delim - the map key delimiter

getCollectionItemDelim

public java.lang.String getCollectionItemDelim()

Gets the delimiter (terminator) String for collection items in the underlying data.

Returns:

the collection item delimiter

setCollectionItemDelim

public void setCollectionItemDelim(java.lang.String delim)

Sets the delimiter (terminator) String for collection items in the underlying data.

Parameters:

delim - the collection item delimiter

getFieldDelim

public java.lang.String getFieldDelim()

Gets the delimiter (terminator) String for fields in the underlying data.

Returns:

the field delimiter

setFieldDelim

public void setFieldDelim(java.lang.String delim)

Sets the delimiter (terminator) String for fields in the underlying data.

Parameters:

delim - the field delimiter

getFieldEscape

public java.lang.String getFieldEscape()

Gets the escape String for the field terminator.

Returns:

the field escape

setFieldEscape

public void setFieldEscape(java.lang.String fieldEscape)

Gets the escape String for the field terminator.

Parameters:

fieldEscape - the field escape

getNullFormat

public java.lang.String getNullFormat()

Gets the format String for the representation of null in the underlying data.

Returns:

the null format String

setNullFormat

public void setNullFormat(java.lang.String nullFormat)

Gets the format String for the representation of null in the underlying data.

getPredefinedFileFormat

public HiveStorageProperties.PredefinedFileFormat getPredefinedFileFormat()

Gets the predefined file format to use which will default the input and output format class names when the table is created.

Returns:

the predefined file format

setPredefinedFileFormat

public void setPredefinedFileFormat(HiveStorageProperties.PredefinedFileFormat fileFormat)

Sets the predefined file format to use which will default the input and output format class names when the table is created.

Parameters:

fileFormat - the predefined file format

getInputFormatClass

public java.lang.String getInputFormatClass()

Gets the input format class for the storage format.

Returns:

the input format class

setInputFormatClass

public void setInputFormatClass(java.lang.String inputFormat)

Sets the input format class for the storage format.

getOutputFormatClass

public java.lang.String getOutputFormatClass()

Gets the output format class for the storage format.

Returns:

the output format class

setOutputFormatClass

public void setOutputFormatClass(java.lang.String outputFormat)

Gets the output format class for the storage format.

getStorageHandlerClass

public java.lang.String getStorageHandlerClass()

Gets the storage handler class. A Table with a storage handler class is non-native and other properties (like delimited, serde, storage format properties) are ignored.

Returns:

the storage handler class

setStorageHandlerClass

public void setStorageHandlerClass(java.lang.String storedBy)

Sets the storage handler class. The storage handler is configured by including SerDe properties.

Parameters:

storedBy - the storage handler class

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Description copied from interface: DBObject

Sets the value for a property. Setting a value to null removes that property.

Specified by:

setProperty in interface DBObject

Overrides:

setProperty in class AbstractDBObject

Parameters:

key - the property key to set

value - the value to set

getProperty

public java.lang.Object getProperty(java.lang.String key)

Description copied from interface: DBObject

Retrieves the value associated with a property. Any key can be used, and this is how the generic DBObject model can be extended (e.g. for database specific properties) but this method will also return the value for bean properties, for example:

obj.getProperty( "name" ) == obj.getName()

Both bean and extended property names are available as constants on the Property class for properties that the db-api supports natively.

Specified by:

getProperty in interface DBObject

Overrides:

getProperty in class AbstractDBObject

Parameters:

key - the property key for which a value is desired. exists.

Returns:

the value of the requested property, or a null value if the property does not exist or is not set.